IBus.Property

g GObject.InitiallyUnowned GObject.InitiallyUnowned IBus.Object IBus.Object GObject.InitiallyUnowned->IBus.Object GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned IBus.Serializable IBus.Serializable IBus.Object->IBus.Serializable IBus.Property IBus.Property IBus.Serializable->IBus.Property

Subclasses:None

Methods

Inherited:IBus.Serializable (7), IBus.Object (2), GObject.Object (37)
Structs:GObject.ObjectClass (5)
class new (key, type, label, icon, tooltip, sensitive, visible, state, prop_list)
  get_icon ()
  get_key ()
  get_label ()
  get_prop_type ()
  get_sensitive ()
  get_state ()
  get_sub_props ()
  get_symbol ()
  get_tooltip ()
  get_visible ()
  set_icon (icon)
  set_label (label)
  set_sensitive (sensitive)
  set_state (state)
  set_sub_props (prop_list)
  set_symbol (symbol)
  set_tooltip (tooltip)
  set_visible (visible)
  update (prop_update)

Properties

Name Type Flags Short Description
icon str r/w The icon of property
key str r/w/co The key of property
label IBus.Text r/w/c The label of property
prop-type IBus.PropType r/w/co The type of property
sensitive bool r/w The sensitive of property
state IBus.PropState r/w The state of property
sub-props IBus.PropList r/w The sub properties of property
symbol IBus.Text r/w/c The symbol of property
tooltip IBus.Text r/w The tooltip of property
visible bool r/w The visible of property

Fields

Inherited:IBus.Object (1), GObject.Object (1)
Name Type Access Description
parent IBus.Serializable r  
pdummy [object] r  

Class Details

class IBus.Property(**kwargs)
Bases:IBus.Serializable
Abstract:No
Structure:IBus.PropertyClass

An IBus.Property is an UI component like a button or a menu item which shows the status of corresponding input method engine property. End user can operate and see the current status of IME through these components. For example, ibus-chewing users change the English/Chinese input mode by pressing ctrl-space or click on the Eng/Chi switch button. And the IBus.Property shows the change correspondingly.

see_also: IBus.PropList, IBus.Engine

classmethod new(key, type, label, icon, tooltip, sensitive, visible, state, prop_list)
Parameters:
Returns:

A newly allocated IBus.Property.

Return type:

IBus.Property

Creates a new IBus.Property.

get_icon()
Returns:the icon of IBus.Property. Should not be freed.
Return type:str

Get the icon of IBus.Property.

get_key()
Returns:the key of IBus.Property. Should not be freed.
Return type:str

Get the key of IBus.Property.

get_label()
Returns:the label of IBus.Property. Should not be freed.
Return type:IBus.Text

Get the label of IBus.Property.

get_prop_type()
Return type:IBus.PropType
get_sensitive()
Returns:the sensitive of IBus.Property.
Return type:bool

Get the sensitive of IBus.Property.

get_state()
Returns:the state of IBus.Property.
Return type:IBus.PropState

Get the state of IBus.Property.

get_sub_props()
Returns:the IBus.PropList of IBus.Property. Should not be freed.
Return type:IBus.PropList

Get the IBus.PropList of IBus.Property.

get_symbol()
Returns:the symbol of IBus.Property. Should not be freed.
Return type:IBus.Text

Get the symbol of IBus.Property.

get_tooltip()
Returns:the tooltip of IBus.Property. Should not be freed.
Return type:IBus.Text

Get the tooltip of IBus.Property.

get_visible()
Returns:the visible of IBus.Property.
Return type:bool

Get the visible of IBus.Property.

set_icon(icon)
Parameters:icon (str) – Icon shown in UI. It could be a full path of an icon file or an icon name.

Set the icon of IBus.Property.

set_label(label)
Parameters:label (IBus.Text) – Text shown in UI.

Set the label of IBus.Property.

set_sensitive(sensitive)
Parameters:sensitive (bool) – Whether the IBus.Property is sensitive.

Set whether the IBus.Property is sensitive.

set_state(state)
Parameters:state (IBus.PropState) – The state of the IBus.Property.

Set the state of the IBus.Property.

set_sub_props(prop_list)
Parameters:prop_list (IBus.PropList) – IBus.PropList that contains sub IBusProperties.

Set the sub IBusProperties.

set_symbol(symbol)
Parameters:symbol (IBus.Text) – Text shown in UI.

Set the symbol of IBus.Property.

set_tooltip(tooltip)
Parameters:tooltip (IBus.Text) – Text of the tooltip.

Set the tooltip of IBus.Property.

set_visible(visible)
Parameters:visible (bool) – Whether the IBus.Property is visible.

Set whether the IBus.Property is visible.

update(prop_update)
Parameters:prop_update (IBus.Property) – IBus.PropList that contains sub IBusProperties.
Returns:True if update succeeded; False otherwise.
Return type:bool

Update the content of an IBus.Property. IBus.Property prop_update can either be sub-property of self, or holds new values for self.

Property Details

IBus.Property.props.icon
Name:icon
Type:str
Default Value:''
Flags:READABLE, WRITABLE

The icon of property

IBus.Property.props.key
Name:key
Type:str
Default Value:''
Flags:READABLE, WRITABLE, CONSTRUCT_ONLY

The key of property

IBus.Property.props.label
Name:label
Type:IBus.Text
Default Value:None
Flags:READABLE, WRITABLE, CONSTRUCT

The label of property

IBus.Property.props.prop_type
Name:prop-type
Type:IBus.PropType
Default Value:IBus.PropType.NORMAL
Flags:READABLE, WRITABLE, CONSTRUCT_ONLY

The type of property

IBus.Property.props.sensitive
Name:sensitive
Type:bool
Default Value:True
Flags:READABLE, WRITABLE

The sensitive of property

IBus.Property.props.state
Name:state
Type:IBus.PropState
Default Value:IBus.PropState.UNCHECKED
Flags:READABLE, WRITABLE

The state of property

IBus.Property.props.sub_props
Name:sub-props
Type:IBus.PropList
Default Value:None
Flags:READABLE, WRITABLE

The sub properties of property

IBus.Property.props.symbol
Name:symbol
Type:IBus.Text
Default Value:None
Flags:READABLE, WRITABLE, CONSTRUCT

The symbol of property

IBus.Property.props.tooltip
Name:tooltip
Type:IBus.Text
Default Value:None
Flags:READABLE, WRITABLE

The tooltip of property

IBus.Property.props.visible
Name:visible
Type:bool
Default Value:True
Flags:READABLE, WRITABLE

The visible of property