Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# QToolBar Class Reference

The QToolBar class provides a movable panel that contains a set of controls. More...

    #include <QToolBar>

Inherits QFrame.

- List of all members, including inherited members
- Obsolete members
- Compatibility members

### Writable Properties

- allowedAreas : Qt::ToolBarAreas
- area : Qt::ToolBarArea
- movable : bool

- 5 writable properties inherited from QFrame
- 33 writable properties inherited from QWidget
- 1 writable property inherited from QObject

### Read-Only Properties

- 1 read-only property inherited from QFrame
- 24 read-only properties inherited from QWidget

### Public Functions

- QToolBar ( QMainWindow * parent )
- ~QToolBar ()
- QAction * actionAt ( int x, int y ) const
- QAction * actionAt ( const QPoint & p ) const
- void addAction ( QAction * action )
- QAction * addAction ( const QString & text )
- QAction * addAction ( const QIcon & icon, const QString & text )
- QAction * addAction ( const QString & text, const QObject * receiver, const char * member )
- QAction * addAction ( const QIcon & icon, const QString & text, const QObject * receiver, const char * member )
- QAction * addSeparator ()
- QAction * addWidget ( QWidget * widget )
- void clear ()
- void insertAction ( QAction * before, QAction * action )
- QAction * insertAction ( QAction * before, const QString & text )
- QAction * insertAction ( QAction * before, const QIcon & icon, const QString & text )
- QAction * insertAction ( QAction * before, const QString & text, const QObject * receiver, const char * member )
- QAction * insertAction ( QAction * before, const QIcon & icon, const QString & text, const QObject * receiver, const char * member )
- QAction * insertSeparator ( QAction * before )
- QAction * insertWidget ( QAction * before, QWidget * widget )
- bool isDockable ( Qt::ToolBarArea area )
- QMainWindow * mainWindow () const
- void setParent ( QMainWindow * parent )

- 2 public functions inherited from QFrame
- 83 public functions inherited from QWidget
- 24 public functions inherited from QObject
- 2 public functions inherited from QPaintDevice

### Public Slots

- 16 public slots inherited from QWidget
- 1 public slot inherited from QObject

### Signals

- void actionTriggered ( QAction * action )

- 1 signal inherited from QObject

### Static Public Members

- 4 static public members inherited from QWidget
- 4 static public members inherited from QObject

### Protected Functions

- 44 protected functions inherited from QWidget
- 9 protected functions inherited from QObject

## Detailed Description

The QToolBar class provides a movable panel that contains a set of controls.

Toolbar buttons are added by adding actions, using addAction() or insertAction(). Groups of buttons can be separated using addSeparator() or insertSeparator(). If a toolbar button is not appropriate, a widget can be inserted instead using addWidget() or insertWidget(); examples of suitable widgets are QSpinBox, QDoubleSpinBox, and QComboBox. When a toolbar button is pressed it emits the actionTriggered() signal. Toolbars may only be added to QMainWindow and QMainWindow subclasses.

A toolbar can be fixed in place in a particular area() (e.g. at the top of the window), or it can be movable() between toolbar areas, or it can be floatable: see allowedAreas and isDockable().

## Property Documentation

### allowedAreas : Qt::ToolBarAreas

This property holds areas where the tool bar may be placed.

The default is `Qt::AllToolBarAreas`.

Access functions:

- Qt::ToolBarAreas allowedAreas () const
- void setAllowedAreas ( Qt::ToolBarAreas areas )

### area : Qt::ToolBarArea

This property holds area where the tool bar is currently placed.

The default is `Qt::ToolBarAreaTop`.

Access functions:

- Qt::ToolBarArea area () const
- void setArea ( Qt::ToolBarArea area, bool linebreak = false )

### movable : bool

This property holds whether the user can move the tool bar either within the tool bar area or to another tool bar area.

This property is true by default.

Access functions:

- bool isMovable () const
- void setMovable ( bool movable = true )

See also QToolBar::allowedAreas.

## Member Function Documentation

### QToolBar::QToolBar ( QMainWindow * parent )

Constructs a QToolBar with the given parent.

### QToolBar::~QToolBar ()

Destroys the tool bar.

### QAction * QToolBar::actionAt ( int x, int y ) const

Returns the action at the point x, y. This function returns zero if no action was found.

See also QWidget::childAt().

### QAction * QToolBar::actionAt ( const QPoint & p ) const

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Returns the action at point p.

### void QToolBar::actionTriggered ( QAction * action ) `[signal]`

This signal is emitted when a tool bar button is pressed. The parameter holds the tool bar button's associated action.

### void QToolBar::addAction ( QAction * action )

Adds action to the end of the tool bar.

See also addAction().

### QAction * QToolBar::addAction ( const QString & text )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Creates a new action with text text. This action is added to the end of the tool bar.

### QAction * QToolBar::addAction ( const QIcon & icon, const QString & text )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Creates a new action with the icon icon and text text. This action is added to the end of the tool bar.

### QAction * QToolBar::addAction ( const QString & text, const QObject * receiver, const char * member )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Creates a new action with text text. This action is added to the end of the tool bar. The action's triggered() signal is connected to member in receiver.

### QAction * QToolBar::addAction ( const QIcon & icon, const QString & text, const QObject * receiver, const char * member )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Creates a new action with the icon icon and text text. This action is added to the end of the tool bar. The action's triggered() signal is connected to member in receiver.

### QAction * QToolBar::addSeparator ()

Adds a separator to the end of the toolbar.

See also insertSeparator().

### QAction * QToolBar::addWidget ( QWidget * widget )

Adds the given widget to the tool bar as the tool bar's last item.

See also insertWidget().

### void QToolBar::clear ()

Removes all actions from the tool bar.

See also removeAction().

### void QToolBar::insertAction ( QAction * before, QAction * action )

Inserts the given action into the tool bar in front of the tool bar item associated with the before action.

See also addAction().

### QAction * QToolBar::insertAction ( QAction * before, const QString & text )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Creates a new action with the given text. This action is inserted into the tool bar in front of the tool bar item associated with the before action.

### QAction * QToolBar::insertAction ( QAction * before, const QIcon & icon, const QString & text )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Creates a new action with the given icon and text. This action is inserted into the tool bar in front of the tool bar item associated with the before action.

### QAction * QToolBar::insertAction ( QAction * before, const QString & text, const QObject * receiver, const char * member )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Creates a new action with the given text. This action is inserted into the tool bar in front of the tool bar item associated with the before action. The action's triggered() signal is connected to the member in receiver.

### QAction * QToolBar::insertAction ( QAction * before, const QIcon & icon, const QString & text, const QObject * receiver, const char * member )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Creates a new action with the given icon and text. This action is inserted into the tool bar in front of the tool bar item associated with the before action. The action's triggered() signal is connected to the member in the receiver.

### QAction * QToolBar::insertSeparator ( QAction * before )

Inserts a separator into the tool bar in front of the tool bar item associated with the before action.

See also addSeparator().

### QAction * QToolBar::insertWidget ( QAction * before, QWidget * widget )

Inserts the given widget in front of the tool bar item associated with the before action.

See also addWidget().

### bool QToolBar::isDockable ( Qt::ToolBarArea area )

Returns true if this tool bar is dockable in the given area; otherwise returns false.

### QMainWindow * QToolBar::mainWindow () const

Returns the main window for the tool bar.

See also setParent().

### void QToolBar::setParent ( QMainWindow * parent )

Sets the main window for the tool bar to parent.

See also mainWindow().