gio/gsettingsschema.h

   1 /*
   2  * Copyright © 2010 Codethink Limited
   3  * Copyright © 2011 Canonical Limited
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the licence, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifndef __G_SETTINGS_SCHEMA_H__
  22 #define __G_SETTINGS_SCHEMA_H__
  23
  24 #include <glib-object.h>
  25
  26 G_BEGIN_DECLS
  27
  28 typedef struct _GSettingsSchemaSource                       GSettingsSchemaSource;
  29 typedef struct _GSettingsSchema                             GSettingsSchema;
  30 typedef struct _GSettingsSchemaKey                          GSettingsSchemaKey;
  31
  32 #define                 G_TYPE_SETTINGS_SCHEMA_SOURCE                   (g_settings_schema_source_get_type ())
  33 GLIB_AVAILABLE_IN_2_32
  34 GType                   g_settings_schema_source_get_type               (void) G_GNUC_CONST;
  35
  36 GLIB_AVAILABLE_IN_2_32
  37 GSettingsSchemaSource * g_settings_schema_source_get_default            (void);
  38 GLIB_AVAILABLE_IN_2_32
  39 GSettingsSchemaSource * g_settings_schema_source_ref                    (GSettingsSchemaSource  *source);
  40 GLIB_AVAILABLE_IN_2_32
  41 void                    g_settings_schema_source_unref                  (GSettingsSchemaSource  *source);
  42
  43 GLIB_AVAILABLE_IN_2_32
  44 GSettingsSchemaSource * g_settings_schema_source_new_from_directory     (const gchar            *directory,
  45                                                                          GSettingsSchemaSource  *parent,
  46                                                                          gboolean                trusted,
  47                                                                          GError                **error);
  48
  49 GLIB_AVAILABLE_IN_2_32
  50 GSettingsSchema *       g_settings_schema_source_lookup                 (GSettingsSchemaSource  *source,
  51                                                                          const gchar            *schema_id,
  52                                                                          gboolean                recursive);
  53
  54 GLIB_AVAILABLE_IN_2_40
  55 void                    g_settings_schema_source_list_schemas           (GSettingsSchemaSource   *source,
  56                                                                          gboolean                 recursive,
  57                                                                          gchar                 ***non_relocatable,
  58                                                                          gchar                 ***relocatable);
  59
  60 #define                 G_TYPE_SETTINGS_SCHEMA                          (g_settings_schema_get_type ())
  61 GLIB_AVAILABLE_IN_2_32
  62 GType                   g_settings_schema_get_type                      (void) G_GNUC_CONST;
  63
  64 GLIB_AVAILABLE_IN_2_32
  65 GSettingsSchema *       g_settings_schema_ref                           (GSettingsSchema        *schema);
  66 GLIB_AVAILABLE_IN_2_32
  67 void                    g_settings_schema_unref                         (GSettingsSchema        *schema);
  68
  69 GLIB_AVAILABLE_IN_2_32
  70 const gchar *           g_settings_schema_get_id                        (GSettingsSchema        *schema);
  71 GLIB_AVAILABLE_IN_2_32
  72 const gchar *           g_settings_schema_get_path                      (GSettingsSchema        *schema);
  73 GLIB_AVAILABLE_IN_2_40
  74 GSettingsSchemaKey *    g_settings_schema_get_key                       (GSettingsSchema        *schema,
  75                                                                          const gchar            *name);
  76 GLIB_AVAILABLE_IN_2_40
  77 gboolean                g_settings_schema_has_key                       (GSettingsSchema        *schema,
  78                                                                          const gchar            *name);
  79
  80 #define                 G_TYPE_SETTINGS_SCHEMA_KEY                      (g_settings_schema_key_get_type ())
  81 GLIB_AVAILABLE_IN_2_40
  82 GType                   g_settings_schema_key_get_type                  (void) G_GNUC_CONST;
  83
  84 GLIB_AVAILABLE_IN_2_40
  85 GSettingsSchemaKey *    g_settings_schema_key_ref                       (GSettingsSchemaKey     *key);
  86 GLIB_AVAILABLE_IN_2_40
  87 void                    g_settings_schema_key_unref                     (GSettingsSchemaKey     *key);
  88
  89 GLIB_AVAILABLE_IN_2_40
  90 const GVariantType *    g_settings_schema_key_get_value_type            (GSettingsSchemaKey     *key);
  91 GLIB_AVAILABLE_IN_2_40
  92 GVariant *              g_settings_schema_key_get_default_value         (GSettingsSchemaKey     *key);
  93 GLIB_AVAILABLE_IN_2_40
  94 GVariant *              g_settings_schema_key_get_range                 (GSettingsSchemaKey     *key);
  95 GLIB_AVAILABLE_IN_2_40
  96 gboolean                g_settings_schema_key_range_check               (GSettingsSchemaKey     *key,
  97                                                                          GVariant               *value);
  98
  99 GLIB_AVAILABLE_IN_2_40
 100 const gchar *           g_settings_schema_key_get_summary               (GSettingsSchemaKey     *key);
 101 GLIB_AVAILABLE_IN_2_40
 102 const gchar *           g_settings_schema_key_get_description           (GSettingsSchemaKey     *key);
 103
 104 G_END_DECLS
 105
 106 #endif /* __G_SETTINGS_SCHEMA_H__ */