MacroCmd Class Reference

#include <command.h>

Inheritance diagram for MacroCmd:

List of all members.

Public Member Functions
	MacroCmd (FrameBuffer *pFB)
	MacroCmd (FrameBuffer *pFB, std::string macName)
MacroCmd &	operator<< (Cmd *pCmd)
virtual void	exec ()
virtual void	unExec ()
virtual std::string	name ()
	Command identification. This will appear in config file.
virtual std::string	args ()
	Command export to text string. Needed for macro saving.
void	name (std::string name)
void	save ()
Static Public Attributes
static const char *	szCmdName
	Command id string.

---

Detailed Description

Macro command abstraction. Design patterns: command, composite

Definition at line 126 of file command.h.

---

Constructor & Destructor Documentation

MacroCmd::MacroCmd

(

FrameBuffer *

pFB

)

[inline]

Initialize base.

Parameters:

pFB

Pointer to frame buffer to work with.

Definition at line 132 of file command.h.

MacroCmd::MacroCmd	(	FrameBuffer *	pFB,
		std::string	macName
	)

Read macro from configuration file.

Parameters:

	pFB	Pointer to frame buffer to work with.
	macName	Macro name.

---

Member Function Documentation

MacroCmd& MacroCmd::operator<<

(

Cmd *

pCmd

)

Put command to MacroCmd. *pCmd object must exist all the time since MacroCmd object is destroyed.

Parameters:

pCmd

pointer to command.

Returns:

Reference to this. Needed for << operator concatenation.

virtual void MacroCmd::exec

(

)

[virtual]

Execute macro command. This means all elementary commands are executed.

Implements Cmd.

virtual void MacroCmd::unExec

(

)

[virtual]

Undo macro command. This means all elementary commands are unexecuted in reverse order.

Implements Cmd.

virtual std::string MacroCmd::name

(

)

[inline, virtual]

Command identification. This will appear in config file.

Implements Cmd.

Definition at line 160 of file command.h.

References szCmdName.

virtual std::string MacroCmd::args

(

)

[inline, virtual]

Command export to text string. Needed for macro saving.

Implements Cmd.

Definition at line 161 of file command.h.

void MacroCmd::name

(

std::string

name

)

[inline]

Set macro name.

Parameters:

name

New macro name.

Definition at line 167 of file command.h.

void MacroCmd::save

(

)

Save macro to configuration file.

---

Member Data Documentation

const char* MacroCmd::szCmdName [static]

Command id string.

Definition at line 174 of file command.h.

Referenced by name().

---

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

• command.h

---