IBus.PanelService

Subclasses:

None

Methods

Inherited:

IBus.Service (8), IBus.Object (2), GObject.Object (37)

Structs:

IBus.ServiceClass (2), GObject.ObjectClass (5)

class	new (connection)
	candidate_clicked (index, button, state)
	commit_text (text)
	cursor_down ()
	cursor_up ()
	forward_process_key_event (keyval, keycode, state)
	hide_preedit_text_received ()
	page_down ()
	page_up ()
	panel_extension (event)
	property_activate (prop_name, prop_state)
	property_hide (prop_name)
	property_show (prop_name)
	send_message (message)
	set_preedit_format (format)
	show_preedit_text_received ()
	update_auxiliary_text_received (text, visible)
	update_lookup_table_received (table, visible)
	update_preedit_text_received (text, cursor_pos, visible)

Virtual Methods

Inherited:

IBus.Service (3), IBus.Object (1), GObject.Object (7)

	do_candidate_clicked_lookup_table (index, button, state)
	do_commit_text_received (text)
	do_cursor_down_lookup_table ()
	do_cursor_up_lookup_table ()
	do_destroy_context (input_context_path)
	do_focus_in (input_context_path)
	do_focus_out (input_context_path)
	do_hide_auxiliary_text ()
	do_hide_language_bar ()
	do_hide_lookup_table ()
	do_hide_preedit_text ()
	do_page_down_lookup_table ()
	do_page_up_lookup_table ()
	do_panel_extension_received (event)
	do_process_key_event (keyval, keycode, state)
	do_register_properties (prop_list)
	do_reset ()
	do_set_content_type (purpose, hints)
	do_set_cursor_location (x, y, w, h)
	do_set_cursor_location_relative (x, y, w, h)
	do_show_auxiliary_text ()
	do_show_language_bar ()
	do_show_lookup_table ()
	do_show_preedit_text ()
	do_start_setup ()
	do_state_changed ()
	do_update_auxiliary_text (text, visible)
	do_update_lookup_table (lookup_table, visible)
	do_update_preedit_text (text, cursor_pos, visible)
	do_update_property (prop)

Properties

Inherited:

IBus.Service (2)

Signals

Inherited:

IBus.Object (1), GObject.Object (1)

Name	Short Description
candidate-clicked-lookup-table	Emitted when the client application get the ::candidate-clicked-lookup-table.
commit-text-received	Emitted when the client application get the ::commit-text-received.
cursor-down-lookup-table	Emitted when the client application get the ::cursor-down-lookup-table.
cursor-up-lookup-table	Emitted when the client application get the ::cursor-up-lookup-table.
destroy-context	Emitted when the client application destroys.
focus-in	Emitted when the client application get the ::focus-in.
focus-out	Emitted when the client application get the ::focus-out.
hide-auxiliary-text	Emitted when the client application get the ::hide-auxiliary-text.
hide-language-bar	Emitted when the client application get the ::hide-language-bar.
hide-lookup-table	Emitted when the client application get the ::hide-lookup-table.
hide-preedit-text	Emitted when the client application get the ::hide-preedit-text.
page-down-lookup-table	Emitted when the client application get the ::page-down-lookup-table.
page-up-lookup-table	Emitted when the client application get the ::page-up-lookup-table.
panel-extension-received	Emitted when the client application get the ::panel-extension-received.
process-key-event	Emitted when a key event is received.
register-properties	Emitted when the client application get the ::register-properties.
reset	Emitted when the client application get the ::reset.
send-message-received	Emitted when the client application get the ::send-meeeage-received.
set-content-type	Emitted when the client application get the ::set-content-type.
set-cursor-location	Emitted when the client application get the ::set-cursor-location.
set-cursor-location-relative	Emitted when the client application get the set-cursor-location-relative.
show-auxiliary-text	Emitted when the client application get the ::show-auxiliary-text.
show-language-bar	Emitted when the client application get the ::show-language-bar.
show-lookup-table	Emitted when the client application get the ::show-lookup-table.
show-preedit-text	Emitted when the client application get the ::show-preedit-text.
start-setup	Emitted when the client application get the ::start-setup.
state-changed	Emitted when the client application get the ::state-changed.
update-auxiliary-text	Emitted when the client application get the ::update-auxiliary-text.
update-lookup-table	Emitted when the client application get the ::update-lookup-table.
update-preedit-text	Emitted when the client application get the ::update-preedit-text.
update-property	Emitted when the client application get the ::update-property.

Fields

Inherited:

IBus.Object (1), GObject.Object (1)

