.TH "KToolBarPopupAction" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KToolBarPopupAction \- This action is a normal action everywhere, except in a toolbar where it also has a popupmenu (optionnally delayed).  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kactionclasses.h>\fP
.PP
Inherits \fBKAction\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKToolBarPopupAction\fP (const \fBQString\fP &text, const \fBQString\fP &icon, const \fBKShortcut\fP &cut=\fBKShortcut\fP(), \fBQObject\fP *\fBparent\fP=0, const char *\fBname\fP=0)"
.br
.ti -1c
.RI "\fBKToolBarPopupAction\fP (const \fBQString\fP &text, const \fBQString\fP &icon, const \fBKShortcut\fP &cut, const \fBQObject\fP *receiver, const char *slot, \fBQObject\fP *\fBparent\fP=0, const char *\fBname\fP=0)"
.br
.ti -1c
.RI "\fBKToolBarPopupAction\fP (const \fBKGuiItem\fP &item, const \fBKShortcut\fP &cut, const \fBQObject\fP *receiver, const char *slot, \fBKActionCollection\fP *\fBparent\fP, const char *\fBname\fP)"
.br
.ti -1c
.RI "virtual int \fBplug\fP (\fBQWidget\fP *widget, int index=-1)"
.br
.ti -1c
.RI "\fBKPopupMenu\fP * \fBpopupMenu\fP () const "
.br
.ti -1c
.RI "bool \fBdelayed\fP () const "
.br
.ti -1c
.RI "void \fBsetDelayed\fP (bool delayed)"
.br
.ti -1c
.RI "bool \fBstickyMenu\fP () const "
.br
.ti -1c
.RI "void \fBsetStickyMenu\fP (bool sticky)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SS "Properties"

.in +1c
.ti -1c
.RI "bool \fBdelayed\fP"
.br
.ti -1c
.RI "bool \fBstickyMenu\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
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...). 
.PP
Definition at line 1050 of file kactionclasses.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KToolBarPopupAction::KToolBarPopupAction (const \fBQString\fP & text, const \fBQString\fP & icon, const \fBKShortcut\fP & cut = \fC\fBKShortcut\fP()\fP, \fBQObject\fP * parent = \fC0\fP, const char * name = \fC0\fP)"
.PP
Create a KToolBarPopupAction, with a text, an icon, an optional accelerator, parent and name. 
.PP
\fBParameters:\fP
.RS 4
\fItext\fP The text that will be displayed. 
.br
\fIicon\fP The icon to display. 
.br
\fIcut\fP The corresponding keyboard accelerator (shortcut). 
.br
\fIparent\fP This action's parent. 
.br
\fIname\fP An internal name for this action. 
.RE
.PP

.PP
Definition at line 1765 of file kactionclasses.cpp.
.SS "KToolBarPopupAction::KToolBarPopupAction (const \fBQString\fP & text, const \fBQString\fP & icon, const \fBKShortcut\fP & cut, const \fBQObject\fP * receiver, const char * slot, \fBQObject\fP * parent = \fC0\fP, const char * name = \fC0\fP)"
.PP
Create a KToolBarPopupAction, with a text, an icon, an accelerator, a slot connected to the action, parent and name. 
.PP
If you do not want or have a keyboard accelerator, set the \fCcut\fP param to 0.
.PP
\fBParameters:\fP
.RS 4
\fItext\fP The text that will be displayed. 
.br
\fIicon\fP The icon to display. 
.br
\fIcut\fP The corresponding keyboard accelerator (shortcut). 
.br
\fIreceiver\fP The SLOT's owner. 
.br
\fIslot\fP The SLOT to invoke to execute this action. 
.br
\fIparent\fP This action's parent. 
.br
\fIname\fP An internal name for this action. 
.RE
.PP

.PP
Definition at line 1776 of file kactionclasses.cpp.
.SS "KToolBarPopupAction::KToolBarPopupAction (const \fBKGuiItem\fP & item, const \fBKShortcut\fP & cut, const \fBQObject\fP * receiver, const char * slot, \fBKActionCollection\fP * parent, const char * name)"
.PP
Create a KToolBarPopupAction, with a \fBKGuiItem\fP, an accelerator, a slot connected to the action, parent and name. 
.PP
The text and the icon are taken from the \fBKGuiItem\fP.
.PP
If you do not want or have a keyboard accelerator, set the \fCcut\fP param to 0.
.PP
\fBParameters:\fP
.RS 4
\fIitem\fP The text and icon that will be displayed. 
.br
\fIcut\fP The corresponding keyboard accelerator (shortcut). 
.br
\fIreceiver\fP The SLOT's owner. 
.br
\fIslot\fP The SLOT to invoke to execute this action. 
.br
\fIparent\fP This action's parent. 
.br
\fIname\fP An internal name for this action. 
.RE
.PP

.PP
Definition at line 1789 of file kactionclasses.cpp.
.SH "Member Function Documentation"
.PP 
.SS "int KToolBarPopupAction::plug (\fBQWidget\fP * widget, int index = \fC-1\fP)\fC [virtual]\fP"
.PP
'Plug' or insert this action into a given widget. 
.PP
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 \fBKAction\fP object.
.PP
\fBParameters:\fP
.RS 4
\fIwidget\fP The GUI element to display this action 
.br
\fIindex\fP The position into which the action is plugged. If this is negative, the action is inserted at the end. 
.RE
.PP

.PP
Reimplemented from \fBKAction\fP.
.PP
Definition at line 1822 of file kactionclasses.cpp.
.PP
References QWhatsThis::add(), QObject::connect(), delayed(), QObject::destroyed(), KToolBar::getButton(), KAction::getToolButtonID(), KAction::iconSet(), KToolBar::insertButton(), KGlobal::instance(), KActionCollection::instance(), KAction::isEnabled(), KAction::plug(), popupMenu(), KToolBar::setDelayedPopup(), KToolBarButton::setPopup(), KAction::slotButtonClicked(), stickyMenu(), and KAction::whatsThis().
.SS "\fBKPopupMenu\fP * KToolBarPopupAction::popupMenu () const"
.PP
The popup menu that is shown when clicking (some time) on the toolbar button. 
.PP
You may want to plug items into it on creation, or connect to aboutToShow for a more dynamic menu. 
.PP
Definition at line 1871 of file kactionclasses.cpp.
.PP
References m_popup.
.PP
Referenced by plug().
.SS "bool KToolBarPopupAction::delayed () const"
.PP
Returns true if this action creates a delayed popup menu when plugged in a KToolbar. 
.PP
Referenced by plug().
.SS "void KToolBarPopupAction::setDelayed (bool delayed)"
.PP
If set to true, this action will create a delayed popup menu when plugged in a KToolbar. 
.PP
Otherwise it creates a normal popup. Default: delayed. 
.PP
Definition at line 1810 of file kactionclasses.cpp.
.SS "bool KToolBarPopupAction::stickyMenu () const"
.PP
Returns true if this action creates a sticky popup menu. 
.PP
See setStickyMenu. 
.PP
Referenced by plug().
.SS "void KToolBarPopupAction::setStickyMenu (bool sticky)"
.PP
If set to true, this action will create a sticky popup menu when plugged in a KToolbar. 
.PP
'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 \fBdelayed()\fP is true. Default: sticky. 
.PP
Definition at line 1818 of file kactionclasses.cpp.

.SH "Author"
.PP 
Generated automatically by Doxygen for kdeui Library from the source code.
