Материал из Wiki.crossplatform.ru

Внимание: Актуальная версия перевода документации находится здесь

__NOTOC__

[править] QToolButton Class Reference
^{[модуль QtGui ]}

The QToolButton class provides a quick-access button to commands or options, usually used inside a QToolBar. More...

 #include <QToolButton>

Inherits QAbstractButton.

• Список всех членов включая унаследованные
• Поддержка членов Qt 3

[править] Открытые типы

• enum ToolButtonPopupMode { DelayedPopup, MenuButtonPopup, InstantPopup }

[править] Свойства

• arrowType : Qt::ArrowType
• autoRaise : bool
• popupMode : ToolButtonPopupMode
• toolButtonStyle : Qt::ToolButtonStyle

• 11 свойства унаследованных от QAbstractButton
• 56 свойства унаследованных от QWidget
• 1 свойство унаследованное от QObject

[править] Открытые функции

• QToolButton ( QWidget * parent = 0 )
• ~QToolButton ()
• Qt::ArrowType arrowType () const
• bool autoRaise () const
• QAction * defaultAction () const
• QMenu * menu () const
• ToolButtonPopupMode popupMode () const
• void setArrowType ( Qt::ArrowType type )
• void setAutoRaise ( bool enable )
• void setMenu ( QMenu * menu )
• void setPopupMode ( ToolButtonPopupMode mode )
• Qt::ToolButtonStyle toolButtonStyle () const

• 21 открытых функций унаследованных от QAbstractButton
• 201 открытых функций унаследованных от QWidget
• 29 открытых функций унаследованных от QObject
• 12 открытых функций унаследованных от QPaintDevice

[править] Открытые слоты

• void setDefaultAction ( QAction * action )
• void setToolButtonStyle ( Qt::ToolButtonStyle style )
• void showMenu ()

• 5 открытых слотов унаследованных от QAbstractButton
• 19 открытых слотов унаследованных от QWidget
• 1 открытый слот унаследованный от QObject

[править] Сигналы

• void triggered ( QAction * action )

• 4 сигнала унаследованных от QAbstractButton
• 1 сигнал унаследованный от QWidget
• 1 сигнал унаследованный от QObject

[править] Защищенные функции

• void initStyleOption ( QStyleOptionToolButton * option ) const
• virtual void paintEvent ( QPaintEvent * event )

• 3 защищенных функций унаследованных от QAbstractButton
• 38 защищенных функций унаследованных от QWidget
• 7 защищенных функций унаследованных от QObject
• 1 защищенная функция унаследованна от QPaintDevice

[править] Дополнительные унаследованные члены

• 4 статических открытых члена унаследованных от QWidget
• 5 статических открытых члена унаследованных от QObject
• 1 защищенный слот унаследованный от QWidget

[править] Подробное описание

The QToolButton class provides a quick-access button to commands or options, usually used inside a QToolBar.

A tool button is a special button that provides quick-access to specific commands or options. As opposed to a normal command button, a tool button usually doesn't show a text label, but shows an icon instead.

Tool buttons are normally created when new QAction instances are created with QToolBar::addAction() or existing actions are added to a toolbar with QToolBar::addAction(). It is also possible to construct tool buttons in the same way as any other widget, and arrange them alongside other widgets in layouts.

One classic use of a tool button is to select tools; for example, the "pen" tool in a drawing program. This would be implemented by using a QToolButton as a toggle button (see setToggleButton()).

QToolButton supports auto-raising. In auto-raise mode, the button draws a 3D frame only when the mouse points at it. The feature is automatically turned on when a button is used inside a QToolBar. Change it with setAutoRaise().

A tool button's icon is set as QIcon. This makes it possible to specify different pixmaps for the disabled and active state. The disabled pixmap is used when the button's functionality is not available. The active pixmap is displayed when the button is auto-raised because the mouse pointer is hovering over it.

