The base class of lookup table.
More...
#include <scim_lookup_table.h>
List of all members.
Detailed Description
The base class of lookup 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 & Destructor Documentation
scim::LookupTable::LookupTable |
( |
int |
page_size = 10 |
) |
|
virtual scim::LookupTable::~LookupTable |
( |
|
) |
[virtual] |
Member Function Documentation
void scim::LookupTable::set_candidate_labels |
( |
const std::vector< WideString > & |
labels |
) |
|
Set the strings to label the candidates in one page.
- Parameters:
-
| labels | - the strings to label the candidates in one page. |
WideString scim::LookupTable::get_candidate_label |
( |
int |
page_index |
) |
const |
Get the label string of a candidate in a page.
- Parameters:
-
| page_index | - the index in a page, 0 to (max page size - 1). |
- Returns:
- the corresponding label of the index.
void scim::LookupTable::set_page_size |
( |
int |
page_size |
) |
|
Set the maximum page size.
- Parameters:
-
| page_size | - the max page size of the table. |
int scim::LookupTable::get_page_size |
( |
|
) |
const |
Get the maximum page size.
- Returns:
- the max page size of the table.
int scim::LookupTable::get_current_page_size |
( |
|
) |
const |
Get current page size,.
- Returns:
- the page size of current page.It can be less than the max page size.
int scim::LookupTable::get_current_page_start |
( |
|
) |
const |
Get the start index of current page.
- Returns:
- the start item index of current page, starting from 0.
bool scim::LookupTable::is_cursor_visible |
( |
|
) |
const |
Check if the cursor is visible.
- Returns:
- true if the cursor should be shown.
bool scim::LookupTable::is_page_size_fixed |
( |
|
) |
const |
Check if the page size is fixed, aka. couldn't reduced by FrontEnd.
- Returns:
- true if the page size shouldn't be reduced by FrontEnd.
int scim::LookupTable::get_cursor_pos |
( |
|
) |
const |
Get current cursor position.
- Returns:
- the cursor position in the table, starting from 0.
int scim::LookupTable::get_cursor_pos_in_current_page |
( |
|
) |
const |
Get the cursor position in current page.
- Returns:
- the cursor position in current page, equals to get_cursor_pos () - get_current_page_start ().
bool scim::LookupTable::page_up |
( |
|
) |
|
Flip to the previous page.
- Returns:
- true if success, false if it's already in the first page.
bool scim::LookupTable::page_down |
( |
|
) |
|
Flip to the next page.
- Returns:
- true if success, false if it's already in the last page.
bool scim::LookupTable::cursor_up |
( |
|
) |
|
Move cursor position to the previous entry.
- Returns:
- true if success, false if it's already at the first entry.
bool scim::LookupTable::cursor_down |
( |
|
) |
|
Move cursor position to the next entry.
- Returns:
- true if success. false if it's already at the last entry.
void scim::LookupTable::show_cursor |
( |
bool |
show = true |
) |
|
Set the cursor visibility.
- Parameters:
-
| show | - true to show the cursor. |
void scim::LookupTable::fix_page_size |
( |
bool |
fixed = true |
) |
|
Set the page size to be fixed, aka. prevent from being changed by FrontEnd.
void scim::LookupTable::set_cursor_pos |
( |
int |
pos |
) |
|
Set the cursor position.
- Parameters:
-
| pos | - the absolute position of the cursor. |
void scim::LookupTable::set_cursor_pos_in_current_page |
( |
int |
pos |
) |
|
Set the cursor position in current page.
- Parameters:
-
| pos | - the relative position of the cursor in current page. |
WideString scim::LookupTable::get_candidate_in_current_page |
( |
int |
page_index |
) |
const |
Get a candidate in current page.
- Parameters:
-
| page_index | - the candidate index in current page. |
- Returns:
- the content of this candidate.
- See also:
- get_candidate
AttributeList scim::LookupTable::get_attributes_in_current_page |
( |
int |
page_index |
) |
const |
Get the display attributes of a candidate in current page.
- Parameters:
-
| page_index | - the index in current page. |
- Returns:
- the AttributeList object holding the attributes of this candidate.
- See also:
- get_attributes
virtual WideString scim::LookupTable::get_candidate |
( |
int |
index |
) |
const [pure virtual] |
Get a candidate.
- Parameters:
-
| index | - the candidate index in the lookup table. |
- Returns:
- the content of this candidate.
Implemented in scim::CommonLookupTable.
virtual AttributeList scim::LookupTable::get_attributes |
( |
int |
index |
) |
const [pure virtual] |
Get the attributes of a candidate.
- Parameters:
-
| index | - the index in the lookup table. |
- Returns:
- the AttributeList object holding the attributes of this candidate.
Implemented in scim::CommonLookupTable.
virtual uint32 scim::LookupTable::number_of_candidates |
( |
|
) |
const [pure virtual] |
Return the number of candidates in this table.
- Returns:
- the number of entries currently in this table.
Implemented in scim::CommonLookupTable.
virtual void scim::LookupTable::clear |
( |
|
) |
[pure virtual] |
The documentation for this class was generated from the following file: