scim::BackEndBase Class Reference

The interface class to manage a set of IMEngineFactory and IMEngineInstance objects. More...

#include <scim_backend.h>

Inherits scim::ReferencedObject.

Inherited by scim::CommonBackEnd.

List of all members.

Public Member Functions

String get_all_locales () const
 Get a list of all locales supported by all IMEngineFactories.
IMEngineFactoryPointer get_factory (const String &uuid) const
Methods to manipulate IMEngine Factories.
uint32 get_factories_for_encoding (std::vector< IMEngineFactoryPointer > &factories, const String &encoding=String("")) const
 Get the IMEngine factories list for specific encoding.
uint32 get_factories_for_language (std::vector< IMEngineFactoryPointer > &factories, const String &language=String("")) const
 Get the IMEngine factories list for specific language.
IMEngineFactoryPointer get_default_factory (const String &language, const String &encoding) const
 Get the default IMEngineFactory for a specific language and encoding.
void set_default_factory (const String &language, const String &uuid)
 Set the default IMEngineFactory for a specific language.
IMEngineFactoryPointer get_next_factory (const String &language, const String &encoding, const String &cur_uuid) const
 Get the next IMEngineFactory for a specific language and encoding.
IMEngineFactoryPointer get_previous_factory (const String &language, const String &encoding, const String &cur_uuid) const
 Get the previous IMEngineFactory for a specific language and encoding.

Protected Member Functions

 BackEndBase (const ConfigPointer &config)
 Default constructor.
virtual ~BackEndBase ()
bool add_factory (const IMEngineFactoryPointer &factory)
void clear ()


Detailed Description

The interface class to manage a set of IMEngineFactory and IMEngineInstance objects.

This is mainly an accessory interface class used by scim::FrontEndBase. Its responsibility is to hold a set of IMEngineFactory instances and manage the locales list supported by them.

Most developer should just use the default implementation scim::CommonBackEnd.


Constructor & Destructor Documentation

scim::BackEndBase::BackEndBase ( const ConfigPointer config  )  [protected]

Default constructor.

Parameters:
config Config object to be used.

virtual scim::BackEndBase::~BackEndBase (  )  [protected, virtual]


Member Function Documentation

String scim::BackEndBase::get_all_locales (  )  const

Get a list of all locales supported by all IMEngineFactories.

Returns:
A comma separated locales list.

IMEngineFactoryPointer scim::BackEndBase::get_factory ( const String uuid  )  const

Returns:
Return the pointer of a Factory.
Parameters:
uuid The uuid of the IMEngineFactory.

uint32 scim::BackEndBase::get_factories_for_encoding ( std::vector< IMEngineFactoryPointer > &  factories,
const String encoding = String("") 
) const

Get the IMEngine factories list for specific encoding.

Parameters:
factories the vector to store the factories which support the encoding.
encoding the encoding to be queried. If empty, all IMEngine factories will be returned.
Returns:
the number of IMEngine factories found.

uint32 scim::BackEndBase::get_factories_for_language ( std::vector< IMEngineFactoryPointer > &  factories,
const String language = String("") 
) const

Get the IMEngine factories list for specific language.

Parameters:
factories the vector to store the factories which support the encoding.
language the language to be queried. If empty, all IMEngine factories will be returned.
Returns:
the number of IMEngine factories found.

IMEngineFactoryPointer scim::BackEndBase::get_default_factory ( const String language,
const String encoding 
) const

Get the default IMEngineFactory for a specific language and encoding.

Parameters:
language the language to be queried.
encoding the encoding to be queried, if empty then don't match encoding.
Returns:
the pointer of the default IMEngineFactory for this language.

void scim::BackEndBase::set_default_factory ( const String language,
const String uuid 
)

Set the default IMEngineFactory for a specific language.

Parameters:
language the language to be set.
uuid the uuid of the default IMEngineFactory for this language.

IMEngineFactoryPointer scim::BackEndBase::get_next_factory ( const String language,
const String encoding,
const String cur_uuid 
) const

Get the next IMEngineFactory for a specific language and encoding.

Parameters:
language the language to be queried, if empty then don't match language.
encoding the encoding to be queried, if empty then don't match encoding.
cur_uuid the UUID of current IMEngineFactory.
Returns:
the pointer of the next IMEngineFactory for this language and encoding corresponding to the current IMEngineFactory.

IMEngineFactoryPointer scim::BackEndBase::get_previous_factory ( const String language,
const String encoding,
const String cur_uuid 
) const

Get the previous IMEngineFactory for a specific language and encoding.

Parameters:
language the language to be queried, if empty then don't match language.
encoding the encoding to be queried, if empty then don't match encoding.
cur_uuid the UUID of current IMEngineFactory.
Returns:
the pointer of the previous IMEngineFactory for this language and encoding corresponding to the current IMEngineFactory.

bool scim::BackEndBase::add_factory ( const IMEngineFactoryPointer factory  )  [protected]

void scim::BackEndBase::clear (  )  [protected]


The documentation for this class was generated from the following file:
Generated on Sat Jun 21 21:12:57 2008 for scim by  doxygen 1.4.7