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

KoMacro::Context Class Reference

#include <context.h>

Inheritance diagram for KoMacro::Context:

KShared List of all members.

Detailed Description

The context of an execution.

If a Macro got executed it creates an instance of this class and passes it around all it's children as local execution context.

Definition at line 41 of file context.h.

Public Slots

virtual void activate (KSharedPtr< Context > context)
 This slot extends the slot above with the passed Context context which will be used as parent context for this context.
virtual void activateNext ()
 This slot continues execution.

Public Member Functions

 Context (KSharedPtr< Macro > macro)
 Constructor.
 ~Context ()
 Destructor.
bool hasVariable (const QString &name) const
KSharedPtr< Variable > variable (const QString &name) const
Variable::Map variables () const
void setVariable (const QString &name, KSharedPtr< Variable > variable)
 Set the variable variable defined with name name .
KSharedPtr< Macro > macro () const
KSharedPtr< MacroItem > macroItem () const
bool hadException () const
Exception * exception () const

Constructor & Destructor Documentation

Context::Context (  KSharedPtr< Macro >  macro  )  [explicit]
 

Constructor.

Parameters:
macro The Macro this Context belongs to.

Definition at line 87 of file context.cpp.

Context::~Context (   ) 
 

Destructor.

Definition at line 94 of file context.cpp.

Member Function Documentation

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

This slot extends the slot above with the passed Context context which will be used as parent context for this context.

Definition at line 220 of file context.cpp.

References setVariable().

void Context::activateNext (   )  [virtual, slot]
 

This slot continues execution.

Definition at line 244 of file context.cpp.

Exception * Context::exception (   )  const
 

Returns:
the Exception instance that was thrown on the last call of activate() . If there was no exception NULL is returned.

Definition at line 159 of file context.cpp.

bool Context::hadException (   )  const
 

Returns:
true if the last activate() stopped with an exception else false is returned.

Definition at line 153 of file context.cpp.

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

Returns:
true if there exists a variable with name name else false got returned.

Definition at line 100 of file context.cpp.

KSharedPtr< Macro > Context::macro (   )  const
 

Returns:
the associated macro

Definition at line 141 of file context.cpp.

KSharedPtr< MacroItem > Context::macroItem (   )  const
 

Returns:
the currently selected MacroItem instance or NULL if there is no MacroItem selected yet.

Definition at line 147 of file context.cpp.

void Context::setVariable (  const QString &  name,
KSharedPtr< Variable >  variable
) 
 

Set the variable variable defined with name name .

If there exists already a variable with that name replace it.

Definition at line 132 of file context.cpp.

Referenced by activate().

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

Returns:
the Variable defined with name name or NULL if there exists no such variable.

Definition at line 107 of file context.cpp.

Variable::Map Context::variables (   )  const
 

Returns:
a map of all Variable instance that are defined within this context.

Definition at line 126 of file context.cpp.

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