K3UndoRedoAction Class Reference

#include <k3command.h>

Inheritance diagram for K3UndoRedoAction:

Public Types
enum	Type { Undo, Redo }
Public Types inherited from KAction
enum	GlobalShortcutLoading
enum	ShortcutType

Public Member Functions
	K3UndoRedoAction (Type type, KActionCollection *actionCollection, K3CommandHistory *commandHistory)
Public Member Functions inherited from KToolBarPopupAction
	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 (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

Additional Inherited Members
Signals inherited from KAction
void	authorized (KAuth::Action *action)
void	globalShortcutChanged (const QKeySequence &)
void	triggered (Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers)
Properties inherited from KToolBarPopupAction
bool	delayed
bool	stickyMenu
Properties inherited from KAction
KShortcut	globalShortcut
bool	globalShortcutAllowed
bool	globalShortcutEnabled
KShortcut	shortcut
bool	shortcutConfigurable

Detailed Description

This type of action is used to show undo or redo actions in the menu or in the toolbars.

This action will keep itself up to date and change the text based on the undo history, plus it will disable itself when there is nothing to undo/redo. You will typically need two instances of this action per view (e.g. the mainwindow).

new KUndoRedoAction( KUndoRedoAction::Undo, view->actionCollection(), m_history );
new KUndoRedoAction( KUndoRedoAction::Redo, view->actionCollection(), m_history );

Note that there is no need to connect or even keep a reference to the object as all work is done automatically.

Note: you might want to use the QUndo framework instead. It didn't exist when K3Command was written.

Definition at line 357 of file k3command.h.

Member Enumeration Documentation

enum K3UndoRedoAction::Type

Enumerator
Undo
Redo

Definition at line 361 of file k3command.h.

Constructor & Destructor Documentation

K3UndoRedoAction::K3UndoRedoAction	(	Type	type,
		KActionCollection *	actionCollection,
		K3CommandHistory *	commandHistory
	)

Definition at line 360 of file k3command.cpp.

---

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

• k3command.h
• k3command.cpp