Name	Type	Access	Description
parent	IBus.Service	r

Class Details

class IBus.PanelService(**kwargs)

Bases:

IBus.Service

Abstract:

No

Structure:

IBus.PanelServiceClass

An IBus.PanelService is a base class for UI services. Developers can “extend” this class for panel UI development.

classmethod new(connection)

Parameters:

connection (Gio.DBusConnection) – An Gio.DBusConnection.

Returns:

A newly allocated IBus.PanelService.

Return type:

IBus.PanelService

Creates a new IBus.PanelService from an Gio.DBusConnection.

candidate_clicked(index, button, state)

Parameters:

• index (int) – Index in the Lookup table

• button (int) – GdkEventButton::button (1: left button, etc.)

• state (int) – GdkEventButton::state (key modifier flags)

Notify that a candidate is clicked by sending a “CandidateClicked” to IBus service.

commit_text(text)

Parameters:

text (IBus.Text) – An IBus.Text

Notify that a text is sent by sending a “CommitText” message to IBus service.

cursor_down()

Notify that the cursor is down by sending a “CursorDown” to IBus service.

cursor_up()

Notify that the cursor is up by sending a “CursorUp” to IBus service.

forward_process_key_event(keyval, keycode, state)

Parameters:

• keyval (int) – Key symbol of a key event.

• keycode (int) – Keycode of a key event.

• state (int) – Key modifier flags.

Forward key events when an IBus popup takes the focus and the events needs to be forwared to the target IBus engine.

New in version 1.5.32.

hide_preedit_text_received()

Notify that the preedit is hidden by the panel extension

page_down()

Notify that the page is down by sending a “PageDown” to IBus service.

page_up()

Notify that the page is up by sending a “PageUp” to IBus service.

panel_extension(event)

Parameters:

event (IBus.ExtensionEvent) – A #PanelExtensionEvent which is sent to a panel extension.

Enable or disable a panel extension with IBus.ExtensionEvent. Notify that a data is sent by sending a “PanelExtension” message to IBus panel extension service.

property_activate(prop_name, prop_state)

Parameters:

• prop_name (str) – A property name

• prop_state (int) – State of the property

Notify that a property is active by sending a “PropertyActivate” message to IBus service.

property_hide(prop_name)

Parameters:

prop_name (str) – A property name

Notify that a property is hidden by sending a “ValueChanged” message to IBus service.

property_show(prop_name)

Parameters:

prop_name (str) – A property name

Notify that a property is shown by sending a “ValueChanged” message to IBus service.

send_message(message)

Parameters:

message (IBus.Message) – An IBus.Message.

Send a message to the Panel for the focus-less notification popup. This is used for the emoji component in Wayland mainly but in Xorg too.

New in version 1.5.33.

set_preedit_format(format)

Parameters:

format (IBus.PreeditFormat) – An IBus.PreeditFormat.

The pre-edit attributes follows the format and the default is IBus.PreeditFormat.RGBA and the types of all IBus.Attribute are should be one of IBus.AttrType.UNDERLINE, IBus.AttrType.FOREGROUND, IBus.AttrType.BACKGROUND. In case that the format is IBus.PreeditFormat.HINT, the types of all IBus.Attribute are IBus.AttrType.HINT.

See also IBus.Text.get_attributes();

New in version 1.5.33.

show_preedit_text_received()

Notify that the preedit is shown by the panel extension

update_auxiliary_text_received(text, visible)

Parameters:

• text (IBus.Text) – An IBus.Text

• visible (bool) – Whether the auxilirary text is visible.

Notify that the auxilirary is updated by the panel extension.

(Note: The table object will be released, if it is floating. If caller want to keep the object, caller should make the object sink by GObject.Object.ref_sink.)

update_lookup_table_received(table, visible)

Parameters:

• table (IBus.LookupTable) – An IBus.LookupTable

• visible (bool) – Whether the lookup table is visible.

Notify that the lookup table is updated by the panel extension.

(Note: The table object will be released, if it is floating. If caller want to keep the object, caller should make the object sink by GObject.Object.ref_sink.)

update_preedit_text_received(text, cursor_pos, visible)

Parameters:

• text (IBus.Text) – Update content.

• cursor_pos (int) – Current position of cursor

• visible (bool) – Whether the pre-edit buffer is visible.

Notify that the preedit is updated by the panel extension

(Note: The table object will be released, if it is floating. If caller want to keep the object, caller should make the object sink by GObject.Object.ref_sink.)

do_candidate_clicked_lookup_table(index, button, state) virtual

Parameters:

• index (int) –

• button (int) –

• state (int) –

