K3MacroCommand Class Reference

#include <k3command.h>

Inheritance diagram for K3MacroCommand:

Public Member Functions
	K3MacroCommand (const QString &name)
virtual	~K3MacroCommand ()
void	addCommand (K3Command *command)
virtual void	execute ()
virtual void	unexecute ()
Public Member Functions inherited from K3NamedCommand
virtual	~K3NamedCommand ()
virtual QString	name () const
void	setName (const QString &name)
Public Member Functions inherited from K3Command
virtual	~K3Command ()

Protected Member Functions
const QList< K3Command * >	commands () const
virtual void	virtual_hook (int id, void *data)
Protected Member Functions inherited from K3NamedCommand
	K3NamedCommand (const QString &name)
Protected Member Functions inherited from K3Command
	K3Command ()

Detailed Description

A Macro Command is a command that holds several sub-commands.

It will appear as one to the user and in the command history, but it can use the implementation of multiple commands internally.

Definition at line 126 of file k3command.h.

Constructor & Destructor Documentation

K3MacroCommand::K3MacroCommand

(

const QString &

name

)

Creates a macro command.

You will then need to call addCommand for each subcommand to be added to this macro command.

Parameters

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

Definition at line 76 of file k3command.cpp.

K3MacroCommand::~K3MacroCommand ( )

virtual

Definition at line 82 of file k3command.cpp.

Member Function Documentation

void K3MacroCommand::addCommand

(

K3Command *

command

)

Appends a command to this macro command.

The ownership is transferred to the macro command.

Definition at line 88 of file k3command.cpp.

const QList< K3Command * > K3MacroCommand::commands ( ) const

protected

Definition at line 110 of file k3command.cpp.

void K3MacroCommand::execute ( )

virtual

Executes this command, i.e.

execute all the sub-commands in the order in which they were added.

Implements K3Command.

Definition at line 93 of file k3command.cpp.

void K3MacroCommand::unexecute ( )

virtual

Undoes the execution of this command, i.e.

unexecute all the sub-commands in the reverse order to the one in which they were added.

Implements K3Command.

Definition at line 101 of file k3command.cpp.

void K3MacroCommand::virtual_hook ( int  id, void *  data  )

protectedvirtual

Reimplemented from K3NamedCommand.

Definition at line 442 of file k3command.cpp.

---

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

• k3command.h
• k3command.cpp