scim::ComposeKeyFactory Class Reference
[IMEngine]

A simple IMEngine to deal with the Compose keys. More...

#include <scim_compose_key.h>

List of all members.

Public Member Functions

 ComposeKeyFactory ()
virtual ~ComposeKeyFactory ()
virtual WideString get_name () const
 Get the name of this input method engine.
virtual String get_uuid () const
 Get the UUID of this input method engine.
virtual String get_icon_file () const
 Get the icon file path of this input method engine.
virtual WideString get_authors () const
 Get the authors information of this input method engine.
virtual WideString get_credits () const
 Get the credits information of this input method engine.
virtual WideString get_help () const
 Get the help information of this input method engine.
virtual bool validate_encoding (const String &encoding) const
 Check if an encoding is supported by this IMEngineFactory.
virtual bool validate_locale (const String &locale) const
 Check if a locale is supported by this IMEngineFactory.
virtual IMEngineInstancePointer create_instance (const String &encoding, int id=-1)
 Create a new IMEngineInstance object.


Detailed Description

A simple IMEngine to deal with the Compose keys.

Constructor & Destructor Documentation

scim::ComposeKeyFactory::ComposeKeyFactory (  ) 

virtual scim::ComposeKeyFactory::~ComposeKeyFactory (  )  [virtual]


Member Function Documentation

virtual WideString scim::ComposeKeyFactory::get_name (  )  const [virtual]

Get the name of this input method engine.

This name should be a localized string.

Returns:
A WideString containing the name.

Implements scim::IMEngineFactoryBase.

virtual String scim::ComposeKeyFactory::get_uuid (  )  const [virtual]

Get the UUID of this input method engine.

Each input method engine has an unique UUID to distinguish itself from other engines.

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

Returns:
A String containing an unique UUID.

Implements scim::IMEngineFactoryBase.

virtual String scim::ComposeKeyFactory::get_icon_file (  )  const [virtual]

Get the icon file path of this input method engine.

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

Implements scim::IMEngineFactoryBase.

virtual WideString scim::ComposeKeyFactory::get_authors (  )  const [virtual]

Get the authors information of this input method engine.

This string should be a localized string.

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

Implements scim::IMEngineFactoryBase.

virtual WideString scim::ComposeKeyFactory::get_credits (  )  const [virtual]

Get the credits information of this input method engine.

This string should be a localized string.

Returns:
A WideString containing the credits information.

Implements scim::IMEngineFactoryBase.

virtual WideString scim::ComposeKeyFactory::get_help (  )  const [virtual]

Get the help information of this input method engine.

This string should be a localized string.

Returns:
A WideString containing the help information.

Implements scim::IMEngineFactoryBase.

virtual bool scim::ComposeKeyFactory::validate_encoding ( const String encoding  )  const [virtual]

Check if an encoding is supported by this IMEngineFactory.

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::IMEngineFactoryBase.

virtual bool scim::ComposeKeyFactory::validate_locale ( const String locale  )  const [virtual]

Check if a locale is supported by this IMEngineFactory.

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::IMEngineFactoryBase.

virtual IMEngineInstancePointer scim::ComposeKeyFactory::create_instance ( const String encoding,
int  id = -1 
) [virtual]

Create a new IMEngineInstance object.

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

Parameters:
encoding - the encoding supported by the client.
id - the instance id, should be unique.
Returns:
A smart pointer points to this new IMEngineInstance object.

Implements scim::IMEngineFactoryBase.


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

Generated on Sat Jan 24 23:45:06 2009 for scim by  doxygen 1.5.7.1