do_commit_text_received(text) virtual

Parameters:

text (IBus.Text) –

do_cursor_down_lookup_table() virtual

do_cursor_up_lookup_table() virtual

do_destroy_context(input_context_path) virtual

Parameters:

input_context_path (str) –

do_focus_in(input_context_path) virtual

Parameters:

input_context_path (str) –

do_focus_out(input_context_path) virtual

Parameters:

input_context_path (str) –

do_hide_auxiliary_text() virtual

do_hide_language_bar() virtual

do_hide_lookup_table() virtual

do_hide_preedit_text() virtual

do_page_down_lookup_table() virtual

do_page_up_lookup_table() virtual

do_panel_extension_received(event) virtual

Parameters:

event (IBus.ExtensionEvent) –

do_process_key_event(keyval, keycode, state) virtual

Parameters:

• keyval (int) –

• keycode (int) –

• state (int) –

Return type:

bool

do_register_properties(prop_list) virtual

Parameters:

prop_list (IBus.PropList) –

do_reset() virtual

do_set_content_type(purpose, hints) virtual

Parameters:

• purpose (int) –

• hints (int) –

do_set_cursor_location(x, y, w, h) virtual

Parameters:

• x (int) –

• y (int) –

• w (int) –

• h (int) –

do_set_cursor_location_relative(x, y, w, h) virtual

Parameters:

• x (int) –

• y (int) –

• w (int) –

• h (int) –

do_show_auxiliary_text() virtual

do_show_language_bar() virtual

do_show_lookup_table() virtual

do_show_preedit_text() virtual

do_start_setup() virtual

do_state_changed() virtual

do_update_auxiliary_text(text, visible) virtual

Parameters:

• text (IBus.Text) –

• visible (bool) –

do_update_lookup_table(lookup_table, visible) virtual

Parameters:

• lookup_table (IBus.LookupTable) –

• visible (bool) –

do_update_preedit_text(text, cursor_pos, visible) virtual

Parameters:

• text (IBus.Text) –

• cursor_pos (int) –

• visible (bool) –

do_update_property(prop) virtual

Parameters:

prop (IBus.Property) –

Signal Details

IBus.PanelService.signals.candidate_clicked_lookup_table(panel_service, index, button, state)

Signal Name:

candidate-clicked-lookup-table

Flags:

RUN_LAST

Parameters:

• panel_service (IBus.PanelService) – The object which received the signal

• index (int) – Index in the Lookup table

• button (int) – GdkEventButton::button (1: left button, etc.)

• state (int) – GdkEventButton::state (key modifier flags)

Emitted when the client application get the ::candidate-clicked-lookup-table. Implement the member function IBusPanelServiceClass::candidate_cllicked_lookup_table in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.commit_text_received(panel_service, text)

Signal Name:

commit-text-received

Flags:

RUN_LAST

Parameters:

• panel_service (IBus.PanelService) – The object which received the signal

• text (IBus.Text) – An IBus.Text

Emitted when the client application get the ::commit-text-received. Implement the member function IBusPanelServiceClass::commit_text_received in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.cursor_down_lookup_table(panel_service)

Signal Name:

cursor-down-lookup-table

Flags:

RUN_LAST

Parameters:

panel_service (IBus.PanelService) – The object which received the signal

Emitted when the client application get the ::cursor-down-lookup-table. Implement the member function IBusPanelServiceClass::cursor_down_lookup_table in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.cursor_up_lookup_table(panel_service)

Signal Name:

cursor-up-lookup-table

Flags:

RUN_LAST

Parameters:

panel_service (IBus.PanelService) – The object which received the signal

Emitted when the client application get the ::cursor-up-lookup-table. Implement the member function IBusPanelServiceClass::cursor_up_lookup_table in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.destroy_context(panel_service, input_context_path)

Signal Name:

destroy-context

Flags:

RUN_LAST

Parameters:

• panel_service (IBus.PanelService) – The object which received the signal

• input_context_path (str) – Object path of InputContext.

Emitted when the client application destroys. Implement the member function IBusPanelServiceClass::destroy_context in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.focus_in(panel_service, input_context_path)

Signal Name:

focus-in

Flags:

RUN_LAST

Parameters:

• panel_service (IBus.PanelService) – The object which received the signal

• input_context_path (str) – Object path of InputContext.

Emitted when the client application get the ::focus-in. Implement the member function IBusPanelServiceClass::focus_in in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.focus_out(panel_service, input_context_path)

Signal Name:

focus-out

Flags:

RUN_LAST

Parameters:

• panel_service (IBus.PanelService) – The object which received the signal

