Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

scim::FrontEndModule Class Reference
[FrontEnd]

The class to manipulate the frontend modules. More...

#include <scim_frontend_module.h>

Collaboration diagram for scim::FrontEndModule:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 FrontEndModule ()
 Default constructor.
 FrontEndModule (const String &name, const BackEndPointer &backend, const ConfigPointer &config, int argc, char **argv)
 Constructor.
bool load (const String &name, const BackEndPointer &backend, const ConfigPointer &config, int argc, char **argv)
 Load a FrontEnd module by its name.
bool valid () const
 Check if a module is loaded and initialized successfully.
void run () const
 run this FrontEnd module.

Detailed Description

The class to manipulate the frontend modules.

This is a wrapper of scim::Module class, which is specially for manipulating the frontend modules.

Definition at line 73 of file scim_frontend_module.h.


Constructor & Destructor Documentation

scim::FrontEndModule::FrontEndModule  ) 
 

Default constructor.

scim::FrontEndModule::FrontEndModule const String name,
const BackEndPointer backend,
const ConfigPointer config,
int  argc,
char **  argv
 

Constructor.

Parameters:
name - the module's name, eg. "rawcode".
backend - a BackEnd instance which holds all IMEngineFactory instances.
config - a smart pointer points to a ConfigBase instance.
argc - the number of (fake) command line arguments
argv - the (fake) command line argument vector


Member Function Documentation

bool scim::FrontEndModule::load const String name,
const BackEndPointer backend,
const ConfigPointer config,
int  argc,
char **  argv
 

Load a FrontEnd module by its name.

Load a module into memory. If another module has been loaded into this object, then the old module will be unloaded first. If the old module is resident, false will be returned, and the old module will be untouched.

Parameters:
name - the module's name, eg. "rawcode".
backend - a BackEnd instance which holds all IMEngineFactory instances.
config - a smart pointer points to a ConfigBase instance.
argc - the number of (fake) command line arguments
argv - the (fake) command line argument vector

bool scim::FrontEndModule::valid  )  const
 

Check if a module is loaded and initialized successfully.

Returns:
true if a module is already loaded and initialized successfully.

void scim::FrontEndModule::run  )  const
 

run this FrontEnd module.


The documentation for this class was generated from the following file:
Generated on Thu Dec 30 21:03:22 2004 for scim by doxygen 1.3.8