KkcDBusCandidateList

KkcDBusCandidateList

Functions

gboolean kkc_dbus_candidate_list_select_at ()
void kkc_dbus_candidate_list_select ()
gboolean kkc_dbus_candidate_list_first ()
gboolean kkc_dbus_candidate_list_next ()
gboolean kkc_dbus_candidate_list_previous ()
gboolean kkc_dbus_candidate_list_cursor_up ()
gboolean kkc_dbus_candidate_list_cursor_down ()
gboolean kkc_dbus_candidate_list_page_up ()
gboolean kkc_dbus_candidate_list_page_down ()
void kkc_dbus_candidate_list_get ()
KkcDBusCandidateList * kkc_dbus_candidate_list_new ()
gint kkc_dbus_candidate_list_get_cursor_pos ()
gint kkc_dbus_candidate_list_get_size ()
guint kkc_dbus_candidate_list_get_page_start ()
guint kkc_dbus_candidate_list_get_page_size ()
gboolean kkc_dbus_candidate_list_get_round ()
gboolean kkc_dbus_candidate_list_get_page_visible ()
void kkc_dbus_segment_list_get ()
gboolean kkc_dbus_segment_list_first_segment ()
gboolean kkc_dbus_segment_list_last_segment ()
void kkc_dbus_segment_list_next_segment ()
void kkc_dbus_segment_list_previous_segment ()
gchar * kkc_dbus_segment_list_get_output ()
gchar * kkc_dbus_segment_list_get_input ()
KkcDBusSegmentList * kkc_dbus_segment_list_new ()
gint kkc_dbus_segment_list_get_cursor_pos ()
gint kkc_dbus_segment_list_get_size ()
gboolean kkc_dbus_context_process_key_event ()
gboolean kkc_dbus_context_process_command_event ()
void kkc_dbus_context_reset ()
gboolean kkc_dbus_context_has_output ()
gchar * kkc_dbus_context_peek_output ()
gchar * kkc_dbus_context_poll_output ()
void kkc_dbus_context_clear_output ()
KkcDBusContext * kkc_dbus_context_new ()
gchar * kkc_dbus_context_get_input ()
gint kkc_dbus_context_get_input_cursor_pos ()
guint kkc_dbus_context_get_input_mode ()
void kkc_dbus_context_set_input_mode ()
guint kkc_dbus_context_get_punctuation_style ()
void kkc_dbus_context_set_punctuation_style ()
gboolean kkc_dbus_context_get_auto_correct ()
void kkc_dbus_context_set_auto_correct ()
gchar * kkc_dbus_server_create_context ()
void kkc_dbus_server_destroy_context ()
KkcDBusServer * kkc_dbus_server_new ()

Properties

gint cursor-pos Read
guint page-size Read
guint page-start Read
gboolean page-visible Read
gboolean round Read
gint size Read
gint cursor-pos Read
gint size Read
gboolean auto-correct Read / Write
gchar * input Read
gint input-cursor-pos Read
guint input-mode Read / Write
guint punctuation-style Read / Write

Signals

void populated Run Last
void selected Run Last

Types and Values

Object Hierarchy

    GObject
    ├── KkcDBusCandidateList
    ├── KkcDBusContext
    ├── KkcDBusSegmentList
    ╰── KkcDBusServer

Description

Functions

kkc_dbus_candidate_list_select_at ()

gboolean
kkc_dbus_candidate_list_select_at (KkcDBusCandidateList *self,
                                   guint index_in_page);

Parameters

self

the KkcDBusCandidateList instance

 

index_in_page

 

 

kkc_dbus_candidate_list_select ()

void
kkc_dbus_candidate_list_select (KkcDBusCandidateList *self);

Parameters

self

the KkcDBusCandidateList instance

 

kkc_dbus_candidate_list_first ()

gboolean
kkc_dbus_candidate_list_first (KkcDBusCandidateList *self);

Parameters

self

the KkcDBusCandidateList instance

 

kkc_dbus_candidate_list_next ()

gboolean
kkc_dbus_candidate_list_next (KkcDBusCandidateList *self);

Parameters

self

the KkcDBusCandidateList instance

 

kkc_dbus_candidate_list_previous ()

gboolean
kkc_dbus_candidate_list_previous (KkcDBusCandidateList *self);

Parameters

self

the KkcDBusCandidateList instance

 

kkc_dbus_candidate_list_cursor_up ()

gboolean
kkc_dbus_candidate_list_cursor_up (KkcDBusCandidateList *self);

Parameters

self

the KkcDBusCandidateList instance

 

kkc_dbus_candidate_list_cursor_down ()

gboolean
kkc_dbus_candidate_list_cursor_down (KkcDBusCandidateList *self);

Parameters

self

the KkcDBusCandidateList instance

 

kkc_dbus_candidate_list_page_up ()

gboolean
kkc_dbus_candidate_list_page_up (KkcDBusCandidateList *self);

Parameters

self

the KkcDBusCandidateList instance

 

kkc_dbus_candidate_list_page_down ()

gboolean
kkc_dbus_candidate_list_page_down (KkcDBusCandidateList *self);

Parameters

self

the KkcDBusCandidateList instance

 

kkc_dbus_candidate_list_get ()

void
kkc_dbus_candidate_list_get (KkcDBusCandidateList *self,
                             gint index,
                             gchar * *midasi,
                             gboolean *okuri,
                             gchar * *text,
                             gchar * *annotation);

Parameters

self

the KkcDBusCandidateList instance

 

index

 

 

midasi

 

 

okuri

 

 

text

 

 

annotation

 

 

kkc_dbus_candidate_list_new ()

KkcDBusCandidateList *
kkc_dbus_candidate_list_new (GDBusConnection *connection,
                             const gchar *object_path,
                             KkcCandidateList *candidates);

Parameters

connection

 

 

object_path

 

 

candidates

 

 

kkc_dbus_candidate_list_get_cursor_pos ()

gint
kkc_dbus_candidate_list_get_cursor_pos
                               (KkcDBusCandidateList *self);

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

Parameters

self

the KkcDBusCandidateList instance to query

 

Returns

the value of the "cursor-pos" property


kkc_dbus_candidate_list_get_size ()

gint
kkc_dbus_candidate_list_get_size (KkcDBusCandidateList *self);

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

Parameters

self

the KkcDBusCandidateList instance to query

 

Returns

the value of the "size" property


kkc_dbus_candidate_list_get_page_start ()

guint
kkc_dbus_candidate_list_get_page_start
                               (KkcDBusCandidateList *self);

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

Parameters

self

the KkcDBusCandidateList instance to query

 

Returns

the value of the "page-start" property


kkc_dbus_candidate_list_get_page_size ()

guint
kkc_dbus_candidate_list_get_page_size (KkcDBusCandidateList *self);

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

Parameters

self

the KkcDBusCandidateList instance to query

 

Returns

the value of the "page-size" property


kkc_dbus_candidate_list_get_round ()

gboolean
kkc_dbus_candidate_list_get_round (KkcDBusCandidateList *self);

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

Parameters

self

the KkcDBusCandidateList instance to query

 

Returns

the value of the "round" property


kkc_dbus_candidate_list_get_page_visible ()

gboolean
kkc_dbus_candidate_list_get_page_visible
                               (KkcDBusCandidateList *self);

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

Parameters

self

the KkcDBusCandidateList instance to query

 

Returns

the value of the "page-visible" property


kkc_dbus_segment_list_get ()

void
kkc_dbus_segment_list_get (KkcDBusSegmentList *self,
                           gint index,
                           gchar * *input,
                           gchar * *output);

Parameters

self

the KkcDBusSegmentList instance

 

index

 

 

input

 

 

output

 

 

kkc_dbus_segment_list_first_segment ()

gboolean
kkc_dbus_segment_list_first_segment (KkcDBusSegmentList *self);

Parameters

self

the KkcDBusSegmentList instance

 

kkc_dbus_segment_list_last_segment ()

gboolean
kkc_dbus_segment_list_last_segment (KkcDBusSegmentList *self);

Parameters

self

the KkcDBusSegmentList instance

 

kkc_dbus_segment_list_next_segment ()

void
kkc_dbus_segment_list_next_segment (KkcDBusSegmentList *self);

Parameters

self

the KkcDBusSegmentList instance

 

kkc_dbus_segment_list_previous_segment ()

void
kkc_dbus_segment_list_previous_segment
                               (KkcDBusSegmentList *self);

Parameters

self

the KkcDBusSegmentList instance

 

kkc_dbus_segment_list_get_output ()

gchar *
kkc_dbus_segment_list_get_output (KkcDBusSegmentList *self);

Parameters

self

the KkcDBusSegmentList instance

 

kkc_dbus_segment_list_get_input ()

gchar *
kkc_dbus_segment_list_get_input (KkcDBusSegmentList *self);

Parameters

self

the KkcDBusSegmentList instance

 

kkc_dbus_segment_list_new ()

KkcDBusSegmentList *
kkc_dbus_segment_list_new (GDBusConnection *connection,
                           const gchar *object_path,
                           KkcSegmentList *segments);

Parameters

connection

 

 

object_path

 

 

segments

 

 

kkc_dbus_segment_list_get_cursor_pos ()

gint
kkc_dbus_segment_list_get_cursor_pos (KkcDBusSegmentList *self);

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

Parameters

self

the KkcDBusSegmentList instance to query

 

Returns

the value of the "cursor-pos" property


kkc_dbus_segment_list_get_size ()

gint
kkc_dbus_segment_list_get_size (KkcDBusSegmentList *self);

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

Parameters

self

the KkcDBusSegmentList instance to query

 

Returns

the value of the "size" property


kkc_dbus_context_process_key_event ()

gboolean
kkc_dbus_context_process_key_event (KkcDBusContext *self,
                                    guint keyval,
                                    guint keycode,
                                    guint modifiers);

Parameters

self

the KkcDBusContext instance

 

keyval

 

 

keycode

 

 

modifiers

 

 

kkc_dbus_context_process_command_event ()

gboolean
kkc_dbus_context_process_command_event
                               (KkcDBusContext *self,
                                const gchar *command);

Parameters

self

the KkcDBusContext instance

 

command

 

 

kkc_dbus_context_reset ()

void
kkc_dbus_context_reset (KkcDBusContext *self);

Parameters

self

the KkcDBusContext instance

 

kkc_dbus_context_has_output ()

gboolean
kkc_dbus_context_has_output (KkcDBusContext *self);

Parameters

self

the KkcDBusContext instance

 

kkc_dbus_context_peek_output ()

gchar *
kkc_dbus_context_peek_output (KkcDBusContext *self);

Parameters

self

the KkcDBusContext instance

 

kkc_dbus_context_poll_output ()

gchar *
kkc_dbus_context_poll_output (KkcDBusContext *self);

Parameters

self

the KkcDBusContext instance

 

kkc_dbus_context_clear_output ()

void
kkc_dbus_context_clear_output (KkcDBusContext *self);

Parameters

self

the KkcDBusContext instance

 

kkc_dbus_context_new ()

KkcDBusContext *
kkc_dbus_context_new (GDBusConnection *connection,
                      const gchar *object_path,
                      KkcContext *context);

Parameters

connection

 

 

object_path

 

 

context

 

 

kkc_dbus_context_get_input ()

gchar *
kkc_dbus_context_get_input (KkcDBusContext *self);

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

Parameters

self

the KkcDBusContext instance to query

 

Returns

the value of the "input" property


kkc_dbus_context_get_input_cursor_pos ()

gint
kkc_dbus_context_get_input_cursor_pos (KkcDBusContext *self);

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

Parameters

self

the KkcDBusContext instance to query

 

Returns

the value of the "input-cursor-pos" property


kkc_dbus_context_get_input_mode ()

guint
kkc_dbus_context_get_input_mode (KkcDBusContext *self);

Get and return the current value of the "input-mode" property.

Parameters

self

the KkcDBusContext instance to query

 

Returns

the value of the "input-mode" property


kkc_dbus_context_set_input_mode ()

void
kkc_dbus_context_set_input_mode (KkcDBusContext *self,
                                 guint value);

Set the value of the "input-mode" property to value .

Parameters

self

the KkcDBusContext instance to modify

 

value

the new value of the "input-mode" property

 

kkc_dbus_context_get_punctuation_style ()

guint
kkc_dbus_context_get_punctuation_style
                               (KkcDBusContext *self);

Get and return the current value of the "punctuation-style" property.

Parameters

self

the KkcDBusContext instance to query

 

Returns

the value of the "punctuation-style" property


kkc_dbus_context_set_punctuation_style ()

void
kkc_dbus_context_set_punctuation_style
                               (KkcDBusContext *self,
                                guint value);

Set the value of the "punctuation-style" property to value .

Parameters

self

the KkcDBusContext instance to modify

 

value

the new value of the "punctuation-style" property

 

kkc_dbus_context_get_auto_correct ()

gboolean
kkc_dbus_context_get_auto_correct (KkcDBusContext *self);

Get and return the current value of the "auto-correct" property.

Parameters

self

the KkcDBusContext instance to query

 

Returns

the value of the "auto-correct" property


kkc_dbus_context_set_auto_correct ()

void
kkc_dbus_context_set_auto_correct (KkcDBusContext *self,
                                   gboolean value);

Set the value of the "auto-correct" property to value .

Parameters

self

the KkcDBusContext instance to modify

 

value

the new value of the "auto-correct" property

 

kkc_dbus_server_create_context ()

gchar *
kkc_dbus_server_create_context (KkcDBusServer *self,
                                const char *sender);

Parameters

self

the KkcDBusServer instance

 

