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

GI.IBus.Objects.ConfigService

Contents

Exported types
Methods

Description

An IBusConfigService is a base class for other configuration services such as GConf. Currently, directly known sub class is IBusConfigGConf.

IBusConfigServiceClass has following member functions: <itemizedlist> <listitem> <para>gboolean set_value(IBusConfigService *config, const gchar *section, const gchar *name, const GValue *value, IBusError **error) </para> <variablelist> <varlistentry> <term>config:</term> <listitem>A configure service</listitem> </varlistentry> <varlistentry> <term>section:</term> <listitem>Section name of the configuration option.</listitem> </varlistentry> <varlistentry> <term>name:</term> <listitem>Name of the configuration option.</listitem> </varlistentry> <varlistentry> <term>value:</term> <listitem>GValue that holds the value.</listitem> </varlistentry> <varlistentry> <term>error:</term> <listitem>Error outputs here.</listitem> </varlistentry> <varlistentry> <term>Returns:</term> <listitem>TRUE if succeed; FALSE otherwise.</listitem> </varlistentry> </variablelist> <para>Set a value to a configuration option. </para> </listitem> <listitem> <para>gboolean get_value(IBusConfigService *config, const gchar *section, const gchar *name, GValue *value, IBusError **error) </para> <variablelist> <varlistentry> <term>config:</term> <listitem>A configure service</listitem> </varlistentry> <varlistentry> <term>section:</term> <listitem>Section name of the configuration option.</listitem> </varlistentry> <varlistentry> <term>name:</term> <listitem>Name of the configuration option.</listitem> </varlistentry> <varlistentry> <term>value:</term> <listitem>GValue that holds the value.</listitem> </varlistentry> <varlistentry> <term>error:</term> <listitem>Error outputs here.</listitem> </varlistentry> <varlistentry> <term>Returns:</term> <listitem>TRUE if succeed; FALSE otherwise.</listitem> </varlistentry> </variablelist> <para>Get value of a configuration option. </para> </listitem> <listitem> <para>gboolean unset(IBusConfigService *config, const gchar *section, const gchar *name, IBusError **error) </para> <variablelist> <varlistentry> <term>config:</term> <listitem>A configure service</listitem> </varlistentry> <varlistentry> <term>section:</term> <listitem>Section name of the configuration option.</listitem> </varlistentry> <varlistentry> <term>name:</term> <listitem>Name of the configuration option.</listitem> </varlistentry> <varlistentry> <term>error:</term> <listitem>Error outputs here.</listitem> </varlistentry> <varlistentry> <term>Returns:</term> <listitem>TRUE if succeed; FALSE otherwise.</listitem> </varlistentry> </variablelist> <para>Remove an entry to a configuration option. </para> </listitem> </itemizedlist>

Synopsis

newtype ConfigService = ConfigService (ManagedPtr ConfigService)
class (GObject o, IsDescendantOf ConfigService o) => IsConfigService o
toConfigService :: (MonadIO m, IsConfigService o) => o -> m ConfigService
configServiceNew :: (HasCallStack, MonadIO m, IsDBusConnection a) => a -> m ConfigService
configServiceValueChanged :: (HasCallStack, MonadIO m, IsConfigService a) => a -> Text -> Text -> GVariant -> m ()

Exported types

newtype ConfigService Source #

Memory-managed wrapper type.

Constructors

ConfigService (ManagedPtr ConfigService)

Instances

Instances details

Eq ConfigService Source #
Instance details Defined in GI.IBus.Objects.ConfigService Methods (==) :: ConfigService -> ConfigService -> Bool (/=) :: ConfigService -> ConfigService -> Bool
GObject ConfigService Source #
Instance details Defined in GI.IBus.Objects.ConfigService
ManagedPtrNewtype ConfigService Source #
Instance details Defined in GI.IBus.Objects.ConfigService Methods toManagedPtr :: ConfigService -> ManagedPtr ConfigService
TypedObject ConfigService Source #
Instance details Defined in GI.IBus.Objects.ConfigService Methods glibType :: IO GType
IsGValue ConfigService Source #	Convert `ConfigService` to and from `GValue` with `toGValue` and `fromGValue`.
Instance details Defined in GI.IBus.Objects.ConfigService Methods toGValue :: ConfigService -> IO GValue fromGValue :: GValue -> IO ConfigService
HasParentTypes ConfigService Source #
Instance details Defined in GI.IBus.Objects.ConfigService
type ParentTypes ConfigService Source #
Instance details Defined in GI.IBus.Objects.ConfigService type ParentTypes ConfigService = '[Service, Object, Object]

class (GObject o, IsDescendantOf ConfigService o) => IsConfigService o Source #

Type class for types which can be safely cast to ConfigService, for instance with toConfigService.

Instances

Instances details

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

toConfigService :: (MonadIO m, IsConfigService o) => o -> m ConfigService Source #

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

Methods

Overloaded methods

new

configServiceNew Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusConnection a)
=> a	`connection`: An `DBusConnection`.
-> m ConfigService	Returns: A newly allocated `IBusConfigServices`.

Creates an new ConfigService from an DBusConnection.

valueChanged

configServiceValueChanged Source #

Arguments

:: (HasCallStack, MonadIO m, IsConfigService a)
=> a	`config`: An IBusConfigService.
-> Text	`section`: Section name of the configuration option.
-> Text	`name`: Name of the configure option.
-> GVariant	`value`: GVariant that holds the value.
-> m ()

Change a value of a configuration option by sending a "ValueChanged" message to IBus service.