gi-ibus-1.5.4: IBus bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.IBus.Objects.ConfigService

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

Exported types

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

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.