KoMacro::Macro Class Reference

#include <macro.h>

Inheritance diagram for KoMacro::Macro:

Public Types
typedef TQMap< TQString, TDESharedPtr< Macro > >	Map

Public Slots
virtual TDESharedPtr< Context >	execute (TQObject *sender)

Public Member Functions
	Macro (const TQString &name)
virtual	~Macro ()
const TQString	name () const
void	setName (const TQString &name)
virtual const TQString	toString () const
TQValueList< TDESharedPtr< MacroItem > > &	items () const
void	addItem (TDESharedPtr< MacroItem > item)
void	clearItems ()
Public Member Functions inherited from KoMacro::XMLHandler
	XMLHandler (Macro *const macro)
	~XMLHandler ()
bool	parseXML (const TQDomElement &element)
TQDomElement	toXML ()

Detailed Description

The Macro class implements all the action-handling.

Internaly the Macro provides a collection of MacroItem instances which each of them points to an Action instance.

Definition at line 41 of file macro.h.

Member Typedef Documentation

Map

typedef TQMap<TQString, TDESharedPtr<Macro > > KoMacro::Macro::Map

A TQMap of Macro instances accessible by there unique name.

Each class should use this typemap rather then the TQMap direct. That way we are more flexible on future changes.

Definition at line 56 of file macro.h.

Constructor & Destructor Documentation

Macro()

Macro::Macro ( const TQString & name )

explicit

Constructor.

Parameters

name	The internal name this Macro has. This name will be used as unique identifier.

Definition at line 56 of file macro.cpp.

~Macro()

Macro::~Macro ( )

virtual

Destructor.

Definition at line 66 of file macro.cpp.

Member Function Documentation

addItem()

void Macro::addItem

(

TDESharedPtr< MacroItem >

item

)

Add the MacroItem item to the list of items this Macro has.

Definition at line 97 of file macro.cpp.

clearItems()

void Macro::clearItems

(

)

Removes all MacroItem instances this Macro has.

Definition at line 102 of file macro.cpp.

execute

TDESharedPtr< Context > Macro::execute ( TQObject * sender )

virtualslot

Connect the TQt signal signal of the TQObject sender with this Macro .

If the signal got emitted this Macro instance will be activated and the in the signal passed arguments are transfered into the activation Context . Called if the Macro should be executed.

Parameters

context

The Context this Macro should be executed in.

Definition at line 108 of file macro.cpp.

items()

TQValueList< TDESharedPtr< MacroItem > > & Macro::items

(

)

const

Returns

a list of MacroItem instances which are children of this Macro .

Definition at line 91 of file macro.cpp.

name()

const TQString Macro::name

(

)

const

Returns

the name this Macro instance has.

Definition at line 73 of file macro.cpp.

setName()

void Macro::setName

(

const TQString &

name

)

Set the name this Macro instance has.

Definition at line 79 of file macro.cpp.

toString()

const TQString Macro::toString ( ) const

virtual

Returns

a string-representation of the macro.

Definition at line 85 of file macro.cpp.

---

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

• macro.h
• macro.cpp