glib-2.0/gio/gsettingsschema.h

0001 /*
0002  * Copyright © 2010 Codethink Limited
0003  * Copyright © 2011 Canonical Limited
0004  *
0005  * SPDX-License-Identifier: LGPL-2.1-or-later
0006  *
0007  * This library is free software; you can redistribute it and/or
0008  * modify it under the terms of the GNU Lesser General Public
0009  * License as published by the Free Software Foundation; either
0010  * version 2.1 of the License, or (at your option) any later version.
0011  *
0012  * This library is distributed in the hope that it will be useful,
0013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0015  * Lesser General Public License for more details.
0016  *
0017  * You should have received a copy of the GNU Lesser General Public
0018  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
0019  */
0020
0021 #ifndef __G_SETTINGS_SCHEMA_H__
0022 #define __G_SETTINGS_SCHEMA_H__
0023
0024 #include <glib-object.h>
0025 #include <gio/gio-visibility.h>
0026
0027 G_BEGIN_DECLS
0028
0029 typedef struct _GSettingsSchemaSource                       GSettingsSchemaSource;
0030 typedef struct _GSettingsSchema                             GSettingsSchema;
0031 typedef struct _GSettingsSchemaKey                          GSettingsSchemaKey;
0032
0033 #define                 G_TYPE_SETTINGS_SCHEMA_SOURCE                   (g_settings_schema_source_get_type ())
0034 GIO_AVAILABLE_IN_2_32
0035 GType                   g_settings_schema_source_get_type               (void) G_GNUC_CONST;
0036
0037 GIO_AVAILABLE_IN_2_32
0038 GSettingsSchemaSource * g_settings_schema_source_get_default            (void);
0039 GIO_AVAILABLE_IN_2_32
0040 GSettingsSchemaSource * g_settings_schema_source_ref                    (GSettingsSchemaSource  *source);
0041 GIO_AVAILABLE_IN_2_32
0042 void                    g_settings_schema_source_unref                  (GSettingsSchemaSource  *source);
0043
0044 GIO_AVAILABLE_IN_2_32
0045 GSettingsSchemaSource * g_settings_schema_source_new_from_directory     (const gchar            *directory,
0046                                                                          GSettingsSchemaSource  *parent,
0047                                                                          gboolean                trusted,
0048                                                                          GError                **error);
0049
0050 GIO_AVAILABLE_IN_2_32
0051 GSettingsSchema *       g_settings_schema_source_lookup                 (GSettingsSchemaSource  *source,
0052                                                                          const gchar            *schema_id,
0053                                                                          gboolean                recursive);
0054
0055 GIO_AVAILABLE_IN_2_40
0056 void                    g_settings_schema_source_list_schemas           (GSettingsSchemaSource   *source,
0057                                                                          gboolean                 recursive,
0058                                                                          gchar                 ***non_relocatable,
0059                                                                          gchar                 ***relocatable);
0060
0061 #define                 G_TYPE_SETTINGS_SCHEMA                          (g_settings_schema_get_type ())
0062 GIO_AVAILABLE_IN_2_32
0063 GType                   g_settings_schema_get_type                      (void) G_GNUC_CONST;
0064
0065 GIO_AVAILABLE_IN_2_32
0066 GSettingsSchema *       g_settings_schema_ref                           (GSettingsSchema        *schema);
0067 GIO_AVAILABLE_IN_2_32
0068 void                    g_settings_schema_unref                         (GSettingsSchema        *schema);
0069
0070 GIO_AVAILABLE_IN_2_32
0071 const gchar *           g_settings_schema_get_id                        (GSettingsSchema        *schema);
0072 GIO_AVAILABLE_IN_2_32
0073 const gchar *           g_settings_schema_get_path                      (GSettingsSchema        *schema);
0074 GIO_AVAILABLE_IN_2_40
0075 GSettingsSchemaKey *    g_settings_schema_get_key                       (GSettingsSchema        *schema,
0076                                                                          const gchar            *name);
0077 GIO_AVAILABLE_IN_2_40
0078 gboolean                g_settings_schema_has_key                       (GSettingsSchema        *schema,
0079                                                                          const gchar            *name);
0080 GIO_AVAILABLE_IN_2_46
0081 gchar**                 g_settings_schema_list_keys                     (GSettingsSchema        *schema);
0082
0083
0084 GIO_AVAILABLE_IN_2_44
0085 gchar **                g_settings_schema_list_children                 (GSettingsSchema        *schema);
0086
0087 #define                 G_TYPE_SETTINGS_SCHEMA_KEY                      (g_settings_schema_key_get_type ())
0088 GIO_AVAILABLE_IN_2_40
0089 GType                   g_settings_schema_key_get_type                  (void) G_GNUC_CONST;
0090
0091 GIO_AVAILABLE_IN_2_40
0092 GSettingsSchemaKey *    g_settings_schema_key_ref                       (GSettingsSchemaKey     *key);
0093 GIO_AVAILABLE_IN_2_40
0094 void                    g_settings_schema_key_unref                     (GSettingsSchemaKey     *key);
0095
0096 GIO_AVAILABLE_IN_2_40
0097 const GVariantType *    g_settings_schema_key_get_value_type            (GSettingsSchemaKey     *key);
0098 GIO_AVAILABLE_IN_2_40
0099 GVariant *              g_settings_schema_key_get_default_value         (GSettingsSchemaKey     *key);
0100 GIO_AVAILABLE_IN_2_40
0101 GVariant *              g_settings_schema_key_get_range                 (GSettingsSchemaKey     *key);
0102 GIO_AVAILABLE_IN_2_40
0103 gboolean                g_settings_schema_key_range_check               (GSettingsSchemaKey     *key,
0104                                                                          GVariant               *value);
0105
0106 GIO_AVAILABLE_IN_2_44
0107 const gchar *           g_settings_schema_key_get_name                  (GSettingsSchemaKey     *key);
0108 GIO_AVAILABLE_IN_2_40
0109 const gchar *           g_settings_schema_key_get_summary               (GSettingsSchemaKey     *key);
0110 GIO_AVAILABLE_IN_2_40
0111 const gchar *           g_settings_schema_key_get_description           (GSettingsSchemaKey     *key);
0112
0113 G_END_DECLS
0114
0115 #endif /* __G_SETTINGS_SCHEMA_H__ */