GI.IBus.Objects.EngineDesc

An IBusEngineDesc stores description data of IBusEngine. The description data can either be passed to engineDescNew, or loaded from an XML node through engineDescNewFromXmlNode to construct IBusEngineDesc.

However, the recommended way to load engine description data is using componentNewFromFile to load a component file, which also includes engine description data.

see_also: Component, Engine

Exported types

newtype EngineDesc

Memory-managed wrapper type.

Constructors

EngineDesc (ManagedPtr EngineDesc)

Instances

Eq EngineDesc

Defined in GI.IBus.Objects.EngineDesc

Methods

(==) :: EngineDesc -> EngineDesc -> Bool

(/=) :: EngineDesc -> EngineDesc -> Bool

GObject EngineDesc

Defined in GI.IBus.Objects.EngineDesc

ManagedPtrNewtype EngineDesc

Defined in GI.IBus.Objects.EngineDesc

Methods

toManagedPtr :: EngineDesc -> ManagedPtr EngineDesc

TypedObject EngineDesc

Defined in GI.IBus.Objects.EngineDesc

Methods

glibType :: IO GType

IsGValue EngineDesc

Convert EngineDesc to and from GValue with toGValue and fromGValue.

Defined in GI.IBus.Objects.EngineDesc

Methods

toGValue :: EngineDesc -> IO GValue

fromGValue :: GValue -> IO EngineDesc

HasParentTypes EngineDesc

Defined in GI.IBus.Objects.EngineDesc

type ParentTypes EngineDesc

Defined in GI.IBus.Objects.EngineDesc

type ParentTypes EngineDesc = '[Serializable, Object, Object]

class (GObject o, IsDescendantOf EngineDesc o) => IsEngineDesc o

Type class for types which can be safely cast to EngineDesc, for instance with toEngineDesc.

Instances

(GObject o, IsDescendantOf EngineDesc o) => IsEngineDesc o

Defined in GI.IBus.Objects.EngineDesc

toEngineDesc :: (MonadIO m, IsEngineDesc o) => o -> m EngineDesc

Cast to EngineDesc, for types for which this is known to be safe. For general casts, use castTo.

Methods

Overloaded methods

getAuthor

engineDescGetAuthor

Arguments

:: (HasCallStack, MonadIO m, IsEngineDesc a)

=> a

info: An IBusEngineDesc

-> m Text

Returns: author property in IBusEngineDesc

Gets the author property in IBusEngineDesc. It should not be freed.

getDescription

engineDescGetDescription

Arguments

:: (HasCallStack, MonadIO m, IsEngineDesc a)

=> a

info: An IBusEngineDesc

-> m Text

Returns: description property in IBusEngineDesc

Gets the description property in IBusEngineDesc. It should not be freed.

getHotkeys

engineDescGetHotkeys

Arguments

:: (HasCallStack, MonadIO m, IsEngineDesc a)

=> a

info: An IBusEngineDesc

-> m Text

Returns: hotkeys property in IBusEngineDesc

Gets the hotkeys property in IBusEngineDesc. It should not be freed.

getIcon

engineDescGetIcon

Arguments

:: (HasCallStack, MonadIO m, IsEngineDesc a)

=> a

info: An IBusEngineDesc

-> m Text

Returns: icon property in IBusEngineDesc

Gets the icon property in IBusEngineDesc. It should not be freed.

getIconPropKey

engineDescGetIconPropKey

Arguments

:: (HasCallStack, MonadIO m, IsEngineDesc a)

=> a

info: An IBusEngineDesc

-> m Text

Returns: IBusProperty.key for dynamic panel icon in IBusEngineDesc

Gets the key of IBusProperty to load the panel icon dynamically in IBusEngineDesc. It should not be freed.

getLanguage

engineDescGetLanguage

Arguments

:: (HasCallStack, MonadIO m, IsEngineDesc a)

=> a

info: An IBusEngineDesc

-> m Text

Returns: language property in IBusEngineDesc

Gets the language property in IBusEngineDesc. It should not be freed.

getLayout

engineDescGetLayout

Arguments

:: (HasCallStack, MonadIO m, IsEngineDesc a)

=> a

info: An IBusEngineDesc

-> m Text

Returns: layout property in IBusEngineDesc

Gets the layout property in IBusEngineDesc. It should not be freed.

getLayoutOption

engineDescGetLayoutOption

Arguments

:: (HasCallStack, MonadIO m, IsEngineDesc a)

=> a

info: An IBusEngineDesc

-> m Text

Returns: keyboard option property in IBusEngineDesc

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

getLayoutVariant

engineDescGetLayoutVariant

Arguments

:: (HasCallStack, MonadIO m, IsEngineDesc a)

=> a

info: An IBusEngineDesc

-> m Text

