#include <scim_lookup_table.h>
Inheritance diagram for scim::LookupTable:
Public Member Functions | |
LookupTable (int page_size=10) | |
Constructor. | |
virtual | ~LookupTable () |
Virtual destructor. | |
void | set_candidate_labels (const std::vector< WideString > &labels) |
Set the strings to label the candidates in one page. | |
WideString | get_candidate_label (int page_index) const |
Get the label string of a candidate in a page. | |
void | set_page_size (int page_size) |
Set the maximum page size. | |
int | get_page_size () const |
Get the maximum page size. | |
int | get_current_page_size () const |
Get current page size,. | |
int | get_current_page_start () const |
Get the start index of current page. | |
bool | is_cursor_visible () const |
Check if the cursor is visible. | |
int | get_cursor_pos () const |
Get current cursor position. | |
int | get_cursor_pos_in_current_page () const |
Get the cursor position in current page. | |
bool | page_up () |
Flip to the previous page. | |
bool | page_down () |
Flip to the next page. | |
bool | cursor_up () |
Move cursor position to the previous entry. | |
bool | cursor_down () |
Move cursor position to the next entry. | |
void | show_cursor (bool show=true) |
Set the cursor visibility. | |
void | set_cursor_pos (int pos) |
Set the cursor position. | |
void | set_cursor_pos_in_current_page (int pos) |
Set the cursor position in current page. | |
WideString | get_candidate_in_current_page (int page_index) const |
Get a candidate in current page. | |
AttributeList | get_attributes_in_current_page (int page_index) const |
Get the display attributes of a candidate in current page. | |
Pure Virtual functions. | |
These functions should be implemented in derivation classes. | |
virtual WideString | get_candidate (int index) const =0 |
Get a candidate. | |
virtual AttributeList | get_attributes (int index) const =0 |
Get the attributes of a candidate. | |
virtual uint32 | number_of_candidates () const =0 |
Return the number of candidates in this table. | |
virtual void | clear ()=0 |
Clear the table. |
LookupTable is used to store the candidate phrases, it provides a easy way to manage the content of candidates and flip between multiple pages.
It also can manage the attributes for each candidate string.
This is abstract class and cannot store data. IMEngine should use its derivation class. This class is the interface that uses within FrontEnd class.
|
Constructor.
|
|
Virtual destructor.
|
|
Set the strings to label the candidates in one page.
|
|
Get the label string of a candidate in a page.
|
|
Set the maximum page size.
|
|
Get the maximum page size.
|
|
Get current page size,.
|
|
Get the start index of current page.
|
|
Check if the cursor is visible.
|
|
Get current cursor position.
|
|
Get the cursor position in current page.
|
|
Flip to the previous page.
|
|
Flip to the next page.
|
|
Move cursor position to the previous entry.
|
|
Move cursor position to the next entry.
|
|
Set the cursor visibility.
|
|
Set the cursor position.
|
|
Set the cursor position in current page.
|
|
Get a candidate in current page.
|
|
Get the display attributes of a candidate in current page.
|
|
Get a candidate.
Implemented in scim::CommonLookupTable. |
|
Get the attributes of a candidate.
Implemented in scim::CommonLookupTable. |
|
Return the number of candidates in this table.
Implemented in scim::CommonLookupTable. |
|
Clear the table.
Implemented in scim::CommonLookupTable. |