#include <scim_frontend.h>
Inheritance diagram for scim::FrontEndBase:
Public Member Functions | |
FrontEndBase (const BackEndPointer &backend) | |
Constructor. | |
virtual | ~FrontEndBase () |
Virtual destructor. | |
virtual void | init (int argc, char **argv)=0 |
init the frontend. | |
virtual void | run ()=0 |
run the frontend. | |
Protected Member Functions | |
functions can be used by derived classes. | |
uint32 | get_factory_list (std::vector< String > &uuids, const String &encoding) 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. | |
String | get_all_locales () const |
get all locales supported by BackEnd. | |
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_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. | |
Pure virtual protected methods. | |
The following methods should be implemented by derivation classes. these functions handle the real things. | |
virtual void | show_preedit_string (int id)=0 |
show preedit string area for an IMEngine instance. | |
virtual void | show_aux_string (int id)=0 |
show aux string area for an IMEngine instance. | |
virtual void | show_lookup_table (int id)=0 |
show lookup table area for an IMEngine instance. | |
virtual void | hide_preedit_string (int id)=0 |
hide preedit string area for an IMEngine instance. | |
virtual void | hide_aux_string (int id)=0 |
hide aux string area for an IMEngine instance. | |
virtual void | hide_lookup_table (int id)=0 |
hide lookup table area for an IMEngine instance. | |
virtual void | update_preedit_caret (int id, int caret)=0 |
update the position of preedit caret for an IMEngine instance. | |
virtual void | update_preedit_string (int id, const WideString &str, const AttributeList &attrs)=0 |
update the content of preedit string for an IMEngine instance. | |
virtual void | update_aux_string (int id, const WideString &str, const AttributeList &attrs)=0 |
update the content of aux string for an IMEngine instance. | |
virtual void | update_lookup_table (int id, const LookupTable &table)=0 |
update the content of lookup table for an IMEngine instance. | |
virtual void | commit_string (int id, const WideString &str)=0 |
commit a string to client for an IMEngine instance. | |
virtual void | forward_key_event (int id, const KeyEvent &key)=0 |
forward a keyevent to the client of an IMEngine instance. | |
virtual void | register_properties (int id, const PropertyList &properties)=0 |
register all the properties of an IMEngine instance into this FrontEnd. | |
virtual void | update_property (int id, const Property &property)=0 |
update a property of an IMEngine instance. |
FrontEnd is an interface between IMEngineFactory/IMEngineInstance objects and the user applications. It forward the user requests to IMEngineFactory/IMEngineInstance objects, and handle the requests sent back.
Definition at line 73 of file scim_frontend.h.
|
Constructor.
|
|
Virtual destructor.
|
|
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.
|
|
get all locales supported by BackEnd.
|
|
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 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.
|
|
show preedit string area for an IMEngine instance.
|
|
show aux string area for an IMEngine instance.
|
|
show lookup table area for an IMEngine instance.
|
|
hide preedit string area for an IMEngine instance.
|
|
hide aux string area for an IMEngine instance.
|
|
hide lookup table area for an IMEngine instance.
|
|
update the position of preedit caret for an IMEngine instance.
|
|
update the content of preedit string for an IMEngine instance.
|
|
update the content of aux string for an IMEngine instance.
|
|
update the content of lookup table for an IMEngine instance.
|
|
commit a string to client for an IMEngine instance.
|
|
forward a keyevent to the client of an IMEngine instance.
|
|
register all the properties of an IMEngine instance into this FrontEnd.
|
|
update a property of an IMEngine instance.
|
|
init the frontend. This method must be implemented by derivation classes. |
|
run the frontend. This method must be implemented by derivation classes. |