IBus.EngineDesc¶

Subclasses:: None

Methods¶

Inherited:: IBus.Serializable (7), IBus.Object (2), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (name, longname, description, language, license, author, icon, layout)
class	`new_from_xml_node` (node)
	`get_author` ()
	`get_description` ()
	`get_hotkeys` ()
	`get_icon` ()
	`get_icon_prop_key` ()
	`get_language` ()
	`get_layout` ()
	`get_layout_option` ()
	`get_layout_variant` ()
	`get_license` ()
	`get_longname` ()
	`get_name` ()
	`get_rank` ()
	`get_setup` ()
	`get_symbol` ()
	`get_textdomain` ()
	`get_version` ()
	`output` (output, indent)

Virtual Methods¶

Inherited:: IBus.Serializable (3), IBus.Object (1), GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`author`	`str`	r/w/co	The author of engine description
`description`	`str`	r/w/co	The description of engine description
`hotkeys`	`str`	r/w/co	The hotkeys of engine description
`icon`	`str`	r/w/co	The icon of engine description
`icon-prop-key`	`str`	r/w/co	The key of `IBus.Property` for the dynamic panel icon
`language`	`str`	r/w/co	The language of engine description
`layout`	`str`	r/w/co	The layout of engine description
`layout-option`	`str`	r/w/co	The keyboard option of engine description
`layout-variant`	`str`	r/w/co	The keyboard variant of engine description
`license`	`str`	r/w/co	The license of engine description
`longname`	`str`	r/w/co	The longname of engine description
`name`	`str`	r/w/co	The name of engine description
`rank`	`int`	r/w/co	The rank of engine description
`setup`	`str`	r/w/co	The exec lists of the engine setup command
`symbol`	`str`	r/w/co	The icon symbol chars of engine description
`textdomain`	`str`	r/w/co	The textdomain of engine description
`version`	`str`	r/w/co	The version number of engine description

Signals¶

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

Fields¶

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

Name	Type	Access	Description
parent	`IBus.Serializable`	r

Class Details¶

class IBus.EngineDesc(**kwargs)¶

Bases:: IBus.Serializable
Abstract:: No
Structure:: IBus.EngineDescClass

An IBus.EngineDesc stores description data of IBus.Engine. The description data can either be passed to IBus.EngineDesc.new(), or loaded from an XML node through IBus.EngineDesc.new_from_xml_node() to construct IBus.EngineDesc.

However, the recommended way to load engine description data is using IBus.Component.new_from_file() to load a component file, which also includes engine description data.

see_also: IBus.Component, IBus.Engine

classmethod new(name, longname, description, language, license, author, icon, layout)¶

Parameters:

name (str) – Name of the engine.
longname (str) – Long name of the input method engine.
description (str) – Input method engine description.
language (str) – Language (e.g. zh, jp) supported by this input method engine.
license (str) – License of the input method engine.
author (str) – Author of the input method engine.
icon (str) – Icon file of this engine.
layout (str) – Keyboard layout

Returns:

A newly allocated IBus.EngineDesc.

Return type:

IBus.EngineDesc

Creates a new IBus.EngineDesc. If layout is “default”, the engine inherits the current layout and does not change the layout. The layouts “default” and “” are same. E.g. If you switch JP XKB engine and an input method engine (IME), the IME inherits the JP layout.

classmethod new_from_xml_node(node)¶

Parameters:: node (IBus.XML) – An XML node
Returns:: A newly allocated IBus.EngineDesc that contains description from node.
Return type:: IBus.EngineDesc

Creates a new IBus.EngineDesc from an XML node.

This function is called by IBus.Component.new_from_file(), so developers normally do not need to call it directly.

get_author()¶

Returns:: author property in IBus.EngineDesc
Return type:: str

Gets the author property in IBus.EngineDesc. It should not be freed.

get_description()¶

Returns:: description property in IBus.EngineDesc
Return type:: str

Gets the description property in IBus.EngineDesc. It should not be freed.

get_hotkeys()¶

Returns:: hotkeys property in IBus.EngineDesc
Return type:: str

Gets the hotkeys property in IBus.EngineDesc. It should not be freed.

get_icon()¶

