#include <kdualaction.h>

Inheritance diagram for KDualAction:

Public Slots
void	setActive (bool state)

Signals
void	activeChanged (bool)

void	activeChangedByUser (bool)

Signals inherited from KAction
void	authorized (KAuth::Action *action)

void	globalShortcutChanged (const QKeySequence &)

void	triggered (Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers)

Public Member Functions
	KDualAction (QObject *parent)

	KDualAction (const QString &inactiveText, const QString &activeText, QObject *parent)

	~KDualAction ()

KGuiItem	activeGuiItem () const

QIcon	activeIcon () const

QString	activeText () const

QString	activeToolTip () const

bool	autoToggle () const

KGuiItem	inactiveGuiItem () const

QIcon	inactiveIcon () const

QString	inactiveText () const

QString	inactiveToolTip () const

bool	isActive () const

void	setActiveGuiItem (const KGuiItem &)

void	setActiveIcon (const QIcon &)

void	setActiveText (const QString &)

void	setActiveToolTip (const QString &)

void	setAutoToggle (bool)

void	setIconForStates (const QIcon &icon)

void	setInactiveGuiItem (const KGuiItem &)

void	setInactiveIcon (const QIcon &)

void	setInactiveText (const QString &)

void	setInactiveToolTip (const QString &)

Public Member Functions inherited from KAction
	KAction (QObject *parent)

	KAction (const QString &text, QObject *parent)

	KAction (const KIcon &icon, const QString &text, 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 (KAuth::Action *action)

void	setAuthAction (const QString &actionName)

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

Public Member Functions inherited from QAction
	QAction (QObject *parent)

	QAction (const QString &text, QObject *parent)

	QAction (QObject parent, const char name)

	QAction (const QString &text, const QKeySequence &shortcut, QObject parent, const char name)

	QAction (const QIcon &icon, const QString &text, QObject *parent)

	QAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, QObject parent, const char name)

	~QAction ()

QKeySequence	accel () const

QActionGroup *	actionGroup () const

void	activate (ActionEvent event)

void	activated (int i)

bool	addTo (QWidget *w)

QList< QGraphicsWidget * >	associatedGraphicsWidgets () const

QList< QWidget * >	associatedWidgets () const

bool	autoRepeat () const

void	changed ()

QVariant	data () const

QFont	font () const

void	hover ()

void	hovered ()

QIcon	icon () const

QIcon	iconSet () const

QString	iconText () const

bool	isCheckable () const

bool	isChecked () const

bool	isEnabled () const

bool	isIconVisibleInMenu () const

bool	isOn () const

bool	isSeparator () const

bool	isToggleAction () const

bool	isVisible () const

QMenu *	menu () const

MenuRole	menuRole () const

QString	menuText () const

QWidget *	parentWidget () const

Priority	priority () const

bool	removeFrom (QWidget *w)

void	setAccel (const QKeySequence &shortcut)

void	setActionGroup (QActionGroup *group)

void	setAutoRepeat (bool)

void	setCheckable (bool)

void	setChecked (bool)

void	setData (const QVariant &userData)

void	setDisabled (bool b)

void	setEnabled (bool)

void	setFont (const QFont &font)

void	setIcon (const QIcon &icon)

void	setIconSet (const QIcon &i)

void	setIconText (const QString &text)

void	setIconVisibleInMenu (bool visible)

void	setMenu (QMenu *menu)

void	setMenuRole (MenuRole menuRole)

void	setMenuText (const QString &text)

void	setOn (bool b)

void	setPriority (Priority priority)

void	setSeparator (bool b)

void	setShortcut (const QKeySequence &shortcut)

void	setShortcutContext (Qt::ShortcutContext context)

void	setShortcuts (QKeySequence::StandardKey key)

void	setShortcuts (const QList< QKeySequence > &shortcuts)

void	setSoftKeyRole (SoftKeyRole softKeyRole)

void	setStatusTip (const QString &statusTip)

void	setText (const QString &text)

void	setToggleAction (bool b)

void	setToolTip (const QString &tip)

void	setVisible (bool)

void	setWhatsThis (const QString &what)

QKeySequence	shortcut () const

Qt::ShortcutContext	shortcutContext () const

QList< QKeySequence >	shortcuts () const

bool	showStatusText (QWidget *widget)

SoftKeyRole	softKeyRole () const

QString	statusTip () const

QString	text () const

void	toggle ()

void	toggled (bool checked)

QString	toolTip () const

void	trigger ()

void	triggered (bool checked)

QString	whatsThis () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Public Member Functions inherited from QWidgetAction
	QWidgetAction (QObject *parent)

virtual	~QWidgetAction ()

QWidget *	defaultWidget () const

void	releaseWidget (QWidget *widget)

QWidget *	requestWidget (QWidget *parent)

void	setDefaultWidget (QWidget *widget)

Additional Inherited Members
Public Types inherited from KAction
enum	GlobalShortcutLoading { Autoloading = 0x0, NoAutoloading = 0x4 }

enum	ShortcutType { ActiveShortcut = 0x1, DefaultShortcut = 0x2 }

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Protected Member Functions inherited from QWidgetAction
QList< QWidget * >	createdWidgets () const

virtual QWidget *	createWidget (QWidget *parent)

virtual void	deleteWidget (QWidget *widget)