• input_context_path (str) – Object path of InputContext.

Emitted when the client application get the ::focus-out. Implement the member function IBusPanelServiceClass::focus_out in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.hide_auxiliary_text(panel_service)

Signal Name:

hide-auxiliary-text

Flags:

RUN_LAST

Parameters:

panel_service (IBus.PanelService) – The object which received the signal

Emitted when the client application get the ::hide-auxiliary-text. Implement the member function IBusPanelServiceClass::hide_auxiliary_text in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.hide_language_bar(panel_service)

Signal Name:

hide-language-bar

Flags:

RUN_LAST

Parameters:

panel_service (IBus.PanelService) – The object which received the signal

Emitted when the client application get the ::hide-language-bar. Implement the member function IBusPanelServiceClass::hide_language_bar in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.hide_lookup_table(panel_service)

Signal Name:

hide-lookup-table

Flags:

RUN_LAST

Parameters:

panel_service (IBus.PanelService) – The object which received the signal

Emitted when the client application get the ::hide-lookup-table. Implement the member function IBusPanelServiceClass::hide_lookup_table in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.hide_preedit_text(panel_service)

Signal Name:

hide-preedit-text

Flags:

RUN_LAST

Parameters:

panel_service (IBus.PanelService) – The object which received the signal

Emitted when the client application get the ::hide-preedit-text. Implement the member function IBusPanelServiceClass::hide_preedit_text in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.page_down_lookup_table(panel_service)

Signal Name:

page-down-lookup-table

Flags:

RUN_LAST

Parameters:

panel_service (IBus.PanelService) – The object which received the signal

Emitted when the client application get the ::page-down-lookup-table. Implement the member function IBusPanelServiceClass::page_down_lookup_table in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.page_up_lookup_table(panel_service)

Signal Name:

page-up-lookup-table

Flags:

RUN_LAST

Parameters:

panel_service (IBus.PanelService) – The object which received the signal

Emitted when the client application get the ::page-up-lookup-table. Implement the member function IBusPanelServiceClass::page_up_lookup_table in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.panel_extension_received(panel_service, data)

Signal Name:

panel-extension-received

Flags:

RUN_LAST

Parameters:

• panel_service (IBus.PanelService) – The object which received the signal

• data (IBus.ExtensionEvent) – A GLib.Variant

Emitted when the client application get the ::panel-extension-received. Implement the member function IBusPanelServiceClass::panel_extension_received in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.process_key_event(panel_service, keyval, keycode, state)

Signal Name:

process-key-event

Flags:

RUN_LAST

Parameters:

• panel_service (IBus.PanelService) – The object which received the signal

• keyval (int) – Key symbol of the key press.

• keycode (int) – KeyCode of the key press.

• state (int) – Key modifier flags.

Returns:

True for successfully process the key; False otherwise. See also: IBus.InputContext.process_key_event().

Argument user_data is ignored in this function.

Return type:

bool

Emitted when a key event is received. Implement the member function IBusPanelServiceClass::process_key_event in extended class to receive this signal. Both the key symbol and keycode are passed to the member function. See IBus.InputContext.process_key_event() for further explanation of key symbol, keycode and which to use.

IBus.PanelService.signals.register_properties(panel_service, prop_list)

Signal Name:

register-properties

Flags:

RUN_LAST

Parameters:

• panel_service (IBus.PanelService) – The object which received the signal

• prop_list (IBus.PropList) – An IBus.PropList that contains properties.

Emitted when the client application get the ::register-properties. Implement the member function IBusPanelServiceClass::register_properties in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.reset(panel_service)

Signal Name:

reset

Flags:

RUN_LAST

Parameters:

panel_service (IBus.PanelService) – The object which received the signal

Emitted when the client application get the ::reset. Implement the member function IBusPanelServiceClass::reset in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.send_message_received(panel_service, message)

Signal Name:

send-message-received

Flags:

RUN_LAST

Parameters:

• panel_service (IBus.PanelService) – The object which received the signal

• message (IBus.Message) – An IBus.Message

Emitted when the client application get the ::send-meeeage-received. Implement the member function

Argument user_data is ignored in this function.

New in version 1.5.33.

IBus.PanelService.signals.set_content_type(panel_service, purpose, hints)

Signal Name:

set-content-type

Flags:

RUN_LAST

Parameters:

• panel_service (IBus.PanelService) – The object which received the signal

• purpose (int) – Input purpose.

• hints (int) – Input hints.

Emitted when the client application get the ::set-content-type. Implement the member function IBusPanelServiceClass::set_content_type in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.set_cursor_location(panel_service, x, y, w, h)

