#include <scim_backend.h>
Inheritance diagram for scim::BackEndBase:


Public Member Functions | |
| BackEndBase () | |
| Default constructor. | |
| virtual | ~BackEndBase () |
| Virtual destructor. | |
| String | get_all_locales () const |
| Get a list of all locales supported by all FrontEnds. | |
| uint32 | number_of_factories () const |
| Return the number of factories held by this BackEnd. | |
| IMEngineFactoryPointer | get_factory_pointer (uint32 idx) const |
Methods to manipulate IMEngine Factories. | |
| uint32 | get_factory_list (std::vector< String > &uuids, const String &encoding=String("")) const |
| Get the IMEngine factories list for specific encoding. | |
| WideString | get_factory_name (const String &uuid) const |
| get the name of an IMEngine factory. | |
| WideString | get_factory_authors (const String &uuid) const |
| get the authors info of an IMEngine factory. | |
| WideString | get_factory_credits (const String &uuid) const |
| get the credits info of an IMEngine factory. | |
| WideString | get_factory_help (const String &uuid) const |
| get the help info of an IMEngine factory. | |
| String | get_factory_icon_file (const String &uuid) const |
| get the icon file of an IMEngine factory. | |
| String | get_factory_locales (const String &uuid) const |
| get the supported locales of an IMEngine factory. | |
| String | get_factory_language (const String &uuid) const |
| get the language of an IMEngine factory. | |
Methods to manipulate IMEngine Instances. | |
| int | new_instance (const String &sf_uuid, const String &encoding) |
| create a new IMEngine instance for specific encoding. | |
| bool | replace_instance (int si_id, const String &sf_uuid) |
| replace an IMEngine instance by a new instance created by another factory. | |
| bool | delete_instance (int id) |
| delete an IMEngine instance according to its id. | |
| void | delete_all_instances () |
| delete all IMEngine instances. | |
| String | get_instance_uuid (int id) const |
| get the factory uuid of this instance. | |
| String | get_instance_encoding (int id) const |
| get the working encoding of an IMEngine instance. | |
| WideString | get_instance_name (int id) const |
| get the name of an IMEngine instance. | |
| WideString | get_instance_authors (int id) const |
| get the authors info of an IMEngine instance. | |
| WideString | get_instance_credits (int id) const |
| get the credits info of an IMEngine instance. | |
| WideString | get_instance_help (int id) const |
| get the help of an IMEngine instance. | |
| String | get_instance_icon_file (int id) const |
| get the icon file of an IMEngine instance. | |
| bool | process_key_event (int id, const KeyEvent &key) const |
| process a key event using specific IMEngine instance. | |
| void | move_preedit_caret (int id, unsigned int pos) const |
| let a specific IMEngine instance move its preedit caret. | |
| void | select_candidate (int id, unsigned int index) const |
| let a specific IMEngine instance select a candidate in its current lookup table. | |
| void | update_lookup_table_page_size (int id, unsigned int page_size) const |
| update the page size of a specific IMEngine instance's lookup table. | |
| void | lookup_table_page_up (int id) const |
| Let a specific IMEngine instance flip its lookup table to the previous page. | |
| void | lookup_table_page_down (int id) const |
| Let a specific IMEngine instance flip its lookup table to the previous page. | |
| void | reset (int id) const |
| reset a specific IMEngine instance. | |
| void | focus_in (int id) const |
| focus in a specific IMEngine instance. | |
| void | focus_out (int id) const |
| focus out a specific IMEngine instance. | |
| void | trigger_property (int id, const String &property) const |
| trigger a property of a specific IMEngine instance. | |
Signal connection methods. | |
These functions are used by FrontEnds to connect their corresponding slots to this BackEnd's signals.
The first parameter of these methods are the id of corresponding instance. | |
| Connection | signal_connect_show_preedit_string (BackEndSlotVoid *slot) |
| Connection | signal_connect_show_aux_string (BackEndSlotVoid *slot) |
| Connection | signal_connect_show_lookup_table (BackEndSlotVoid *slot) |
| Connection | signal_connect_hide_preedit_string (BackEndSlotVoid *slot) |
| Connection | signal_connect_hide_aux_string (BackEndSlotVoid *slot) |
| Connection | signal_connect_hide_lookup_table (BackEndSlotVoid *slot) |
| Connection | signal_connect_update_preedit_caret (BackEndSlotInt *slot) |
| Connection | signal_connect_update_preedit_string (BackEndSlotWideStringAttributeList *slot) |
| Connection | signal_connect_update_aux_string (BackEndSlotWideStringAttributeList *slot) |
| Connection | signal_connect_update_lookup_table (BackEndSlotLookupTable *slot) |
| Connection | signal_connect_commit_string (BackEndSlotWideString *slot) |
| Connection | signal_connect_forward_key_event (BackEndSlotKeyEvent *slot) |
| Connection | signal_connect_register_properties (BackEndSlotPropertyList *slot) |
| Connection | signal_connect_update_property (BackEndSlotProperty *slot) |
Protected Member Functions | |
Methods used by derived classes. | |
| bool | add_factory (const IMEngineFactoryPointer &factory) |
| Add an IMEngineFactory object into BackEnd. | |
| void | set_supported_unicode_locales (const String &locales) |
| Set the list of unicode locales to be supported. | |
| void | destroy_all_factories () |
| Destroy all factory instances. | |
This is mainly a helper 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.
Definition at line 90 of file scim_backend.h.
|
|
Default constructor.
|
|
|
Virtual destructor.
|
|
|
Get a list of all locales supported by all FrontEnds.
|
|
|
Return the number of factories held by this BackEnd.
|
|
|
|
|
||||||||||||
|
Get the IMEngine factories list for specific encoding.
|
|
|
get the name of an IMEngine factory.
|
|
|
get the authors info of an IMEngine factory.
|
|
|
get the credits info of an IMEngine factory.
|
|
|
get the help info of an IMEngine factory.
|
|
|
get the icon file of an IMEngine factory.
|
|
|
get the supported locales of an IMEngine factory.
|
|
|
get the language of an IMEngine factory.
|
|
||||||||||||
|
create a new IMEngine instance for specific encoding.
|
|
||||||||||||
|
replace an IMEngine instance by a new instance created by another factory. This function is used to change the input method for an input context on the fly.
|
|
|
delete an IMEngine instance according to its id.
|
|
|
delete all IMEngine instances. This function should be called just before quitting the FrontEnd. |
|
|
get the factory uuid of this instance.
|
|
|
get the working encoding of an IMEngine instance.
|
|
|
get the name of an IMEngine instance.
|
|
|
get the authors info of an IMEngine instance.
|
|
|
get the credits info of an IMEngine instance.
|
|
|
get the help of an IMEngine instance.
|
|
|
get the icon file of an IMEngine instance.
|
|
||||||||||||
|
process a key event using specific IMEngine instance.
|
|
||||||||||||
|
let a specific IMEngine instance move its preedit caret.
|
|
||||||||||||
|
let a specific IMEngine instance select a candidate in its current lookup table.
|
|
||||||||||||
|
update the page size of a specific IMEngine instance's lookup table.
|
|
|
Let a specific IMEngine instance flip its lookup table to the previous page.
|
|
|
Let a specific IMEngine instance flip its lookup table to the previous page.
|
|
|
reset a specific IMEngine instance.
|
|
|
focus in a specific IMEngine instance.
|
|
|
focus out a specific IMEngine instance.
|
|
||||||||||||
|
trigger a property of a specific IMEngine instance.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Add an IMEngineFactory object into BackEnd.
|
|
|
Set the list of unicode locales to be supported.
|
|
|
Destroy all factory instances.
|
1.3.8