• Skip to content
  • Skip to link menu
KDE 3.5 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

kdeui

KCommand Class Reference

The abstract base class for all Commands. More...

#include <kcommand.h>

Inheritance diagram for KCommand:

Inheritance graph
[legend]

List of all members.


Public Member Functions

virtual void execute ()=0
virtual QString name () const =0
virtual void unexecute ()=0
virtual ~KCommand ()

Protected Member Functions

 KCommand ()
virtual void virtual_hook (int id, void *data)

Detailed Description

The abstract base class for all Commands.

Commands are used to store information needed for Undo/Redo functionality...

Definition at line 37 of file kcommand.h.


Constructor & Destructor Documentation

KCommand::KCommand (  )  [inline, protected]

Creates a command.

Definition at line 43 of file kcommand.h.

KCommand::~KCommand (  )  [virtual]

Definition at line 29 of file kcommand.cpp.


Member Function Documentation

virtual void KCommand::execute (  )  [pure virtual]

The main method: executes this command.

Implement here what this command is about, and remember to record any information that will be helpful for unexecute.

Implemented in KMacroCommand.

virtual QString KCommand::name (  )  const [pure virtual]

Returns:
the name of this command, translated, since it will appear in the menus.

Implemented in KNamedCommand.

virtual void KCommand::unexecute (  )  [pure virtual]

Unexecutes (undo) this command.

Implement here the steps to take for undoing the command. If your application uses actions for everything (it should), and if you implement unexecute correctly, the application is in the same state after unexecute as it was before execute. This means, the next call to execute will do the same thing as it did the first time.

Implemented in KMacroCommand.

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

Reimplemented in KNamedCommand, and KMacroCommand.

Definition at line 367 of file kcommand.cpp.


The documentation for this class was generated from the following files:
  • kcommand.h
  • kcommand.cpp

kdeui

Skip menu "kdeui"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

API Reference

Skip menu "API Reference"
  • dcop
  • DNSSD
  • interfaces
  • Kate
  • kconf_update
  • KDECore
  • KDED
  • kdefx
  • KDEsu
  • kdeui
  • KDocTools
  • KHTML
  • KImgIO
  • KInit
  • kio
  • kioslave
  • KJS
  • KNewStuff
  • KParts
  • KUtils
Generated for API Reference by doxygen 1.5.9
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal