Kexi API Documentation (2.0 alpha)
Overview Class Hierarchy Classes Classes (annotated) Members Source Files
KoMacro::Macro

KoMacro::Macro Class Reference

#include <macro.h>

Inheritance diagram for KoMacro::Macro:

KShared KoMacro::XMLHandler List of all members.

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.

Public Types

typedef QMap< QString, KSharedPtr<
Macro > > 		Map
 A QMap of Macro instances accessible by there unique name.

Public Slots

virtual KSharedPtr< Context > execute (QObject *sender)
 Called if the Macro should be executed.

Public Member Functions

 Macro (const QString &name)
 Constructor.
virtual ~Macro ()
 Destructor.
const QString name () const
void setName (const QString &name)
 Set the name this Macro instance has.
virtual const QString toString () const
QValueList< KSharedPtr< MacroItem > > & items () const
void addItem (KSharedPtr< MacroItem > item)
 Add the MacroItem item to the list of items this Macro has.
void clearItems ()
 Removes all MacroItem instances this Macro has.

Member Typedef Documentation

typedef QMap<QString, KSharedPtr<Macro > > KoMacro::Macro::Map
 

A QMap of Macro instances accessible by there unique name.

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

Definition at line 55 of file macro.h.

Constructor & Destructor Documentation

Macro::Macro (  const QString &  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 (   )  [virtual]
 

Destructor.

Definition at line 66 of file macro.cpp.

Member Function Documentation

void Macro::addItem (  KSharedPtr< MacroItem >  item  ) 
 

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

Definition at line 97 of file macro.cpp.

void Macro::clearItems (   ) 
 

Removes all MacroItem instances this Macro has.

Definition at line 102 of file macro.cpp.

KSharedPtr< Context > Macro::execute (  QObject *  sender  )  [virtual, slot]
 

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.

QValueList< KSharedPtr< MacroItem > > & Macro::items (   )  const
 

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

Definition at line 91 of file macro.cpp.

const QString Macro::name (   )  const
 

Returns:
the name this Macro instance has.

Definition at line 73 of file macro.cpp.

Referenced by toString().

void Macro::setName (  const QString &  name  ) 
 

Set the name this Macro instance has.

Definition at line 79 of file macro.cpp.

const QString Macro::toString (   )  const [virtual]
 

Returns:
a string-representation of the macro.

Definition at line 85 of file macro.cpp.

References name().

The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for Kexi 2.0 alpha.
Documentation copyright © 2002-2007 the Kexi Team.
Generated on Tue Apr 1 20:51:02 2008 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003