Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KToolBarPopupAction Class Reference

#include <kaction.h>

Inheritance diagram for KToolBarPopupAction:

KAction List of all members.

Public Methods

 KToolBarPopupAction (const QString &text, const QString &icon, const KShortcut &cut=KShortcut(), QObject *parent=0, const char *name=0)
 KToolBarPopupAction (const QString &text, const QString &icon, const KShortcut &cut, const QObject *receiver, const char *slot, QObject *parent=0, const char *name=0)
 KToolBarPopupAction (const KGuiItem &item, const KShortcut &cut, const QObject *receiver, const char *slot, KActionCollection *parent, const char *name)
virtual int plug (QWidget *widget, int index=-1)
KPopupMenu * popupMenu () const
bool delayed () const
void setDelayed (bool delayed)
bool stickyMenu () const
void setStickyMenu (bool sticky)

Protected Methods

virtual void virtual_hook (int id, void *data)

Detailed Description

This action is a normal action everywhere, except in a toolbar where it also has a popupmenu (optionnally 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...).

Definition at line 1537 of file kaction.h.

Constructor & Destructor Documentation

KToolBarPopupAction::KToolBarPopupAction (  const QString &    text,
const QString &    icon,
const KShortcut &    cut = KShortcut(),
QObject *    parent = 0,
const char *    name = 0
) 
 

Create a KToolBarPopupAction, with a text, an icon, an optionnal accelerator, parent and name.

Parameters:
text  The text that will be displayed.
icon  The icon to display.
cut  The corresponding keyboard accelerator (shortcut).
parent  This action's parent.
name  An internal name for this action.

KToolBarPopupAction::KToolBarPopupAction (  const QString &    text,
const QString &    icon,
const KShortcut &    cut,
const QObject *    receiver,
const char *    slot,
QObject *    parent = 0,
const char *    name = 0
) 
 

Create a KToolBarPopupAction, with a text, an icon, an accelerator, a slot connected to the action, parent and name.

If you do not want or have a keyboard accelerator, set the cut param to 0.

Parameters:
text  The text that will be displayed.
icon  The icon to display.
cut  The corresponding keyboard accelerator (shortcut).
receiver  The SLOT's owner.
slot  The SLOT to invoke to execute this action.
parent  This action's parent.
name  An internal name for this action.

KToolBarPopupAction::KToolBarPopupAction (  const KGuiItem &    item,
const KShortcut &    cut,
const QObject *    receiver,
const char *    slot,
KActionCollection *    parent,
const char *    name
) 
 

Create a KToolBarPopupAction, with a KGuiItem, an accelerator, a slot connected to the action, parent and name. The text and the icon are taken from the KGuiItem.

If you do not want or have a keyboard accelerator, set the cut param to 0.

Parameters:
item  The text and icon that will be displayed.
cut  The corresponding keyboard accelerator (shortcut).
receiver  The SLOT's owner.
slot  The SLOT to invoke to execute this action.
parent  This action's parent.
name  An internal name for this action.

Member Function Documentation

bool KToolBarPopupAction::delayed (    ) 
 

Returns true if this action creates a delayed popup menu when plugged in a KToolbar.

virtual int KToolBarPopupAction::plug (  QWidget *    widget,
int    index = -1
)  [virtual]
 

"Plug" or insert this action into a given widget.

This will typically be a menu or a toolbar. From this point on, you will never need to directly manipulate the item in the menu or toolbar. You do all enabling/disabling/manipulation directly with your KAction object.

Parameters:
w  The GUI element to display this action

Reimplemented from KAction.

KPopupMenu* KToolBarPopupAction::popupMenu (    ) 
 

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.

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.

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.

bool KToolBarPopupAction::stickyMenu (    ) 
 

Returns true if this action creates a sticky popup menu. See setStickyMenu.

The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:27 2003 for kdelibs by doxygen1.2.18