Returns: keyboard variant property in IBusEngineDesc

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

getLicense

engineDescGetLicense

Arguments

:: (HasCallStack, MonadIO m, IsEngineDesc a)

=> a

info: An IBusEngineDesc

-> m Text

Returns: license property in IBusEngineDesc

Gets the license property in IBusEngineDesc. It should not be freed.

getLongname

engineDescGetLongname

Arguments

:: (HasCallStack, MonadIO m, IsEngineDesc a)

=> a

info: An IBusEngineDesc

-> m Text

Returns: longname property in IBusEngineDesc

Gets the longname property in IBusEngineDesc. It should not be freed.

getName

engineDescGetName

Arguments

:: (HasCallStack, MonadIO m, IsEngineDesc a)

=> a

info: An IBusEngineDesc

-> m Text

Returns: name property in IBusEngineDesc

Gets the name property in IBusEngineDesc. It should not be freed.

getRank

engineDescGetRank

Arguments

:: (HasCallStack, MonadIO m, IsEngineDesc a)

=> a

info: An IBusEngineDesc

-> m Word32

Returns: rank property in IBusEngineDesc

Gets the rank property in IBusEngineDesc.

getSetup

engineDescGetSetup

Arguments

:: (HasCallStack, MonadIO m, IsEngineDesc a)

=> a

info: An IBusEngineDesc

-> m Text

Returns: setup property in IBusEngineDesc

Gets the setup property in IBusEngineDesc. It should not be freed.

getSymbol

engineDescGetSymbol

Arguments

:: (HasCallStack, MonadIO m, IsEngineDesc a)

=> a

info: An IBusEngineDesc

-> m Text

Returns: symbol property in IBusEngineDesc

Gets the symbol property in IBusEngineDesc. It should not be freed.

getTextdomain

engineDescGetTextdomain

Arguments

:: (HasCallStack, MonadIO m, IsEngineDesc a)

=> a

info: An IBusEngineDesc

-> m Text

Returns: textdomain in IBusEngineDesc

Gets the textdomain property in IBusEngineDesc. It should not be freed.

getVersion

engineDescGetVersion

Arguments

:: (HasCallStack, MonadIO m, IsEngineDesc a)

=> a

info: An IBusEngineDesc

-> m Text

Returns: version in IBusEngineDesc

Gets the version property in IBusEngineDesc. It should not be freed.

new

engineDescNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

name: Name of the engine.

-> Text

longname: Long name of the input method engine.

-> Text

description: Input method engine description.

-> Text

language: Language (e.g. zh, jp) supported by this input method engine.

-> Text

license: License of the input method engine.

-> Text

author: Author of the input method engine.

-> Text

icon: Icon file of this engine.

-> Text

layout: Keyboard layout

-> m EngineDesc

Returns: A newly allocated IBusEngineDesc.

Creates a new 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.

newFromXmlNode

engineDescNewFromXmlNode

Arguments

:: (HasCallStack, MonadIO m)

=> XML

node: An XML node

-> m EngineDesc

Returns: A newly allocated IBusEngineDesc that contains description from node.

Creates a new IBusEngineDesc from an XML node. <note><para>This function is called by componentNewFromFile, so developers normally do not need to call it directly. </para></note>

output

engineDescOutput

Arguments

:: (HasCallStack, MonadIO m, IsEngineDesc a)

=> a

info: An IBusEngineDesc

-> String

output: XML-formatted Input method engine description.

-> Int32

indent: Number of indent (showed as 4 spaces).

-> m ()

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

Properties

author

The author of engine description