sender

 

 

kkc_dbus_server_destroy_context ()

void
kkc_dbus_server_destroy_context (KkcDBusServer *self,
                                 const gchar *object_path);

Parameters

self

the KkcDBusServer instance

 

object_path

 

 

kkc_dbus_server_new ()

KkcDBusServer *
kkc_dbus_server_new (GDBusConnection *connection,
                     KkcLanguageModel *model,
                     KkcDictionaryList *dictionaries,
                     KkcRule *typing_rule);

Parameters

connection

 

 

model

 

 

dictionaries

 

 

typing_rule

 

 

Types and Values

KKC_TYPE_DBUS_CANDIDATE_LIST

#define KKC_TYPE_DBUS_CANDIDATE_LIST (kkc_dbus_candidate_list_get_type ())

The type for KkcDBusCandidateList.


struct KkcDBusCandidateList

struct KkcDBusCandidateList;

struct KkcDBusCandidateListClass

struct KkcDBusCandidateListClass {
	GObjectClass parent_class;
};

The class structure for KKC_TYPE_DBUS_CANDIDATE_LIST. All the fields in this structure are private and should never be accessed directly.

Members


KKC_TYPE_DBUS_SEGMENT_LIST

#define KKC_TYPE_DBUS_SEGMENT_LIST (kkc_dbus_segment_list_get_type ())

The type for KkcDBusSegmentList.


struct KkcDBusSegmentList

struct KkcDBusSegmentList;

struct KkcDBusSegmentListClass

struct KkcDBusSegmentListClass {
	GObjectClass parent_class;
};

The class structure for KKC_TYPE_DBUS_SEGMENT_LIST. All the fields in this structure are private and should never be accessed directly.

Members


KKC_TYPE_DBUS_CONTEXT

#define KKC_TYPE_DBUS_CONTEXT (kkc_dbus_context_get_type ())

The type for KkcDBusContext.


struct KkcDBusContext

struct KkcDBusContext;

struct KkcDBusContextClass

struct KkcDBusContextClass {
	GObjectClass parent_class;
};

The class structure for KKC_TYPE_DBUS_CONTEXT. All the fields in this structure are private and should never be accessed directly.

Members


KKC_TYPE_DBUS_SERVER

#define KKC_TYPE_DBUS_SERVER (kkc_dbus_server_get_type ())

The type for KkcDBusServer.


struct KkcDBusServer

struct KkcDBusServer;

struct KkcDBusServerClass

struct KkcDBusServerClass {
	GObjectClass parent_class;
};

The class structure for KKC_TYPE_DBUS_SERVER. All the fields in this structure are private and should never be accessed directly.

Members

Property Details

The “cursor-pos” property

  “cursor-pos”               gint

cursor-pos.

Flags: Read

Default value: 0


The “page-size” property

  “page-size”                guint

page-size.

Flags: Read

Default value: 0


The “page-start” property

  “page-start”               guint

page-start.

Flags: Read

Default value: 0


The “page-visible” property

  “page-visible”             gboolean

page-visible.

Flags: Read

Default value: FALSE


The “round” property

  “round”                    gboolean

round.

Flags: Read

Default value: FALSE


The “size” property

  “size”                     gint

size.

Flags: Read

Default value: 0


The “cursor-pos” property

  “cursor-pos”               gint

cursor-pos.

Flags: Read

Default value: 0


The “size” property

  “size”                     gint

size.

Flags: Read

Default value: 0


The “auto-correct” property

  “auto-correct”             gboolean

auto-correct.

Flags: Read / Write

Default value: FALSE


The “input” property

  “input”                    gchar *

input.

Flags: Read

Default value: NULL


The “input-cursor-pos” property

  “input-cursor-pos”         gint

input-cursor-pos.

Flags: Read

Default value: 0


The “input-mode” property

  “input-mode”               guint

input-mode.

Flags: Read / Write

Default value: 0


The “punctuation-style” property

  “punctuation-style”        guint

punctuation-style.

Flags: Read / Write

Default value: 0

Signal Details

The “populated” signal

void
user_function (KkcDBusCandidateList *dbus_candidate_list,
               gpointer              user_data)

Parameters

dbus_candidate_list

the KkcDBusCandidateList instance that received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “selected” signal

void
user_function (KkcDBusCandidateList *dbus_candidate_list,
               gchar                *midasi,
               gboolean              okuri,
               gchar                *text,
               gchar                *annotation,
               gpointer              user_data)

Parameters

dbus_candidate_list

the KkcDBusCandidateList instance that received the signal

 

midasi

 

 

okuri

 

 

text

 

 

annotation

 

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last