lib

Kross::Api::Module Class Reference

#include <module.h>

Inheritance diagram for Kross::Api::Module:
Kross::Api::Class< Module > Kross::Api::Event< Module > Kross::Api::Callable Kross::Api::Object Kross::Api::MainModule Kross::Api::Manager Kross::Api::ScriptContainer Kross::Api::ScriptAction

Public Types

typedef TDESharedPtr< Module > Ptr
Public Types inherited from Kross::Api::Class< Module >
typedef TDESharedPtr< Module > Ptr
Public Types inherited from Kross::Api::Callable
typedef TDESharedPtr< Callable > Ptr
Public Types inherited from Kross::Api::Object
typedef TDESharedPtr< Object > Ptr

Public Member Functions

 Module (const TQString &name)
virtual ~Module ()
virtual Kross::Api::Object::Ptr get (const TQString &, void *=0)
Public Member Functions inherited from Kross::Api::Class< Module >
 Class (const TQString &name)
virtual ~Class ()
 operator Module * ()
Public Member Functions inherited from Kross::Api::Event< Module >
 Event (const TQString &name)
virtual ~Event ()
void addFunction (const TQString &name, FunctionPtr function)
void addFunction4 (const TQString &name, INSTANCE *instance, METHOD method, ARG1OBJ *arg1=0, ARG2OBJ *arg2=0, ARG3OBJ *arg3=0, ARG4OBJ *arg4=0)
void addFunction3 (const TQString &name, INSTANCE *instance, METHOD method, ARG1OBJ *arg1=0, ARG2OBJ *arg2=0, ARG3OBJ *arg3=0)
void addFunction2 (const TQString &name, INSTANCE *instance, METHOD method, ARG1OBJ *arg1=0, ARG2OBJ *arg2=0)
void addFunction1 (const TQString &name, INSTANCE *instance, METHOD method, ARG1OBJ *arg1=0)
void addFunction0 (const TQString &name, INSTANCE *instance, METHOD method)
bool isAFunction (const TQString &name) const
virtual Object::Ptr call (const TQString &name, List::Ptr arguments)
Public Member Functions inherited from Kross::Api::Callable
 Callable (const TQString &name)
virtual ~Callable ()
const TQString getName () const
virtual const TQString getClassName () const
bool hasChild (const TQString &name) const
Object::Ptr getChild (const TQString &name) const
TQMap< TQString, Object::Ptr > getChildren () const
bool addChild (const TQString &name, Object *object)
bool addChild (Callable *object)
void removeChild (const TQString &name)
void removeAllChildren ()
Public Member Functions inherited from Kross::Api::Object
 Object ()
virtual ~Object ()
virtual const TQString toString ()
virtual Object::Ptr call (const TQString &name, TDESharedPtr< List > arguments)
virtual TQStringList getCalls ()

Additional Inherited Members

Static Public Member Functions inherited from Kross::Api::Class< Module >
static Object::Ptr toObject (TYPE t)
Static Public Member Functions inherited from Kross::Api::Object
template<class T>
static T * fromObject (Object::Ptr object)
template<typename TYPE>
static Object::Ptr toObject (TYPE t)

Detailed Description

The Module class.

Modules are managed in the Manager singleton instance and are implemented as in scripting plugins as main entry point to load and work with them.

Definition at line 36 of file module.h.

Member Typedef Documentation

◆ Ptr

typedef TDESharedPtr<Module> Kross::Api::Module::Ptr

Shared pointer to implement reference-counting.

Definition at line 43 of file module.h.

Constructor & Destructor Documentation

◆ Module()

Kross::Api::Module::Module ( const TQString & name)
inlineexplicit

Constructor.

Parameters
nameThe name of this module. Each module needs a unique name cause the application using Kross identifies modules with there names.

Definition at line 53 of file module.h.

◆ ~Module()

virtual Kross::Api::Module::~Module ( )
inlinevirtual

Destructor.

Definition at line 62 of file module.h.

Member Function Documentation

◆ get()

virtual Kross::Api::Object::Ptr Kross::Api::Module::get ( const TQString & ,
void * = 0 )
inlinevirtual

Method to load from Kross::Api::Object inherited classes this module implements from within other modules.

Definition at line 71 of file module.h.


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