virtual bool	eventFilter (QObject obj, QEvent event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from KAction
KShortcut	globalShortcut

bool	globalShortcutAllowed

bool	globalShortcutEnabled

KShortcut	shortcut

bool	shortcutConfigurable

Properties inherited from QAction
	autoRepeat

	checkable

	checked

	enabled

	font

	icon

	iconText

	iconVisibleInMenu

	menuRole

	priority

	shortcut

	shortcutContext

	softKeyRole

	statusTip

	text

	toolTip

	visible

	whatsThis

Properties inherited from QObject
	objectName

Detailed Description

An action which can alternate between two texts/icons when triggered.

KDualAction should be used when you want to create an action which alternate between two states when triggered but which should not be rendered as a checkable widget because it is more appropriate to change the text and icon of the action instead.

You should use KDualAction to implement this kind of actions instead of KToggleAction because KToggleAction is rendered as a checkable widget: this means one of your state will have a checkbox in a menu and will be represented as a sunken button in a toolbar.

Porting from KToggleAction to KDualAction:

If you used the KToggleAction constructor which accepts the action text, adjust the constructor: KDualAction constructor accepts both inactive and active text.
Replace connections to the checked(bool) signal with a connection to the activeChanged(bool) (or activeChangedByUser(bool))
Replace calls to setChecked()/isChecked() with setActive()/isActive()
Replace calls to setCheckedState(guiItem) with setActiveGuiItem(guiItem)

Author: Aurélien Gâteau agate.nosp@m.au@k.nosp@m.de.or.nosp@m.g

Since: 4.6

Definition at line 58 of file kdualaction.h.

Constructor & Destructor Documentation

KDualAction::KDualAction ( QObject * parent )

explicit

Constructs a KDualAction with the specified parent.

Texts must be set with setTextForState() or setGuiItemForState().

Definition at line 71 of file kdualaction.cpp.

KDualAction::KDualAction	(	const QString &	inactiveText,
		const QString &	activeText,
		QObject *	parent
	)

Constructs a KDualAction with the specified parent and texts.

Definition at line 61 of file kdualaction.cpp.

KDualAction::~KDualAction ( )

Definition at line 78 of file kdualaction.cpp.

Member Function Documentation

void KDualAction::activeChanged ( bool )

signal

Emitted when the state changes.

This signal is emitted when the user trigger the action and when setActive() is called.

void KDualAction::activeChangedByUser ( bool )

signal

Only emitted when the state changes because the user triggered the action.

KGuiItem KDualAction::activeGuiItem ( ) const

Gets the KGuiItem for the active state.

Definition at line 84 of file kdualaction.cpp.

QIcon KDualAction::activeIcon ( ) const

Gets the icon for the active state.

Definition at line 89 of file kdualaction.cpp.

QString KDualAction::activeText ( ) const

Gets the text for the active state.

Definition at line 94 of file kdualaction.cpp.

QString KDualAction::activeToolTip ( ) const

Gets the tooltip for the active state.

Definition at line 99 of file kdualaction.cpp.

bool KDualAction::autoToggle ( ) const

Returns whether the current action will automatically be changed when the user triggers this action.

The default value is true.

Definition at line 114 of file kdualaction.cpp.

KGuiItem KDualAction::inactiveGuiItem ( ) const

Gets the KGuiItem for the inactive state.

Definition at line 86 of file kdualaction.cpp.

QIcon KDualAction::inactiveIcon ( ) const

Gets the icon for the inactive state.

Definition at line 91 of file kdualaction.cpp.

QString KDualAction::inactiveText ( ) const

Gets the text for the inactive state.

Definition at line 96 of file kdualaction.cpp.

QString KDualAction::inactiveToolTip ( ) const

Gets the tooltip for the inactive state.

Definition at line 101 of file kdualaction.cpp.

bool KDualAction::isActive ( ) const

Returns the action state.

The action is inactive by default.

Definition at line 129 of file kdualaction.cpp.

void KDualAction::setActive ( bool state )

slot

Sets the action state.

activeChanged() will be emitted but not activeChangedByUser().

Definition at line 119 of file kdualaction.cpp.

void KDualAction::setActiveGuiItem ( const KGuiItem & item )

Sets the KGuiItem for the active state.

Definition at line 83 of file kdualaction.cpp.

void KDualAction::setActiveIcon ( const QIcon & icon )

Sets the icon for the active state.

Definition at line 88 of file kdualaction.cpp.

void KDualAction::setActiveText ( const QString & text )

Sets the text for the active state.

Definition at line 93 of file kdualaction.cpp.

void KDualAction::setActiveToolTip ( const QString & toolTip )

Sets the tooltip for the active state.

Definition at line 98 of file kdualaction.cpp.

void KDualAction::setAutoToggle ( bool value )

Defines whether the current action should automatically be changed when the user triggers this action.

Definition at line 109 of file kdualaction.cpp.

void KDualAction::setIconForStates ( const QIcon & icon )

Convenience method to set the icon for both active and inactive states.

Definition at line 103 of file kdualaction.cpp.

void KDualAction::setInactiveGuiItem ( const KGuiItem & item )

Sets the KGuiItem for the inactive state.

Definition at line 85 of file kdualaction.cpp.

void KDualAction::setInactiveIcon ( const QIcon & icon )

Sets the icon for the inactive state.

Definition at line 90 of file kdualaction.cpp.

void KDualAction::setInactiveText ( const QString & text )

Sets the text for the inactive state.

Definition at line 95 of file kdualaction.cpp.

void KDualAction::setInactiveToolTip ( const QString & toolTip )

Sets the tooltip for the inactive state.

Definition at line 100 of file kdualaction.cpp.

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

KDEUI

Public Slots

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

KDEUI

kdelibs API Reference

Search