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

scim::DummyServerFactory Class Reference
[Server]

#include <scim_server.h>

Inheritance diagram for scim::DummyServerFactory:

Inheritance graph
[legend]
Collaboration diagram for scim::DummyServerFactory:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 DummyServerFactory ()
virtual ~DummyServerFactory ()
virtual WideString get_name () const
 Get the name of this input method server.

virtual WideString get_authors () const
 Get the authors of this input method server.

virtual WideString get_credits () const
 Get the credits information of this input method server.

virtual WideString get_help () const
 Get the help information of this input method server.

virtual String get_uuid () const
 Get the UUID of this input method server.

virtual String get_icon_file () const
 Get the icon file path of this input method server.

virtual bool validate_encoding (const String &encoding) const
 Check if a encoding is supported by this ServerFactory.

virtual bool validate_locale (const String &locale) const
 Check if a locale is supported by this ServerFactory.

virtual ServerInstancePointer create_server_instance (const String &encoding, int id=-1)
 Create a new ServerInstance object.


Constructor & Destructor Documentation

scim::DummyServerFactory::DummyServerFactory  ) 
 

virtual scim::DummyServerFactory::~DummyServerFactory  )  [virtual]
 


Member Function Documentation

virtual WideString scim::DummyServerFactory::get_name  )  const [virtual]
 

Get the name of this input method server.

This name should be a localized string.

Returns:
A WideString containing the name.

Implements scim::ServerFactoryBase.

virtual WideString scim::DummyServerFactory::get_authors  )  const [virtual]
 

Get the authors of this input method server.

This string should be a localized string.

Returns:
A WideString containing a list of the authors' name.

Implements scim::ServerFactoryBase.

virtual WideString scim::DummyServerFactory::get_credits  )  const [virtual]
 

Get the credits information of this input method server.

This string should be a localized string.

Returns:
A WideString containing the credits information.

Implements scim::ServerFactoryBase.

virtual WideString scim::DummyServerFactory::get_help  )  const [virtual]
 

Get the help information of this input method server.

This string should be a localized string.

Returns:
A WideString containing the help information.

Implements scim::ServerFactoryBase.

virtual String scim::DummyServerFactory::get_uuid  )  const [virtual]
 

Get the UUID of this input method server.

Each input method server has an unique UUID to distinguish itself from other servers.

You may use uuidgen command shipped with e2fsprogs package to generate this UUID.

Returns:
A String containing an unique UUID.

Implements scim::ServerFactoryBase.

virtual String scim::DummyServerFactory::get_icon_file  )  const [virtual]
 

Get the icon file path of this input method server.

Returns:
A String containing the icon file path on the local filesystem.

Implements scim::ServerFactoryBase.

virtual bool scim::DummyServerFactory::validate_encoding const String encoding  )  const [virtual]
 

Check if a encoding is supported by this ServerFactory.

The default implementation of this virtual function validates the encoding against the locale list set by method set_locales.

It should be enough in most case.

Parameters:
encoding - the encoding name to be checked.
Returns:
true if the encoding is supported, otherwise false.

Reimplemented from scim::ServerFactoryBase.

virtual bool scim::DummyServerFactory::validate_locale const String locale  )  const [virtual]
 

Check if a locale is supported by this ServerFactory.

The default implementation of this virtual function validates the locale against the locale list set by method set_locales.

It should be enough in most case.

Parameters:
locale - the locale name to be checked.
Returns:
true if the locale is supported, otherwise false.

Reimplemented from scim::ServerFactoryBase.

virtual ServerInstancePointer scim::DummyServerFactory::create_server_instance const String encoding,
int  id = -1
[virtual]
 

Create a new ServerInstance object.

This method creates a new scim::ServerInstanceBase object with given encoding and id.

Parameters:
encoding - the working encoding.
id - the instance id, should be unique.
Returns:
A smart pointer points to this new ServerInstance object.

Implements scim::ServerFactoryBase.


The documentation for this class was generated from the following file:
Generated on Fri May 7 17:27:29 2004 for scim by doxygen 1.3.6