skk_candidate_list_get ()

SkkCandidate *
skk_candidate_list_get (SkkCandidateList *self,
                        gint index);

Get the current candidate at the given index.

skk_candidate_list_cursor_up ()

gboolean
skk_candidate_list_cursor_up (SkkCandidateList *self);

Move cursor to the previous candidate.

skk_candidate_list_cursor_down ()

gboolean
skk_candidate_list_cursor_down (SkkCandidateList *self);

Move cursor to the next candidate.

skk_candidate_list_page_up ()

gboolean
skk_candidate_list_page_up (SkkCandidateList *self);

Move cursor to the previous page.

skk_candidate_list_page_down ()

gboolean
skk_candidate_list_page_down (SkkCandidateList *self);

Move cursor to the next page.

skk_candidate_list_next ()

gboolean
skk_candidate_list_next (SkkCandidateList *self);

Move cursor forward.

skk_candidate_list_previous ()

gboolean
skk_candidate_list_previous (SkkCandidateList *self);

Move cursor backward.

skk_candidate_list_select_at ()

gboolean
skk_candidate_list_select_at (SkkCandidateList *self,
                              guint index_in_page);

Select a candidate in the current page.

skk_candidate_list_select ()

void
skk_candidate_list_select (SkkCandidateList *self);

Select the current candidate.

skk_candidate_list_get_cursor_pos ()

gint
skk_candidate_list_get_cursor_pos (SkkCandidateList *self);

Get and return the current value of the "cursor-pos" property.

Current cursor position.

skk_candidate_list_get_size ()

gint
skk_candidate_list_get_size (SkkCandidateList *self);

Get and return the current value of the "size" property.

The number of candidate in the candidate list.

skk_candidate_list_get_page_start ()

guint
skk_candidate_list_get_page_start (SkkCandidateList *self);

Get and return the current value of the "page-start" property.

Starting index of paging.

skk_candidate_list_set_page_start ()

void
skk_candidate_list_set_page_start (SkkCandidateList *self,
                                   guint value);

Set the value of the "page-start" property to value .

Starting index of paging.

skk_candidate_list_get_page_size ()

guint
skk_candidate_list_get_page_size (SkkCandidateList *self);

Get and return the current value of the "page-size" property.

Page size.

skk_candidate_list_set_page_size ()

void
skk_candidate_list_set_page_size (SkkCandidateList *self,
                                  guint value);

Set the value of the "page-size" property to value .

Page size.

skk_candidate_list_get_page_visible ()

gboolean
skk_candidate_list_get_page_visible (SkkCandidateList *self);

Get and return the current value of the "page-visible" property.

Flag to indicate whether page (lookup table) is visible.

SKK_TYPE_CANDIDATE_LIST

#define SKK_TYPE_CANDIDATE_LIST (skk_candidate_list_get_type ())

The type for SkkCandidateList.

struct SkkCandidateList

struct SkkCandidateList;

Base abstract class of candidate list.

struct SkkCandidateListClass

struct SkkCandidateListClass {
	GObjectClass parent_class;
	SkkCandidate* (*get) (SkkCandidateList* self, gint index);
	void (*clear) (SkkCandidateList* self);
	void (*add_candidates) (SkkCandidateList* self, SkkCandidate** array, gint 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 “cursor-pos” property

  “cursor-pos”               gint

Current cursor position.

Owner: SkkCandidateList

Flags: Read

Default value: 0

The “page-size” property

  “page-size”                guint

Page size.

Owner: SkkCandidateList

Flags: Read / Write

Default value: 0

The “page-start” property

  “page-start”               guint

Starting index of paging.

Owner: SkkCandidateList

Flags: Read / Write

Default value: 0

The “page-visible” property

  “page-visible”             gboolean

Flag to indicate whether page (lookup table) is visible.

Owner: SkkCandidateList

Flags: Read

Default value: FALSE

The “size” property

  “size”                     gint

The number of candidate in the candidate list.

Owner: SkkCandidateList

Flags: Read

Default value: 0

The “populated” signal

void
user_function (SkkCandidateList *candidate_list,
               gpointer          user_data)

Signal emitted when candidates are filled and ready for traversal.

Flags: Run Last

The “selected” signal

void
user_function (SkkCandidateList *candidate_list,
               SkkCandidate     *candidate,
               gpointer          user_data)

Signal emitted when a candidate is selected.

Flags: Run Last