IBus.EmojiData¶

Subclasses:: None

Methods¶

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

class	`load` (path)
class	`save` (path, list)
	`get_annotations` ()
	`get_category` ()
	`get_description` ()
	`get_emoji` ()
	`set_annotations` (annotations)
	`set_description` (description)

Virtual Methods¶

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

Properties¶

Name	Type	Flags	Short Description
`annotations`	`int`	r/w/c	The emoji annotation list
`category`	`str`	r/w/co	The emoji category
`description`	`str`	r/w/c	The emoji description
`emoji`	`str`	r/w/co	The emoji character UTF-8

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.EmojiData(**kwargs)¶

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

Emoji data likes emoji unicode, annotations, description, category. You can get extended values with g_object_get_properties.

classmethod load(path)¶

Parameters:: path (str) – A path of the saved dictionary file.
Returns:: An IBus.EmojiData list loaded from the saved cache file.
Return type:: [IBus.EmojiData]

classmethod save(path, list)¶

Parameters:

path (str) – A path of the saved emoji data.
list ([IBus.EmojiData]) – A list of emoji data.

Save the list of IBus.EmojiData to the cache file.

get_annotations()¶

Returns:: annotation list property in IBus.EmojiData
Return type:: [str]

Gets the annotation list in IBus.EmojiData. It should not be freed.

get_category()¶

Returns:: category property in IBus.EmojiData
Return type:: str

Gets the emoji category in IBus.EmojiData. It should not be freed.

get_description()¶

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

Gets the emoji description in IBus.EmojiData. It should not be freed.

get_emoji()¶

Returns:: emoji property in IBus.EmojiData
Return type:: str

Gets the emoji character in IBus.EmojiData. It should not be freed.

set_annotations(annotations)¶

Parameters:: annotations ([str]) – List of emoji annotations

Sets the annotation list in IBus.EmojiData.

set_description(description)¶

Parameters:: description (str) – An emoji description

Sets the description in IBus.EmojiData.

Property Details¶

IBus.EmojiData.props.annotations¶

Name:: annotations
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT

The emoji annotations

IBus.EmojiData.props.category¶

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

The emoji category

IBus.EmojiData.props.description¶

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

The emoji description

IBus.EmojiData.props.emoji¶

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

The emoji character