Signal Name:

set-cursor-location

Flags:

RUN_LAST

Parameters:

• panel_service (IBus.PanelService) – The object which received the signal

• x (int) – X coordinate of the cursor.

• y (int) – Y coordinate of the cursor.

• w (int) – Width of the cursor.

• h (int) – Height of the cursor.

Emitted when the client application get the ::set-cursor-location. Implement the member function IBusPanelServiceClass::set_cursor_location in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.set_cursor_location_relative(panel_service, x, y, w, h)

Signal Name:

set-cursor-location-relative

Flags:

RUN_LAST

Parameters:

• panel_service (IBus.PanelService) – The object which received the signal

• x (int) – X coordinate of the cursor.

• y (int) – Y coordinate of the cursor.

• w (int) – Width of the cursor.

• h (int) – Height of the cursor.

Emitted when the client application get the set-cursor-location-relative. Implement the member function set_cursor_location_relative() in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.show_auxiliary_text(panel_service)

Signal Name:

show-auxiliary-text

Flags:

RUN_LAST

Parameters:

panel_service (IBus.PanelService) – The object which received the signal

Emitted when the client application get the ::show-auxiliary-text. Implement the member function IBusPanelServiceClass::show_auxiliary_text in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.show_language_bar(panel_service)

Signal Name:

show-language-bar

Flags:

RUN_LAST

Parameters:

panel_service (IBus.PanelService) – The object which received the signal

Emitted when the client application get the ::show-language-bar. Implement the member function IBusPanelServiceClass::show_language_bar in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.show_lookup_table(panel_service)

Signal Name:

show-lookup-table

Flags:

RUN_LAST

Parameters:

panel_service (IBus.PanelService) – The object which received the signal

Emitted when the client application get the ::show-lookup-table. Implement the member function IBusPanelServiceClass::show_lookup_table in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.show_preedit_text(panel_service)

Signal Name:

show-preedit-text

Flags:

RUN_LAST

Parameters:

panel_service (IBus.PanelService) – The object which received the signal

Emitted when the client application get the ::show-preedit-text. Implement the member function IBusPanelServiceClass::show_preedit_text in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.start_setup(panel_service)

Signal Name:

start-setup

Flags:

RUN_LAST

Parameters:

panel_service (IBus.PanelService) – The object which received the signal

Emitted when the client application get the ::start-setup. Implement the member function IBusPanelServiceClass::start_setup in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.state_changed(panel_service)

Signal Name:

state-changed

Flags:

RUN_LAST

Parameters:

panel_service (IBus.PanelService) – The object which received the signal

Emitted when the client application get the ::state-changed. Implement the member function IBusPanelServiceClass::state_changed in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.update_auxiliary_text(panel_service, text, visible)

Signal Name:

update-auxiliary-text

Flags:

RUN_LAST

Parameters:

• panel_service (IBus.PanelService) – The object which received the signal

• text (IBus.Text) – A preedit text to be updated.

• visible (bool) – Whether the update is visible.

Emitted when the client application get the ::update-auxiliary-text. Implement the member function IBusPanelServiceClass::update_auxiliary_text in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.update_lookup_table(panel_service, lookup_table, visible)

Signal Name:

update-lookup-table

Flags:

RUN_LAST

Parameters:

• panel_service (IBus.PanelService) – The object which received the signal

• lookup_table (IBus.LookupTable) – A lookup table to be updated.

• visible (bool) – Whether the update is visible.

Emitted when the client application get the ::update-lookup-table. Implement the member function IBusPanelServiceClass::update_lookup_table in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.update_preedit_text(panel_service, text, cursor_pos, visible)

Signal Name:

update-preedit-text

Flags:

RUN_LAST

Parameters:

• panel_service (IBus.PanelService) – The object which received the signal

• text (IBus.Text) – A preedit text to be updated.

• cursor_pos (int) – The cursor position of the text.

• visible (bool) – Whether the update is visible.

Emitted when the client application get the ::update-preedit-text. Implement the member function IBusPanelServiceClass::update_preedit_text in extended class to receive this signal.

Argument user_data is ignored in this function.

IBus.PanelService.signals.update_property(panel_service, prop)

Signal Name:

update-property

Flags:

RUN_LAST

Parameters:

• panel_service (IBus.PanelService) – The object which received the signal

• prop (IBus.Property) – The IBus.Property to be updated.

Emitted when the client application get the ::update-property. Implement the member function IBusPanelServiceClass::update_property in extended class to receive this signal.

Argument user_data is ignored in this function.