Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.IBus.Objects.Component

Contents

Exported types
Methods
Properties

Description

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>

Synopsis

newtype Component = Component (ManagedPtr Component)
class (GObject o, IsDescendantOf Component o) => IsComponent o
toComponent :: (MonadIO m, IsComponent o) => o -> m Component
componentAddEngine :: (HasCallStack, MonadIO m, IsComponent a, IsEngineDesc b) => a -> b -> m ()
componentAddObservedPath :: (HasCallStack, MonadIO m, IsComponent a) => a -> Text -> Bool -> m ()
componentCheckModification :: (HasCallStack, MonadIO m, IsComponent a) => a -> m Bool
componentGetAuthor :: (HasCallStack, MonadIO m, IsComponent a) => a -> m Text
componentGetDescription :: (HasCallStack, MonadIO m, IsComponent a) => a -> m Text
componentGetEngines :: (HasCallStack, MonadIO m, IsComponent a) => a -> m [EngineDesc]
componentGetExec :: (HasCallStack, MonadIO m, IsComponent a) => a -> m Text
componentGetHomepage :: (HasCallStack, MonadIO m, IsComponent a) => a -> m Text
componentGetLicense :: (HasCallStack, MonadIO m, IsComponent a) => a -> m Text
componentGetName :: (HasCallStack, MonadIO m, IsComponent a) => a -> m Text
componentGetObservedPaths :: (HasCallStack, MonadIO m, IsComponent a) => a -> m [ObservedPath]
componentGetTextdomain :: (HasCallStack, MonadIO m, IsComponent a) => a -> m Text
componentGetVersion :: (HasCallStack, MonadIO m, IsComponent a) => a -> m Text
componentNew :: (HasCallStack, MonadIO m) => Text -> Text -> Text -> Text -> Text -> Text -> Text -> Text -> m Component
componentNewFromFile :: (HasCallStack, MonadIO m) => Text -> m Component
componentNewFromXmlNode :: (HasCallStack, MonadIO m) => XML -> m Component
componentOutput :: (HasCallStack, MonadIO m, IsComponent a) => a -> String -> Int32 -> m ()
componentOutputEngines :: (HasCallStack, MonadIO m, IsComponent a) => a -> String -> Int32 -> m ()
constructComponentAuthor :: (IsComponent o, MonadIO m) => Text -> m (GValueConstruct o)
getComponentAuthor :: (MonadIO m, IsComponent o) => o -> m Text
constructComponentCommandLine :: (IsComponent o, MonadIO m) => Text -> m (GValueConstruct o)
getComponentCommandLine :: (MonadIO m, IsComponent o) => o -> m (Maybe Text)
constructComponentDescription :: (IsComponent o, MonadIO m) => Text -> m (GValueConstruct o)
getComponentDescription :: (MonadIO m, IsComponent o) => o -> m Text
constructComponentHomepage :: (IsComponent o, MonadIO m) => Text -> m (GValueConstruct o)
getComponentHomepage :: (MonadIO m, IsComponent o) => o -> m Text
constructComponentLicense :: (IsComponent o, MonadIO m) => Text -> m (GValueConstruct o)
getComponentLicense :: (MonadIO m, IsComponent o) => o -> m Text
constructComponentName :: (IsComponent o, MonadIO m) => Text -> m (GValueConstruct o)
getComponentName :: (MonadIO m, IsComponent o) => o -> m Text
constructComponentTextdomain :: (IsComponent o, MonadIO m) => Text -> m (GValueConstruct o)
getComponentTextdomain :: (MonadIO m, IsComponent o) => o -> m Text
constructComponentVersion :: (IsComponent o, MonadIO m) => Text -> m (GValueConstruct o)
getComponentVersion :: (MonadIO m, IsComponent o) => o -> m Text

Exported types

newtype Component Source #

Memory-managed wrapper type.

Constructors

Component (ManagedPtr Component)

Instances

Instances details

Eq Component Source #
Instance details Defined in GI.IBus.Objects.Component Methods (==) :: Component -> Component -> Bool # (/=) :: Component -> Component -> Bool #
GObject Component Source #
Instance details Defined in GI.IBus.Objects.Component
ManagedPtrNewtype Component Source #
Instance details Defined in GI.IBus.Objects.Component Methods toManagedPtr :: Component -> ManagedPtr Component
TypedObject Component Source #
Instance details Defined in GI.IBus.Objects.Component Methods glibType :: IO GType
HasParentTypes Component Source #
Instance details Defined in GI.IBus.Objects.Component
IsGValue (Maybe Component) Source #	Convert `Component` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details 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 Source #
Instance details Defined in GI.IBus.Objects.Component type ParentTypes Component = '[Serializable, Object, Object]

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

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

Instances

Instances details

(GObject o, IsDescendantOf Component o) => IsComponent o Source #
Instance details Defined in GI.IBus.Objects.Component

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

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

Expand

addEngine

componentAddEngine Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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) Source #

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 Source #

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) Source #

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) Source #

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) Source #

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 Source #

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) Source #

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 Source #

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) Source #

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 Source #

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) Source #

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 Source #

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) Source #

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 Source #

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) Source #

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 Source #

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

get component #version

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

addEngine

addObservedPath

checkModification

getAuthor

getDescription

getEngines

getExec

getHomepage

getLicense

getName

getObservedPaths

getTextdomain

getVersion

new

newFromFile

newFromXmlNode

output

outputEngines

Properties

author

commandLine

description

homepage

license

name

textdomain

version