constructEngineDescAuthor :: (IsEngineDesc o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “author” property. This is rarely needed directly, but it is used by new.

getEngineDescAuthor :: (MonadIO m, IsEngineDesc o) => o -> m Text

Get the value of the “author” property. When overloading is enabled, this is equivalent to

get engineDesc #author

description

The description of engine description

constructEngineDescDescription :: (IsEngineDesc o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “description” property. This is rarely needed directly, but it is used by new.

getEngineDescDescription :: (MonadIO m, IsEngineDesc o) => o -> m Text

Get the value of the “description” property. When overloading is enabled, this is equivalent to

get engineDesc #description

hotkeys

The hotkeys of engine description

constructEngineDescHotkeys :: (IsEngineDesc o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “hotkeys” property. This is rarely needed directly, but it is used by new.

getEngineDescHotkeys :: (MonadIO m, IsEngineDesc o) => o -> m Text

Get the value of the “hotkeys” property. When overloading is enabled, this is equivalent to

get engineDesc #hotkeys

icon

The icon of engine description

constructEngineDescIcon :: (IsEngineDesc o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “icon” property. This is rarely needed directly, but it is used by new.

getEngineDescIcon :: (MonadIO m, IsEngineDesc o) => o -> m Text

Get the value of the “icon” property. When overloading is enabled, this is equivalent to

get engineDesc #icon

iconPropKey

The key of IBusProperty to change panel icon dynamically.

constructEngineDescIconPropKey :: (IsEngineDesc o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “icon-prop-key” property. This is rarely needed directly, but it is used by new.

getEngineDescIconPropKey :: (MonadIO m, IsEngineDesc o) => o -> m Text

Get the value of the “icon-prop-key” property. When overloading is enabled, this is equivalent to

get engineDesc #iconPropKey

language

The language of engine description

constructEngineDescLanguage :: (IsEngineDesc o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “language” property. This is rarely needed directly, but it is used by new.

getEngineDescLanguage :: (MonadIO m, IsEngineDesc o) => o -> m Text

Get the value of the “language” property. When overloading is enabled, this is equivalent to

get engineDesc #language

layout

The layout of engine description

constructEngineDescLayout :: (IsEngineDesc o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “layout” property. This is rarely needed directly, but it is used by new.

getEngineDescLayout :: (MonadIO m, IsEngineDesc o) => o -> m Text

Get the value of the “layout” property. When overloading is enabled, this is equivalent to

get engineDesc #layout

layoutOption

The keyboard option of engine description

constructEngineDescLayoutOption :: (IsEngineDesc o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “layout-option” property. This is rarely needed directly, but it is used by new.

getEngineDescLayoutOption :: (MonadIO m, IsEngineDesc o) => o -> m Text

Get the value of the “layout-option” property. When overloading is enabled, this is equivalent to

get engineDesc #layoutOption

layoutVariant

The keyboard variant of engine description

constructEngineDescLayoutVariant :: (IsEngineDesc o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “layout-variant” property. This is rarely needed directly, but it is used by new.

getEngineDescLayoutVariant :: (MonadIO m, IsEngineDesc o) => o -> m Text

Get the value of the “layout-variant” property. When overloading is enabled, this is equivalent to

get engineDesc #layoutVariant

license

The license of engine description

constructEngineDescLicense :: (IsEngineDesc o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “license” property. This is rarely needed directly, but it is used by new.

getEngineDescLicense :: (MonadIO m, IsEngineDesc o) => o -> m Text

Get the value of the “license” property. When overloading is enabled, this is equivalent to

get engineDesc #license

longname

The longname of engine description

constructEngineDescLongname :: (IsEngineDesc o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “longname” property. This is rarely needed directly, but it is used by new.

getEngineDescLongname :: (MonadIO m, IsEngineDesc o) => o -> m Text

Get the value of the “longname” property. When overloading is enabled, this is equivalent to

get engineDesc #longname

name

The name of engine description

constructEngineDescName :: (IsEngineDesc o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “name” property. This is rarely needed directly, but it is used by new.

getEngineDescName :: (MonadIO m, IsEngineDesc o) => o -> m Text

Get the value of the “name” property. When overloading is enabled, this is equivalent to

get engineDesc #name

rank

The rank of engine description

constructEngineDescRank :: (IsEngineDesc o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “rank” property. This is rarely needed directly, but it is used by new.

getEngineDescRank :: (MonadIO m, IsEngineDesc o) => o -> m Word32

Get the value of the “rank” property. When overloading is enabled, this is equivalent to

get engineDesc #rank

setup

The exec lists of the engine setup command

constructEngineDescSetup :: (IsEngineDesc o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “setup” property. This is rarely needed directly, but it is used by new.

getEngineDescSetup :: (MonadIO m, IsEngineDesc o) => o -> m Text

Get the value of the “setup” property. When overloading is enabled, this is equivalent to

get engineDesc #setup

symbol

The symbol chars of engine description instead of icon image

constructEngineDescSymbol :: (IsEngineDesc o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “symbol” property. This is rarely needed directly, but it is used by new.

getEngineDescSymbol :: (MonadIO m, IsEngineDesc o) => o -> m Text

Get the value of the “symbol” property. When overloading is enabled, this is equivalent to

get engineDesc #symbol

textdomain

The textdomain of engine description

constructEngineDescTextdomain :: (IsEngineDesc o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “textdomain” property. This is rarely needed directly, but it is used by new.

getEngineDescTextdomain :: (MonadIO m, IsEngineDesc o) => o -> m Text

Get the value of the “textdomain” property. When overloading is enabled, this is equivalent to

get engineDesc #textdomain

version

The version number of engine description

constructEngineDescVersion :: (IsEngineDesc o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “version” property. This is rarely needed directly, but it is used by new.

getEngineDescVersion :: (MonadIO m, IsEngineDesc o) => o -> m Text

Get the value of the “version” property. When overloading is enabled, this is equivalent to

get engineDesc #version