KDEUI
KToolBarPopupAction Class Reference
This action is a normal action everywhere, except in a toolbar where it also has a popupmenu (optionally delayed). More...
#include <ktoolbarpopupaction.h>

Public Member Functions | |
virtual QWidget * | createWidget (QWidget *parent) |
bool | delayed () const |
KToolBarPopupAction (const KIcon &icon, const QString &text, QObject *parent) | |
KDE_DEPRECATED KMenu * | popupMenu () const |
void | setDelayed (bool delayed) |
void | setStickyMenu (bool sticky) |
bool | stickyMenu () const |
virtual | ~KToolBarPopupAction () |
Properties | |
bool | delayed |
bool | stickyMenu |
Detailed Description
This action is a normal action everywhere, except in a toolbar where it also has a popupmenu (optionally delayed).
This action is designed for history actions (back/forward, undo/redo) and for any other action that has more detail in a toolbar than in a menu (e.g. tool chooser with "Other" leading to a dialog...).
In contrast to KActionMenu, this action is a simple menuitem when plugged into a menu, and has a popup only in a toolbar.
Use cases include Back/Forward, and Undo/Redo. Simple click is what's most commonly used, and enough for menus, but in toolbars there is also an optional popup to go back N steps or undo N steps.
Definition at line 48 of file ktoolbarpopupaction.h.
Constructor & Destructor Documentation
KToolBarPopupAction::KToolBarPopupAction | ( | const KIcon & | icon, | |
const QString & | text, | |||
QObject * | parent | |||
) |
Create a KToolBarPopupAction, with a text, an icon, a parent and a name.
- Parameters:
-
icon The icon to display. text The text that will be displayed. parent This action's parent.
Definition at line 50 of file ktoolbarpopupaction.cpp.
KToolBarPopupAction::~KToolBarPopupAction | ( | ) | [virtual] |
Destroys the toolbar popup action.
Definition at line 57 of file ktoolbarpopupaction.cpp.
Member Function Documentation
Reimplemented from.
- See also:
- QActionWidgetFactory.
Definition at line 68 of file ktoolbarpopupaction.cpp.
bool KToolBarPopupAction::delayed | ( | ) | const |
Returns true if this action creates a delayed popup menu when plugged in a KToolBar.
KMenu * KToolBarPopupAction::popupMenu | ( | ) | const |
The popup menu that is shown when clicking (some time) on the toolbar button.
You may want to plug items into it on creation, or connect to aboutToShow for a more dynamic menu.
- Deprecated:
- use menu() instead
Definition at line 63 of file ktoolbarpopupaction.cpp.
void KToolBarPopupAction::setDelayed | ( | bool | delayed | ) |
If set to true, this action will create a delayed popup menu when plugged in a KToolBar.
Otherwise it creates a normal popup. Default: delayed.
Definition at line 103 of file ktoolbarpopupaction.cpp.
void KToolBarPopupAction::setStickyMenu | ( | bool | sticky | ) |
If set to true, this action will create a sticky popup menu when plugged in a KToolBar.
"Sticky", means it's visible until a selection is made or the mouse is clicked elsewhere. This feature allows you to make a selection without having to press and hold down the mouse while making a selection. Only available if delayed() is true. Default: sticky.
Definition at line 113 of file ktoolbarpopupaction.cpp.
bool KToolBarPopupAction::stickyMenu | ( | ) | const |
Returns true if this action creates a sticky popup menu.
- See also:
- setStickyMenu().
Property Documentation
bool KToolBarPopupAction::delayed [read, write] |
Definition at line 51 of file ktoolbarpopupaction.h.
bool KToolBarPopupAction::stickyMenu [read, write] |
Definition at line 52 of file ktoolbarpopupaction.h.
The documentation for this class was generated from the following files: