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

scim::ComposeKeyInstance Class Reference
[IMEngine]

#include <scim_compose_key.h>

Inheritance diagram for scim::ComposeKeyInstance:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ComposeKeyInstance (ComposeKeyFactory *factory, const String &encoding, int id=-1)
virtual ~ComposeKeyInstance ()
virtual bool process_key_event (const KeyEvent &key)
 Process a key event.
virtual void move_preedit_caret (unsigned int pos)
 Move the preedit caret in the preedit string.
virtual void select_candidate (unsigned int index)
 Select a candidate in current lookup table.
virtual void update_lookup_table_page_size (unsigned int page_size)
 Update the page size of current lookup table.
virtual void lookup_table_page_up ()
 Flip the lookup table to the previous page.
virtual void lookup_table_page_down ()
 Flip the lookup table to the next page.
virtual void reset ()
 Reset this engine instance.
virtual void focus_in ()
 Focus in this engine instance.
virtual void focus_out ()
 Focus out this engine instance.
virtual void trigger_property (const String &property)
 Trigger a property.

Constructor & Destructor Documentation

scim::ComposeKeyInstance::ComposeKeyInstance ComposeKeyFactory factory,
const String encoding,
int  id = -1
 

virtual scim::ComposeKeyInstance::~ComposeKeyInstance  )  [virtual]
 


Member Function Documentation

virtual bool scim::ComposeKeyInstance::process_key_event const KeyEvent key  )  [virtual]
 

Process a key event.

Parameters:
key - the key event to be processed.
Returns:
true if the event is processed, otherwise the event is not processed and should be forward to client application.

Implements scim::IMEngineInstanceBase.

virtual void scim::ComposeKeyInstance::move_preedit_caret unsigned int  pos  )  [virtual]
 

Move the preedit caret in the preedit string.

Parameters:
pos - the new position that user requested.

Reimplemented from scim::IMEngineInstanceBase.

virtual void scim::ComposeKeyInstance::select_candidate unsigned int  index  )  [virtual]
 

Select a candidate in current lookup table.

When user click a candidate directly, this method will be invoked by FrontEnd.

Parameters:
index - the index in current page of the selected candidate.

Reimplemented from scim::IMEngineInstanceBase.

virtual void scim::ComposeKeyInstance::update_lookup_table_page_size unsigned int  page_size  )  [virtual]
 

Update the page size of current lookup table.

In the next time, the lookup table should page down by this size.

Parameters:
page_size - the new size of current page.

Reimplemented from scim::IMEngineInstanceBase.

virtual void scim::ComposeKeyInstance::lookup_table_page_up  )  [virtual]
 

Flip the lookup table to the previous page.

The method will be invoked by FrontEnd when user click the lookup table page up button.

Reimplemented from scim::IMEngineInstanceBase.

virtual void scim::ComposeKeyInstance::lookup_table_page_down  )  [virtual]
 

Flip the lookup table to the next page.

The method will be invoked by FrontEnd when user click the lookup table page down button.

Reimplemented from scim::IMEngineInstanceBase.

virtual void scim::ComposeKeyInstance::reset  )  [virtual]
 

Reset this engine instance.

All status of this engine instance should be reset, including the working encoding.

Reimplemented from scim::IMEngineInstanceBase.

virtual void scim::ComposeKeyInstance::focus_in  )  [virtual]
 

Focus in this engine instance.

This function should update/show/hide the status area, preedit area and lookup table, and update the full width punctuation/letter state.

Reimplemented from scim::IMEngineInstanceBase.

virtual void scim::ComposeKeyInstance::focus_out  )  [virtual]
 

Focus out this engine instance.

Reimplemented from scim::IMEngineInstanceBase.

virtual void scim::ComposeKeyInstance::trigger_property const String property  )  [virtual]
 

Trigger a property.

This function should do some action according to the triggered property. For example toggle the input mode, etc.

Parameters:
property the key of the triggered property.

Reimplemented from scim::IMEngineInstanceBase.


The documentation for this class was generated from the following file:
Generated on Sat Mar 12 01:15:46 2005 for scim by doxygen 1.3.8