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

KoMacro::Action Class Reference

#include <action.h>

Inheritance diagram for KoMacro::Action:

List of all members.

---

Detailed Description

The Action class extendes KAction to implement some additional functionality KAction doesn't provide.

Definition at line 38 of file action.h.

Public Types
typedef QMap< QString, KSharedPtr< Action > >	Map
	Shared pointer to implement reference-counting.
Public Slots
virtual void	activate (KSharedPtr< Context > context)=0
	Called if the Action should be executed within the defined context .
Public Member Functions
	Action (const QString &name, const QString &text=QString::null)
	Constructor.
virtual	~Action ()
	Destructor.
virtual const QString	toString () const
const QString	name () const
	The name this Action has.
void	setName (const QString &name)
	Set the name of the Action to name .
const QString	text () const
void	setText (const QString &text)
	Set the i18n-caption text this Action has.
const QString	comment () const
void	setComment (const QString &comment)
	Set the comment associated with this action.
bool	hasVariable (const QString &name) const
KSharedPtr< Variable >	variable (const QString &name) const
Variable::Map	variables () const
QStringList	variableNames () const
void	setVariable (KSharedPtr< Variable > variable)
	Append the Variable variable to list of variables this Action provides.
void	setVariable (const QString &name, const QString &text, const QVariant &variant)
	Set the variable.
void	removeVariable (const QString &name)
	Remove the variable defined with name .
virtual bool	notifyUpdated (const KSharedPtr< MacroItem > &macroitem, const QString &name)
	This function is called, when the KoMacro::Variable with name name used within the KoMacro::MacroItem macroitem got changed.
Properties
QString	name
	Property to get/set the name.
QString	text
	Property to get/set the text.
QString	comment
	Property to get/set the comment.

---

Member Typedef Documentation

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

Shared pointer to implement reference-counting. Definition at line 58 of file action.h.

---

Constructor & Destructor Documentation

Action::Action (  const QString &  name, const QString &  text = QString::null )  [explicit]

Constructor. Parameters: name  The unique name this Action has. text  The i18n-caption text this Action has. Definition at line 69 of file action.cpp. References KoMacro::Manager::self(), and setText().

Action::~Action (   )  [virtual]

Destructor. Definition at line 82 of file action.cpp.

---

Member Function Documentation

virtual void KoMacro::Action::activate (  KSharedPtr< Context >  context  )  [pure virtual, slot]

Called if the Action should be executed within the defined context .

const QString KoMacro::Action::comment (   )  const

Returns: the comment associated with this action.

bool Action::hasVariable (  const QString &  name  )  const

Returns: true if there exists a variable with the name name else false is returned. Definition at line 125 of file action.cpp.

const QString KoMacro::Action::name (   )  const

The name this Action has. Referenced by KexiMacro::OpenAction::activate(), KexiMacro::ExecuteAction::activate(), setVariable(), and toString().

virtual bool KoMacro::Action::notifyUpdated (  const KSharedPtr< MacroItem > &  macroitem, const QString &  name )  [inline, virtual]

This function is called, when the KoMacro::Variable with name name used within the KoMacro::MacroItem macroitem got changed. Parameters: macroitem  The KoMacro::MacroItem instance where the variable defined with name is located in. name  The name the KoMacro::Variable has. Returns: true if the update was successfully else false is returned. Definition at line 164 of file action.h.

void Action::removeVariable (  const QString &  name  )

Remove the variable defined with name . If there exists no such variable, nothing is done. Definition at line 162 of file action.cpp.

void Action::setComment (  const QString &  comment  )

Set the comment associated with this action. Definition at line 120 of file action.cpp.

void Action::setName (  const QString &  name  )

Set the name of the Action to name . Definition at line 100 of file action.cpp.

void Action::setText (  const QString &  text  )

Set the i18n-caption text this Action has. Definition at line 110 of file action.cpp. Referenced by Action(), and KexiMacro::KexiAction::KexiAction().

void Action::setVariable (  const QString &  name, const QString &  text, const QVariant &  variant )

Set the variable. Parameters: name  The name the variable should have. text  The i18n-caption used for display. variant  The QVariant value. Definition at line 154 of file action.cpp. References KoMacro::Variable::setName(), KoMacro::Variable::setText(), setVariable(), and variable().

void Action::setVariable (  KSharedPtr< Variable >  variable  )

Append the Variable variable to list of variables this Action provides. Definition at line 145 of file action.cpp. References name(). Referenced by KexiMacro::DataTableAction::DataTableAction(), KexiMacro::ExecuteAction::ExecuteAction(), KexiMacro::MessageAction::MessageAction(), KexiMacro::NavigateAction::NavigateAction(), KexiMacro::OpenAction::OpenAction(), and setVariable().

const QString KoMacro::Action::text (   )  const

Returns: the i18n-caption text this Action has.

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

Returns: a string representation of the functionality this action provides. Definition at line 90 of file action.cpp. References name().

KSharedPtr< Variable > Action::variable (  const QString &  name  )  const

Returns: the variable Variable defined for the name name . If there exists no Variable with such a name, NULL is returned. Definition at line 130 of file action.cpp. Referenced by KexiMacro::OpenAction::notifyUpdated(), KexiMacro::NavigateAction::notifyUpdated(), KexiMacro::ExecuteAction::notifyUpdated(), and setVariable().

QStringList Action::variableNames (   )  const

Returns: a list of variablenames this Action provides.s Definition at line 140 of file action.cpp.

Variable::Map Action::variables (   )  const

Returns: the map of variables this Action provides. Definition at line 135 of file action.cpp.

---

Property Documentation

const QString Action::comment [read, write]

Property to get/set the comment. Definition at line 51 of file action.h.

const QString Action::name [read, write]

Property to get/set the name. Definition at line 45 of file action.h.

const QString Action::text [read, write]

Property to get/set the text. Definition at line 48 of file action.h.

---

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

• action.h
• action.cpp

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