The button's look and dimension is adjustable with setToolButtonStyle() and setIconSize(). When used inside a QToolBar in a QMainWindow, the button automatically adjusts to QMainWindow's settings (see QMainWindow::setToolButtonStyle() and QMainWindow::setIconSize()). Instead of an icon, a tool button can also display an arrow symbol, specified with arrowType.

A tool button can offer additional choices in a popup menu. The popup menu can be set using setMenu(). Use setPopupMode() to configure the different modes available for tool buttons with a menu set. The default mode is DelayedPopupMode which is sometimes used with the "Back" button in a web browser. After pressing and holding the button down for a while, a menu pops up showing a list of possible pages to jump to. The default delay is 600 ms; you can adjust it with setPopupDelay().

Qt Assistant's toolbar contains tool buttons that are associated with actions used in other parts of the main window.

See also QPushButton, QToolBar, QMainWindow, QAction, and GUI Design Handbook: Push Button.

[править] Описание типов членов

[править]

enum QToolButton::ToolButtonPopupMode

Describes how a menu should be popped up for tool buttons that has a menu set or contains a list of actions.

[править] Описание свойств

[править]

arrowType : Qt::ArrowType

This property holds whether the button displays an arrow instead of a normal icon.

This displays an arrow as the icon for the QToolButton.

Функции доступа:

• Qt::ArrowType arrowType () const
• void setArrowType ( Qt::ArrowType type )

[править]

autoRaise : bool

This property holds whether auto-raising is enabled or not.

The default is disabled (i.e. false).

This property is currently ignored on Mac OS X when using QMacStyle.

Функции доступа:

• bool autoRaise () const
• void setAutoRaise ( bool enable )

[править]

popupMode : ToolButtonPopupMode

This property holds describes the way that popup menus are used with tool buttons.

Функции доступа:

• ToolButtonPopupMode popupMode () const
• void setPopupMode ( ToolButtonPopupMode mode )

[править]

toolButtonStyle : Qt::ToolButtonStyle

This property holds whether the tool button displays an icon only, text only, or text beside/below the icon.

The default is Qt::ToolButtonIconOnly.

QToolButton automatically connects this slot to the relevant signal in the QMainWindow in which is resides.

Функции доступа:

• Qt::ToolButtonStyle toolButtonStyle () const
• void setToolButtonStyle ( Qt::ToolButtonStyle style )

[править] Описание функций-членов

[править]

QToolButton::QToolButton ( QWidget * parent = 0 )

Constructs an empty tool button with parent parent.

[править]

QToolButton::~QToolButton ()

Destroys the object and frees any allocated resources.

[править]

QAction * QToolButton::defaultAction () const

Returns the default action.

See also setDefaultAction().

[править]

void QToolButton::initStyleOption ( QStyleOptionToolButton * option ) const [protected]

Initialize option with the values from this QToolButton. This method is useful for subclasses when they need a QStyleOptionToolButton, but don't want to fill in all the information themselves.

See also QStyleOption::initFrom().

[править]

QMenu * QToolButton::menu () const

Returns the associated menu, or 0 if no menu has been defined.

See also setMenu().

[править]

void QToolButton::paintEvent ( QPaintEvent * event ) [virtual protected]

Paints the button in response to the paint event.

Reimplemented from QWidget.

[править]

void QToolButton::setDefaultAction ( QAction * action ) [slot]

Sets the default action to action.

If a tool button has a default action, the action defines the button's properties like text, icon, tool tip, etc.

See also defaultAction().

[править]

void QToolButton::setMenu ( QMenu * menu )

Associates the given menu with this tool button.

The menu will be shown according to the button's popupMode.

Ownership of the menu is not transferred to the tool button.

See also menu().

[править]

void QToolButton::showMenu () [slot]

Shows (pops up) the associated popup menu. If there is no such menu, this function does nothing. This function does not return until the popup menu has been closed by the user.

[править]

void QToolButton::triggered ( QAction * action ) [signal]

This signal is emitted when the given action is triggered.

The action may also be associated with other parts of the user interface, such as menu items and keyboard shortcuts. Sharing actions in this way helps make the user interface more consistent and is often less work to implement.