KToolBarPopupAction Class Reference

#include <ktoolbarpopupaction.h>

Inheritance diagram for KToolBarPopupAction:

Public Member Functions
	KToolBarPopupAction (const KIcon &icon, const QString &text, QObject *parent)
virtual	~KToolBarPopupAction ()
virtual QWidget *	createWidget (QWidget *parent)
bool	delayed () const
KMenu *	popupMenu () const
void	setDelayed (bool delayed)
void	setStickyMenu (bool sticky)
bool	stickyMenu () const
Public Member Functions inherited from KAction
	KAction (const KIcon &icon, const QString &text, QObject *parent)
	KAction (const QString &text, QObject *parent)
	KAction (QObject *parent)
virtual	~KAction ()
KAuth::Action *	authAction () const
bool	event (QEvent *)
void	forgetGlobalShortcut ()
const KShortcut &	globalShortcut (ShortcutTypes type=ActiveShortcut) const
bool	globalShortcutAllowed () const
bool	isGlobalShortcutEnabled () const
bool	isShortcutConfigurable () const
KRockerGesture	rockerGesture (ShortcutTypes type=ActiveShortcut) const
void	setAuthAction (const QString &actionName)
void	setAuthAction (KAuth::Action *action)
void	setGlobalShortcut (const KShortcut &shortcut, ShortcutTypes type=ShortcutTypes(ActiveShortcut|DefaultShortcut), GlobalShortcutLoading loading=Autoloading)
void	setGlobalShortcutAllowed (bool allowed, GlobalShortcutLoading loading=Autoloading)
void	setHelpText (const QString &text)
void	setRockerGesture (const KRockerGesture &gest, ShortcutTypes type=ShortcutTypes(ActiveShortcut|DefaultShortcut))
void	setShapeGesture (const KShapeGesture &gest, ShortcutTypes type=ShortcutTypes(ActiveShortcut|DefaultShortcut))
void	setShortcut (const KShortcut &shortcut, ShortcutTypes type=ShortcutTypes(ActiveShortcut|DefaultShortcut))
void	setShortcut (const QKeySequence &shortcut, ShortcutTypes type=ShortcutTypes(ActiveShortcut|DefaultShortcut))
void	setShortcutConfigurable (bool configurable)
void	setShortcuts (const QList< QKeySequence > &shortcuts, ShortcutTypes type=ShortcutTypes(ActiveShortcut|DefaultShortcut))
KShapeGesture	shapeGesture (ShortcutTypes type=ActiveShortcut) const
KShortcut	shortcut (ShortcutTypes types=ActiveShortcut) const

Properties
bool	delayed
bool	stickyMenu
Properties inherited from KAction
KShortcut	globalShortcut
bool	globalShortcutAllowed
bool	globalShortcutEnabled
KShortcut	shortcut
bool	shortcutConfigurable

Additional Inherited Members
Public Types inherited from KAction
enum	GlobalShortcutLoading { Autoloading = 0x0 , NoAutoloading = 0x4 }
enum	ShortcutType { ActiveShortcut = 0x1 , DefaultShortcut = 0x2 }
Signals inherited from KAction
void	authorized (KAuth::Action *action)
void	globalShortcutChanged (const QKeySequence &)
void	triggered (Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers)

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::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::~KToolBarPopupAction ( )

virtual

Destroys the toolbar popup action.

Definition at line 57 of file ktoolbarpopupaction.cpp.

Member Function Documentation

createWidget()

QWidget * KToolBarPopupAction::createWidget ( QWidget * parent )

virtual

Reimplemented from.

See also

QActionWidgetFactory.

Definition at line 70 of file ktoolbarpopupaction.cpp.

delayed()

bool KToolBarPopupAction::delayed

(

)

const

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

Definition at line 100 of file ktoolbarpopupaction.cpp.

popupMenu()

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 64 of file ktoolbarpopupaction.cpp.

setDelayed()

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 105 of file ktoolbarpopupaction.cpp.

setStickyMenu()

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 115 of file ktoolbarpopupaction.cpp.

stickyMenu()

bool KToolBarPopupAction::stickyMenu

(

)

const

Returns true if this action creates a sticky popup menu.

See also

setStickyMenu().

Definition at line 110 of file ktoolbarpopupaction.cpp.

Property Documentation

delayed

bool KToolBarPopupAction::delayed

readwrite

Definition at line 51 of file ktoolbarpopupaction.h.

stickyMenu

bool KToolBarPopupAction::stickyMenu

readwrite

Definition at line 52 of file ktoolbarpopupaction.h.

---

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

• ktoolbarpopupaction.h
• ktoolbarpopupaction.cpp