KToolBarPopupAction Class Reference

This action is a normal action everywhere, except in a toolbar where it also has a popupmenu (optionnally delayed). More...

#include <kactionclasses.h>

Inheritance diagram for KToolBarPopupAction:

[legend]

List of all members.

Public Member Functions
bool	delayed () const
	KToolBarPopupAction (const KGuiItem &item, const KShortcut &cut, const QObject *receiver, const char *slot, KActionCollection *parent, const char *name)
	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 QString &text, const QString &icon, const KShortcut &cut=KShortcut(), QObject *parent=0, const char *name=0)
virtual int	plug (QWidget *widget, int index=-1)
KPopupMenu *	popupMenu () const
void	setDelayed (bool delayed)
void	setStickyMenu (bool sticky)
bool	stickyMenu () const
virtual	~KToolBarPopupAction ()
Protected Member Functions
virtual void	virtual_hook (int id, void *data)
Properties
bool	delayed
bool	stickyMenu

---

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 1086 of file kactionclasses.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 optional 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.

Definition at line 1862 of file kactionclasses.cpp.

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.

Definition at line 1873 of file kactionclasses.cpp.

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.

Definition at line 1886 of file kactionclasses.cpp.

KToolBarPopupAction::~KToolBarPopupAction

(

)

[virtual]

Definition at line 1898 of file kactionclasses.cpp.

---

Member Function Documentation

bool KToolBarPopupAction::delayed

(

)

const

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

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:

	widget	The GUI element to display this action
	index	The position into which the action is plugged. If this is negative, the action is inserted at the end.

Reimplemented from KAction.

Definition at line 1919 of file kactionclasses.cpp.

KPopupMenu * 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.

Definition at line 1968 of file kactionclasses.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 1907 of file kactionclasses.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 1915 of file kactionclasses.cpp.

bool KToolBarPopupAction::stickyMenu

(

)

const

Returns true if this action creates a sticky popup menu.

See setStickyMenu().

void KToolBarPopupAction::virtual_hook	(	int	id,
		void *	data
	)			[protected, virtual]

Reimplemented from KAction.

Definition at line 2380 of file kactionclasses.cpp.

---

Property Documentation

bool KToolBarPopupAction::delayed [read, write]

Definition at line 1089 of file kactionclasses.h.

bool KToolBarPopupAction::stickyMenu [read, write]

Definition at line 1090 of file kactionclasses.h.

---

The documentation for this class was generated from the following files:

• kactionclasses.h
• kactionclasses.cpp