244 lines
8.9 KiB
C
244 lines
8.9 KiB
C
/* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
|
|
/* vim:set et sts=4: */
|
|
/* ibus - The Input Bus
|
|
* Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
|
|
* Copyright (C) 2008-2013 Red Hat, Inc.
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
|
|
* USA
|
|
*/
|
|
|
|
#if !defined (__IBUS_H_INSIDE__) && !defined (IBUS_COMPILATION)
|
|
#error "Only <ibus.h> can be included directly"
|
|
#endif
|
|
|
|
#ifndef __IBUS_CONFIG_SERVICE_H_
|
|
#define __IBUS_CONFIG_SERVICE_H_
|
|
|
|
/**
|
|
* SECTION: ibusconfigservice
|
|
* @short_description: Configuration service back-end.
|
|
* @stability: Stable
|
|
*
|
|
* 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>
|
|
*/
|
|
|
|
#include "ibusservice.h"
|
|
|
|
/*
|
|
* Type macros.
|
|
*/
|
|
|
|
/* define GOBJECT macros */
|
|
#define IBUS_TYPE_CONFIG_SERVICE \
|
|
(ibus_config_service_get_type ())
|
|
#define IBUS_CONFIG_SERVICE(obj) \
|
|
(G_TYPE_CHECK_INSTANCE_CAST ((obj), IBUS_TYPE_CONFIG_SERVICE, IBusConfigService))
|
|
#define IBUS_CONFIG_SERVICE_CLASS(klass) \
|
|
(G_TYPE_CHECK_CLASS_CAST ((klass), IBUS_TYPE_CONFIG_SERVICE, IBusConfigServiceClass))
|
|
#define IBUS_IS_CONFIG_SERVICE(obj) \
|
|
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), IBUS_TYPE_CONFIG_SERVICE))
|
|
#define IBUS_IS_CONFIG_SERVICE_CLASS(klass) \
|
|
(G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_CONFIG_SERVICE))
|
|
#define IBUS_CONFIG_SERVICE_GET_CLASS(obj) \
|
|
(G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_CONFIG_SERVICE, IBusConfigServiceClass))
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
typedef struct _IBusConfigService IBusConfigService;
|
|
typedef struct _IBusConfigServiceClass IBusConfigServiceClass;
|
|
|
|
/**
|
|
* IBusConfigService:
|
|
*
|
|
* An opaque data type representing a configure service.
|
|
*/
|
|
struct _IBusConfigService {
|
|
/*< private >*/
|
|
IBusService parent;
|
|
/* IBusConfigServicePriv *priv */
|
|
|
|
/* instance members */
|
|
};
|
|
|
|
struct _IBusConfigServiceClass {
|
|
/*< private >*/
|
|
IBusServiceClass parent;
|
|
|
|
/*< public >*/
|
|
/* class members */
|
|
gboolean (* set_value) (IBusConfigService *config,
|
|
const gchar *section,
|
|
const gchar *name,
|
|
GVariant *value,
|
|
GError **error);
|
|
/**
|
|
* get_value:
|
|
* @config: An #IBusConfig.
|
|
* @section: section name
|
|
* @name: value name
|
|
*
|
|
* Returns: (transfer full): The value in config associated with section
|
|
* and name.
|
|
*/
|
|
GVariant * (* get_value) (IBusConfigService *config,
|
|
const gchar *section,
|
|
const gchar *name,
|
|
GError **error);
|
|
gboolean (* unset_value) (IBusConfigService *config,
|
|
const gchar *section,
|
|
const gchar *name,
|
|
GError **error);
|
|
GVariant * (* get_values) (IBusConfigService *config,
|
|
const gchar *section,
|
|
GError **error);
|
|
|
|
/*< private >*/
|
|
/* padding */
|
|
gpointer pdummy[12];
|
|
};
|
|
|
|
GType ibus_config_service_get_type (void);
|
|
|
|
/**
|
|
* ibus_config_service_new:
|
|
* @connection: An #GDBusConnection.
|
|
*
|
|
* Creates an new #IBusConfigService from an #GDBusConnection.
|
|
*
|
|
* Returns: A newly allocated #IBusConfigServices.
|
|
*/
|
|
IBusConfigService *ibus_config_service_new (GDBusConnection *connection);
|
|
|
|
/**
|
|
* ibus_config_service_value_changed:
|
|
* @config: An IBusConfigService.
|
|
* @section: Section name of the configuration option.
|
|
* @name: Name of the configure option.
|
|
* @value: GVariant that holds the value.
|
|
*
|
|
* Change a value of a configuration option
|
|
* by sending a "ValueChanged" message to IBus service.
|
|
*/
|
|
void ibus_config_service_value_changed
|
|
(IBusConfigService *config,
|
|
const gchar *section,
|
|
const gchar *name,
|
|
GVariant *value);
|
|
|
|
G_END_DECLS
|
|
#endif
|
|
|