/usr/include/d/gtkd-3/gio/SettingsSchema.d is in libgtkd-3-dev 3.7.5-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 | /*
* This file is part of gtkD.
*
* gtkD 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 3
* of the License, or (at your option) any later version, with
* some exceptions, please read the COPYING file.
*
* gtkD 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 gtkD; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
*/
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage
module gio.SettingsSchema;
private import gio.SettingsSchemaKey;
private import gio.c.functions;
public import gio.c.types;
private import glib.Str;
private import gobject.ObjectG;
public import gtkc.giotypes;
private import gtkd.Loader;
/**
* The #GSettingsSchemaSource and #GSettingsSchema APIs provide a
* mechanism for advanced control over the loading of schemas and a
* mechanism for introspecting their content.
*
* Plugin loading systems that wish to provide plugins a way to access
* settings face the problem of how to make the schemas for these
* settings visible to GSettings. Typically, a plugin will want to ship
* the schema along with itself and it won't be installed into the
* standard system directories for schemas.
*
* #GSettingsSchemaSource provides a mechanism for dealing with this by
* allowing the creation of a new 'schema source' from which schemas can
* be acquired. This schema source can then become part of the metadata
* associated with the plugin and queried whenever the plugin requires
* access to some settings.
*
* Consider the following example:
*
* |[<!-- language="C" -->
* typedef struct
* {
* ...
* GSettingsSchemaSource *schema_source;
* ...
* } Plugin;
*
* Plugin *
* initialise_plugin (const gchar *dir)
* {
* Plugin *plugin;
*
* ...
*
* plugin->schema_source =
* g_settings_new_schema_source_from_directory (dir,
* g_settings_schema_source_get_default (), FALSE, NULL);
*
* ...
*
* return plugin;
* }
*
* ...
*
* GSettings *
* plugin_get_settings (Plugin *plugin,
* const gchar *schema_id)
* {
* GSettingsSchema *schema;
*
* if (schema_id == NULL)
* schema_id = plugin->identifier;
*
* schema = g_settings_schema_source_lookup (plugin->schema_source,
* schema_id, FALSE);
*
* if (schema == NULL)
* {
* ... disable the plugin or abort, etc ...
* }
*
* return g_settings_new_full (schema, NULL, NULL);
* }
* ]|
*
* The code above shows how hooks should be added to the code that
* initialises (or enables) the plugin to create the schema source and
* how an API can be added to the plugin system to provide a convenient
* way for the plugin to access its settings, using the schemas that it
* ships.
*
* From the standpoint of the plugin, it would need to ensure that it
* ships a gschemas.compiled file as part of itself, and then simply do
* the following:
*
* |[<!-- language="C" -->
* {
* GSettings *settings;
* gint some_value;
*
* settings = plugin_get_settings (self, NULL);
* some_value = g_settings_get_int (settings, "some-value");
* ...
* }
* ]|
*
* It's also possible that the plugin system expects the schema source
* files (ie: .gschema.xml files) instead of a gschemas.compiled file.
* In that case, the plugin loading system must compile the schemas for
* itself before attempting to create the settings source.
*
* Since: 2.32
*/
public class SettingsSchema
{
/** the main Gtk struct */
protected GSettingsSchema* gSettingsSchema;
protected bool ownedRef;
/** Get the main Gtk struct */
public GSettingsSchema* getSettingsSchemaStruct(bool transferOwnership = false)
{
if (transferOwnership)
ownedRef = false;
return gSettingsSchema;
}
/** the main Gtk struct as a void* */
protected void* getStruct()
{
return cast(void*)gSettingsSchema;
}
/**
* Sets our main struct and passes it to the parent class.
*/
public this (GSettingsSchema* gSettingsSchema, bool ownedRef = false)
{
this.gSettingsSchema = gSettingsSchema;
this.ownedRef = ownedRef;
}
~this ()
{
if ( Linker.isLoaded(LIBRARY_GIO) && ownedRef )
g_settings_schema_unref(gSettingsSchema);
}
/** */
public static GType getType()
{
return g_settings_schema_get_type();
}
/**
* Get the ID of @schema.
*
* Returns: the ID
*/
public string getId()
{
return Str.toString(g_settings_schema_get_id(gSettingsSchema));
}
/**
* Gets the key named @name from @schema.
*
* It is a programmer error to request a key that does not exist. See
* g_settings_schema_list_keys().
*
* Params:
* name = the name of a key
*
* Returns: the #GSettingsSchemaKey for @name
*
* Since: 2.40
*/
public SettingsSchemaKey getKey(string name)
{
auto p = g_settings_schema_get_key(gSettingsSchema, Str.toStringz(name));
if(p is null)
{
return null;
}
return ObjectG.getDObject!(SettingsSchemaKey)(cast(GSettingsSchemaKey*) p, true);
}
/**
* Gets the path associated with @schema, or %NULL.
*
* Schemas may be single-instance or relocatable. Single-instance
* schemas correspond to exactly one set of keys in the backend
* database: those located at the path returned by this function.
*
* Relocatable schemas can be referenced by other schemas and can
* threfore describe multiple sets of keys at different locations. For
* relocatable schemas, this function will return %NULL.
*
* Returns: the path of the schema, or %NULL
*
* Since: 2.32
*/
public string getPath()
{
return Str.toString(g_settings_schema_get_path(gSettingsSchema));
}
/**
* Checks if @schema has a key named @name.
*
* Params:
* name = the name of a key
*
* Returns: %TRUE if such a key exists
*
* Since: 2.40
*/
public bool hasKey(string name)
{
return g_settings_schema_has_key(gSettingsSchema, Str.toStringz(name)) != 0;
}
/**
* Gets the list of children in @schema.
*
* You should free the return value with g_strfreev() when you are done
* with it.
*
* Returns: a list of the children on @settings
*
* Since: 2.44
*/
public string[] listChildren()
{
auto retStr = g_settings_schema_list_children(gSettingsSchema);
scope(exit) Str.freeStringArray(retStr);
return Str.toStringArray(retStr);
}
/**
* Introspects the list of keys on @schema.
*
* You should probably not be calling this function from "normal" code
* (since you should already know what keys are in your schema). This
* function is intended for introspection reasons.
*
* Returns: a list of the keys on
* @schema
*
* Since: 2.46
*/
public string[] listKeys()
{
auto retStr = g_settings_schema_list_keys(gSettingsSchema);
scope(exit) Str.freeStringArray(retStr);
return Str.toStringArray(retStr);
}
/**
* Increase the reference count of @schema, returning a new reference.
*
* Returns: a new reference to @schema
*
* Since: 2.32
*/
public SettingsSchema doref()
{
auto p = g_settings_schema_ref(gSettingsSchema);
if(p is null)
{
return null;
}
return ObjectG.getDObject!(SettingsSchema)(cast(GSettingsSchema*) p, true);
}
/**
* Decrease the reference count of @schema, possibly freeing it.
*
* Since: 2.32
*/
public void unref()
{
g_settings_schema_unref(gSettingsSchema);
}
}
|