GI.IBus.Objects.Component

An IBusComponent is an executable program. It provides services such as user interface, configuration, and input method engine (IME).

It is recommended that IME developers provide a component XML file and load the XML file by componentNewFromFile.

The format of a component XML file is described at <ulink url="https://github.com/ibus/ibus/wiki/DevXML">https://github.com/ibus/ibus/wiki/DevXML</ulink>

Exported types

newtype Component

Memory-managed wrapper type.

Constructors

Component (ManagedPtr Component)

Instances

Eq Component

Defined in GI.IBus.Objects.Component

Methods

(==) :: Component -> Component -> Bool

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

GObject Component

Defined in GI.IBus.Objects.Component

ManagedPtrNewtype Component

Defined in GI.IBus.Objects.Component

Methods

toManagedPtr :: Component -> ManagedPtr Component

TypedObject Component

Defined in GI.IBus.Objects.Component

Methods

glibType :: IO GType

HasParentTypes Component

Defined in GI.IBus.Objects.Component

IsGValue (Maybe Component)

Convert Component to and from GValue. See toGValue and fromGValue.

Defined in GI.IBus.Objects.Component

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Component -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Component)

type ParentTypes Component

Defined in GI.IBus.Objects.Component

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

class (GObject o, IsDescendantOf Component o) => IsComponent o

Type class for types which can be safely cast to Component, for instance with toComponent.

Instances

(GObject o, IsDescendantOf Component o) => IsComponent o

Defined in GI.IBus.Objects.Component

toComponent :: (MonadIO m, IsComponent o) => o -> m Component

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

Methods

Click to display all available methods, including inherited ones

Methods

addEngine, addObservedPath, bindProperty, bindPropertyFull, checkModification, copy, destroy, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, output, outputEngines, ref, refSink, removeQattachment, runDispose, serializeObject, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getAuthor, getData, getDescription, getEngines, getExec, getHomepage, getLicense, getName, getObservedPaths, getProperty, getQattachment, getQdata, getTextdomain, getVersion.

Setters

setData, setDataFull, setProperty, setQattachment.

addEngine

componentAddEngine

Arguments

:: (HasCallStack, MonadIO m, IsComponent a, IsEngineDesc b)

=> a

component: An Component

-> b

engine: A description of an engine.

-> m ()

Add an engine to Component according to the description in engine.

addObservedPath

componentAddObservedPath

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)

=> a

component: An Component

-> Text

path: Observed path to be added.

-> Bool

accessFs: True for filling the file status; False otherwise.

-> m ()

Add an observed path to Component.

checkModification

componentCheckModification

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)

=> a

component: An Component.

-> m Bool

Returns: True if at least one of the observed paths is modified; False otherwise.

Check whether the observed paths of component is modified.

getAuthor

componentGetAuthor

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)

=> a

component: An Component

-> m Text

Returns: author property in Component

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

getDescription

componentGetDescription

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)

=> a

component: An Component

-> m Text

Returns: description property in Component

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

getEngines

componentGetEngines

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)

=> a

component: An Component.

-> m [EngineDesc]

Returns: A newly allocated GList that contains engines.

Gets the engines of this component.

getExec

componentGetExec

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)

=> a

component: An Component

-> m Text

Returns: exec property in Component

Gets the exec property in Component. It should not be freed.

getHomepage

componentGetHomepage

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)

=> a

component: An Component

-> m Text

Returns: homepage property in Component

Gets the homepage property in Component. It should not be freed.

getLicense

componentGetLicense

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)

=> a

component: An Component

-> m Text

Returns: license property in Component

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

getName

componentGetName

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)

=> a

component: An Component

-> m Text

Returns: name property in Component

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

getObservedPaths

componentGetObservedPaths

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)

=> a

component: An Component.

-> m [ObservedPath]

Returns: A newly allocated GList that contains observed paths.

Gets the observed paths of this component.

getTextdomain

componentGetTextdomain

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)

=> a

component: An Component

-> m Text

Returns: textdomain property in Component

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

getVersion

componentGetVersion

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)

=> a

component: An Component

-> m Text

Returns: version property in Component

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

new

componentNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

name: Name of the component.

-> Text

description: Detailed description of component.

-> Text

version: Component version.

-> Text

license: Distribution license of this component.

-> Text

author: Author(s) of the component.

-> Text

homepage: Homepage of the component.

-> Text

commandLine: path to component executable.

-> Text

textdomain: Domain name for dgettext()

-> m Component

Returns: A newly allocated Component.

Creates a new Component.

newFromFile

componentNewFromFile

Arguments

:: (HasCallStack, MonadIO m)

=> Text

filename: An XML file that contains component information.

-> m Component

Returns: A newly allocated Component.

Creates a new Component from an XML file. Note that a component file usually contains engine descriptions, if it does, engineDescNewFromXmlNode will be called to load the engine descriptions.

newFromXmlNode

componentNewFromXmlNode

Arguments

:: (HasCallStack, MonadIO m)

=> XML

node: Root node of component XML tree.

-> m Component

Returns: A newly allocated Component.

Creates a new Component from an XML tree.

output

componentOutput

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)

=> a

component: An Component.

-> String

output: GString that holds the result.

-> Int32

indent: level of indent.

-> m ()

Output Component as an XML-formatted string. The output string can be then shown on the screen or written to file.

outputEngines

componentOutputEngines

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)

=> a

component: An Component.

-> String

output: GString that holds the result.

-> Int32

indent: level of indent.

-> m ()

Output engine description as an XML-formatted string. The output string can be then shown on the screen or written to file.

Properties

author

The author of component

constructComponentAuthor :: (IsComponent 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.

getComponentAuthor :: (MonadIO m, IsComponent o) => o -> m Text

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

get component #author

commandLine

The exec path of component

constructComponentCommandLine :: (IsComponent o, MonadIO m) => Text -> m (GValueConstruct o)

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

getComponentCommandLine :: (MonadIO m, IsComponent o) => o -> m (Maybe Text)

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

get component #commandLine

description

The description of component

constructComponentDescription :: (IsComponent 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.

getComponentDescription :: (MonadIO m, IsComponent o) => o -> m Text

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

get component #description

homepage

The homepage of component

constructComponentHomepage :: (IsComponent o, MonadIO m) => Text -> m (GValueConstruct o)

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

getComponentHomepage :: (MonadIO m, IsComponent o) => o -> m Text

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

get component #homepage

license

The license of component

constructComponentLicense :: (IsComponent 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.

getComponentLicense :: (MonadIO m, IsComponent o) => o -> m Text

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

get component #license

name

The name of component

constructComponentName :: (IsComponent 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.

getComponentName :: (MonadIO m, IsComponent o) => o -> m Text

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

get component #name

textdomain

The textdomain of component

constructComponentTextdomain :: (IsComponent 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.

getComponentTextdomain :: (MonadIO m, IsComponent o) => o -> m Text

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

get component #textdomain

version

The version of component

constructComponentVersion :: (IsComponent 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.

getComponentVersion :: (MonadIO m, IsComponent o) => o -> m Text

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

get component #version