Returns:: icon property in IBus.EngineDesc
Return type:: str

Gets the icon property in IBus.EngineDesc. It should not be freed.

get_icon_prop_key()¶

Returns:: IBus.Property.key for dynamic panel icon in IBus.EngineDesc
Return type:: str

Gets the key of IBus.Property to load the panel icon dynamically in IBus.EngineDesc. It should not be freed.

get_language()¶

Returns:: language property in IBus.EngineDesc
Return type:: str

Gets the language property in IBus.EngineDesc. It should not be freed.

get_layout()¶

Returns:: layout property in IBus.EngineDesc
Return type:: str

Gets the layout property in IBus.EngineDesc. It should not be freed.

get_layout_option()¶

Returns:: keyboard option property in IBus.EngineDesc
Return type:: str

Gets the keyboard option property in IBus.EngineDesc. It should not be freed.

get_layout_variant()¶

Returns:: keyboard variant property in IBus.EngineDesc
Return type:: str

Gets the keyboard variant property in IBus.EngineDesc. It should not be freed.

get_license()¶

Returns:: license property in IBus.EngineDesc
Return type:: str

Gets the license property in IBus.EngineDesc. It should not be freed.

get_longname()¶

Returns:: longname property in IBus.EngineDesc
Return type:: str

Gets the longname property in IBus.EngineDesc. It should not be freed.

get_name()¶

Returns:: name property in IBus.EngineDesc
Return type:: str

Gets the name property in IBus.EngineDesc. It should not be freed.

get_rank()¶

Returns:: rank property in IBus.EngineDesc
Return type:: int

Gets the rank property in IBus.EngineDesc.

get_setup()¶

Returns:: setup property in IBus.EngineDesc
Return type:: str

Gets the setup property in IBus.EngineDesc. It should not be freed.

get_symbol()¶

Returns:: symbol property in IBus.EngineDesc
Return type:: str

Gets the symbol property in IBus.EngineDesc. It should not be freed.

get_textdomain()¶

Returns:: textdomain in IBus.EngineDesc
Return type:: str

Gets the textdomain property in IBus.EngineDesc. It should not be freed.

get_version()¶

Returns:: version in IBus.EngineDesc
Return type:: str

Gets the version property in IBus.EngineDesc. It should not be freed.

output(output, indent)¶

Parameters:

output (GLib.String) – XML-formatted Input method engine description.
indent (int) – Number of indent (showed as 4 spaces).

Output XML-formatted input method engine description. The result will be append to GLib.String specified in output.

Property Details¶

IBus.EngineDesc.props.author¶

Name:: author
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The author of engine description

IBus.EngineDesc.props.description¶

Name:: description
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The description of engine description

IBus.EngineDesc.props.hotkeys¶

Name:: hotkeys
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The hotkeys of engine description

IBus.EngineDesc.props.icon¶

Name:: icon
Type:: str
Default Value:: 'ibus-engine'
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The icon of engine description

IBus.EngineDesc.props.icon_prop_key¶

Name:: icon-prop-key
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The key of IBus.Property to change panel icon dynamically.

IBus.EngineDesc.props.language¶

Name:: language
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The language of engine description

IBus.EngineDesc.props.layout¶

Name:: layout
Type:: str
Default Value:: 'us'
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The layout of engine description

IBus.EngineDesc.props.layout_option¶

Name:: layout-option
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The keyboard option of engine description

IBus.EngineDesc.props.layout_variant¶

Name:: layout-variant
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The keyboard variant of engine description

IBus.EngineDesc.props.license¶

Name:: license
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The license of engine description

IBus.EngineDesc.props.longname¶

Name:: longname
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The longname of engine description

IBus.EngineDesc.props.name¶

Name:: name
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The name of engine description

IBus.EngineDesc.props.rank¶

Name:: rank
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The rank of engine description

IBus.EngineDesc.props.setup¶

Name:: setup
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The exec lists of the engine setup command

IBus.EngineDesc.props.symbol¶

Name:: symbol
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The symbol chars of engine description instead of icon image

IBus.EngineDesc.props.textdomain¶

Name:: textdomain
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The textdomain of engine description

IBus.EngineDesc.props.version¶

Name:: version
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The version number of engine description