![]() |
![]() |
![]() |
libskk Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties | Signals |
#define SKK_TYPE_CANDIDATE_LIST SkkCandidate * skk_candidate_list_get (SkkCandidateList *self
,gint index
); gboolean skk_candidate_list_cursor_up (SkkCandidateList *self
); gboolean skk_candidate_list_cursor_down (SkkCandidateList *self
); gboolean skk_candidate_list_page_up (SkkCandidateList *self
); gboolean skk_candidate_list_page_down (SkkCandidateList *self
); gboolean skk_candidate_list_next (SkkCandidateList *self
); gboolean skk_candidate_list_previous (SkkCandidateList *self
); guint skk_candidate_list_get_page_start_cursor_pos (SkkCandidateList *self
); gboolean skk_candidate_list_select_at (SkkCandidateList *self
,guint index_in_page
); void skk_candidate_list_select (SkkCandidateList *self
); gint skk_candidate_list_get_cursor_pos (SkkCandidateList *self
); gint skk_candidate_list_get_size (SkkCandidateList *self
); guint skk_candidate_list_get_page_start (SkkCandidateList *self
); void skk_candidate_list_set_page_start (SkkCandidateList *self
,guint value
); guint skk_candidate_list_get_page_size (SkkCandidateList *self
); void skk_candidate_list_set_page_size (SkkCandidateList *self
,guint value
); gboolean skk_candidate_list_get_page_visible (SkkCandidateList *self
); struct SkkCandidateList; struct SkkCandidateListClass;
"cursor-pos" gint : Read "page-size" guint : Read / Write "page-start" guint : Read / Write "page-visible" gboolean : Read "size" gint : Read
#define SKK_TYPE_CANDIDATE_LIST (skk_candidate_list_get_type ())
The type for SkkCandidateList.
SkkCandidate * skk_candidate_list_get (SkkCandidateList *self
,gint index
);
Get the current candidate at the given index.
|
the SkkCandidateList instance |
|
candidate position (-1 for the current cursor position). [in] |
Returns : |
a Candidate |
gboolean skk_candidate_list_cursor_up (SkkCandidateList *self
);
Move cursor to the previous candidate.
|
the SkkCandidateList instance |
Returns : |
`true` if cursor position has changed, `false` otherwise. |
gboolean skk_candidate_list_cursor_down (SkkCandidateList *self
);
Move cursor to the next candidate.
|
the SkkCandidateList instance |
Returns : |
`true` if cursor position has changed, `false` otherwise |
gboolean skk_candidate_list_page_up (SkkCandidateList *self
);
Move cursor to the previous page.
|
the SkkCandidateList instance |
Returns : |
`true` if cursor position has changed, `false` otherwise |
gboolean skk_candidate_list_page_down (SkkCandidateList *self
);
Move cursor to the next page.
|
the SkkCandidateList instance |
Returns : |
`true` if cursor position has changed, `false` otherwise |
gboolean skk_candidate_list_next (SkkCandidateList *self
);
Move cursor forward.
|
the SkkCandidateList instance |
Returns : |
`true` if cursor position has changed, `false` otherwise |
gboolean skk_candidate_list_previous (SkkCandidateList *self
);
Move cursor backward.
|
the SkkCandidateList instance |
Returns : |
`true` if cursor position has changed, `false` otherwise |
guint skk_candidate_list_get_page_start_cursor_pos
(SkkCandidateList *self
);
Return cursor position of the beginning of the current page.
|
the SkkCandidateList instance |
Returns : |
cursor position |
gboolean skk_candidate_list_select_at (SkkCandidateList *self
,guint index_in_page
);
Select a candidate in the current page.
|
the SkkCandidateList instance |
|
cursor position in the page to select. [in] |
Returns : |
`true` if a candidate is selected, `false` otherwise |
void skk_candidate_list_select (SkkCandidateList *self
);
Select the current candidate.
|
the SkkCandidateList instance |
gint skk_candidate_list_get_cursor_pos (SkkCandidateList *self
);
Get and return the current value of the "cursor-pos" property.
|
the SkkCandidateList instance to query |
Returns : |
the value of the "cursor-pos" property |
gint skk_candidate_list_get_size (SkkCandidateList *self
);
Get and return the current value of the "size" property.
|
the SkkCandidateList instance to query |
Returns : |
the value of the "size" property |
guint skk_candidate_list_get_page_start (SkkCandidateList *self
);
Get and return the current value of the "page-start" property.
|
the SkkCandidateList instance to query |
Returns : |
the value of the "page-start" property |
void skk_candidate_list_set_page_start (SkkCandidateList *self
,guint value
);
Set the value of the "page-start" property to value
.
|
the SkkCandidateList instance to modify |
|
the new value of the "page-start" property |
guint skk_candidate_list_get_page_size (SkkCandidateList *self
);
Get and return the current value of the "page-size" property.
|
the SkkCandidateList instance to query |
Returns : |
the value of the "page-size" property |
void skk_candidate_list_set_page_size (SkkCandidateList *self
,guint value
);
Set the value of the "page-size" property to value
.
|
the SkkCandidateList instance to modify |
|
the new value of the "page-size" property |
gboolean skk_candidate_list_get_page_visible (SkkCandidateList *self
);
Get and return the current value of the "page-visible" property.
|
the SkkCandidateList instance to query |
Returns : |
the value of the "page-visible" property |
struct SkkCandidateListClass { GObjectClass parent_class; SkkCandidate* (*get) (SkkCandidateList* self, gint index); void (*clear) (SkkCandidateList* self); void (*add_candidates) (SkkCandidateList* self, SkkCandidate** array, int array_length1); void (*add_candidates_end) (SkkCandidateList* self); gboolean (*cursor_up) (SkkCandidateList* self); gboolean (*cursor_down) (SkkCandidateList* self); gboolean (*page_up) (SkkCandidateList* self); gboolean (*page_down) (SkkCandidateList* self); gboolean (*next) (SkkCandidateList* self); gboolean (*previous) (SkkCandidateList* self); gboolean (*select_at) (SkkCandidateList* self, guint index_in_page); void (*select) (SkkCandidateList* self); gint (*get_cursor_pos) (SkkCandidateList* self); gint (*get_size) (SkkCandidateList* self); guint (*get_page_start) (SkkCandidateList* self); void (*set_page_start) (SkkCandidateList* self, guint value); guint (*get_page_size) (SkkCandidateList* self); void (*set_page_size) (SkkCandidateList* self, guint value); gboolean (*get_page_visible) (SkkCandidateList* self); };
The class structure for SKK_TYPE_CANDIDATE_LIST
. All the fields in this structure are private and should never be accessed directly.
the parent class structure | |
virtual method called by skk_candidate_list_cursor_up()
|
|
virtual method called by skk_candidate_list_cursor_down()
|
|
virtual method called by skk_candidate_list_page_up()
|
|
virtual method called by skk_candidate_list_page_down()
|
|
virtual method called by skk_candidate_list_next()
|
|
virtual method called by skk_candidate_list_previous()
|
|
virtual method called by skk_candidate_list_select_at()
|
|
virtual method called by skk_candidate_list_select()
|
|
getter method for the abstract property "cursor-pos" | |
getter method for the abstract property "size" | |
getter method for the abstract property "page-start" | |
setter method for the abstract property "page-start" | |
getter method for the abstract property "page-size" | |
setter method for the abstract property "page-size" | |
getter method for the abstract property "page-visible" |
"page-start"
property "page-start" guint : Read / Write
Starting index of paging.
Default value: 0
"page-visible"
property "page-visible" gboolean : Read
Flag to indicate whether page (lookup table) is visible.
Default value: FALSE
"populated"
signalvoid user_function (SkkCandidateList *candidate_list,
gpointer user_data) : Run Last
Signal emitted when candidates are filled and ready for traversal.
|
the SkkCandidateList instance that received the signal |
|
user data set when the signal handler was connected. |
"selected"
signalvoid user_function (SkkCandidateList *candidate_list,
SkkCandidate *candidate,
gpointer user_data) : Run Last
Signal emitted when a candidate is selected.
|
the SkkCandidateList instance that received the signal |
|
selected candidate |
|
user data set when the signal handler was connected. |