1 /* 2 * This file is part of gtkD. 3 * 4 * gtkD is free software; you can redistribute it and/or modify 5 * it under the terms of the GNU Lesser General Public License 6 * as published by the Free Software Foundation; either version 3 7 * of the License, or (at your option) any later version, with 8 * some exceptions, please read the COPYING file. 9 * 10 * gtkD 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 13 * GNU Lesser General Public License for more details. 14 * 15 * You should have received a copy of the GNU Lesser General Public License 16 * along with gtkD; if not, write to the Free Software 17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA 18 */ 19 20 // generated automatically - do not change 21 // find conversion definition on APILookup.txt 22 // implement new conversion functionalities on the wrap.utils pakage 23 24 25 module gio.Settings; 26 27 private import gio.Action; 28 private import gio.ActionIF; 29 private import gio.SettingsSchema; 30 private import glib.ConstructionException; 31 private import glib.Str; 32 private import glib.Variant; 33 private import gobject.ObjectG; 34 private import gobject.Signals; 35 public import gtkc.gdktypes; 36 private import gtkc.gio; 37 public import gtkc.giotypes; 38 39 40 /** 41 * The #GSettings class provides a convenient API for storing and retrieving 42 * application settings. 43 * 44 * Reads and writes can be considered to be non-blocking. Reading 45 * settings with #GSettings is typically extremely fast: on 46 * approximately the same order of magnitude (but slower than) a 47 * #GHashTable lookup. Writing settings is also extremely fast in terms 48 * of time to return to your application, but can be extremely expensive 49 * for other threads and other processes. Many settings backends 50 * (including dconf) have lazy initialisation which means in the common 51 * case of the user using their computer without modifying any settings 52 * a lot of work can be avoided. For dconf, the D-Bus service doesn't 53 * even need to be started in this case. For this reason, you should 54 * only ever modify #GSettings keys in response to explicit user action. 55 * Particular care should be paid to ensure that modifications are not 56 * made during startup -- for example, when setting the initial value 57 * of preferences widgets. The built-in g_settings_bind() functionality 58 * is careful not to write settings in response to notify signals as a 59 * result of modifications that it makes to widgets. 60 * 61 * When creating a GSettings instance, you have to specify a schema 62 * that describes the keys in your settings and their types and default 63 * values, as well as some other information. 64 * 65 * Normally, a schema has as fixed path that determines where the settings 66 * are stored in the conceptual global tree of settings. However, schemas 67 * can also be '[relocatable][gsettings-relocatable]', i.e. not equipped with 68 * a fixed path. This is 69 * useful e.g. when the schema describes an 'account', and you want to be 70 * able to store a arbitrary number of accounts. 71 * 72 * Paths must start with and end with a forward slash character ('/') 73 * and must not contain two sequential slash characters. Paths should 74 * be chosen based on a domain name associated with the program or 75 * library to which the settings belong. Examples of paths are 76 * "/org/gtk/settings/file-chooser/" and "/ca/desrt/dconf-editor/". 77 * Paths should not start with "/apps/", "/desktop/" or "/system/" as 78 * they often did in GConf. 79 * 80 * Unlike other configuration systems (like GConf), GSettings does not 81 * restrict keys to basic types like strings and numbers. GSettings stores 82 * values as #GVariant, and allows any #GVariantType for keys. Key names 83 * are restricted to lowercase characters, numbers and '-'. Furthermore, 84 * the names must begin with a lowercase character, must not end 85 * with a '-', and must not contain consecutive dashes. 86 * 87 * Similar to GConf, the default values in GSettings schemas can be 88 * localized, but the localized values are stored in gettext catalogs 89 * and looked up with the domain that is specified in the 90 * `gettext-domain` attribute of the <schemalist> or <schema> 91 * elements and the category that is specified in the `l10n` attribute of 92 * the <default> element. The string which is translated includes all text in 93 * the <default> element, including any surrounding quotation marks. 94 * 95 * The `l10n` attribute must be set to `messages` or `time`, and sets the 96 * [locale category for 97 * translation](https://www.gnu.org/software/gettext/manual/html_node/Aspects.html#index-locale-categories-1). 98 * The `messages` category should be used by default; use `time` for 99 * translatable date or time formats. A translation comment can be added as an 100 * XML comment immediately above the <default> element — it is recommended to 101 * add these comments to aid translators understand the meaning and 102 * implications of the default value. An optional translation `context` 103 * attribute can be set on the <default> element to disambiguate multiple 104 * defaults which use the same string. 105 * 106 * For example: 107 * |[ 108 * <!-- Translators: A list of words which are not allowed to be typed, in 109 * GVariant serialization syntax. 110 * See: https://developer.gnome.org/glib/stable/gvariant-text.html --> 111 * <default l10n='messages' context='Banned words'>['bad', 'words']</default> 112 * ]| 113 * 114 * Translations of default values must remain syntactically valid serialized 115 * #GVariants (e.g. retaining any surrounding quotation marks) or runtime 116 * errors will occur. 117 * 118 * GSettings uses schemas in a compact binary form that is created 119 * by the [glib-compile-schemas][glib-compile-schemas] 120 * utility. The input is a schema description in an XML format. 121 * 122 * A DTD for the gschema XML format can be found here: 123 * [gschema.dtd](https://git.gnome.org/browse/glib/tree/gio/gschema.dtd) 124 * 125 * The [glib-compile-schemas][glib-compile-schemas] tool expects schema 126 * files to have the extension `.gschema.xml`. 127 * 128 * At runtime, schemas are identified by their id (as specified in the 129 * id attribute of the <schema> element). The convention for schema 130 * ids is to use a dotted name, similar in style to a D-Bus bus name, 131 * e.g. "org.gnome.SessionManager". In particular, if the settings are 132 * for a specific service that owns a D-Bus bus name, the D-Bus bus name 133 * and schema id should match. For schemas which deal with settings not 134 * associated with one named application, the id should not use 135 * StudlyCaps, e.g. "org.gnome.font-rendering". 136 * 137 * In addition to #GVariant types, keys can have types that have 138 * enumerated types. These can be described by a <choice>, 139 * <enum> or <flags> element, as seen in the 140 * [example][schema-enumerated]. The underlying type of such a key 141 * is string, but you can use g_settings_get_enum(), g_settings_set_enum(), 142 * g_settings_get_flags(), g_settings_set_flags() access the numeric values 143 * corresponding to the string value of enum and flags keys. 144 * 145 * An example for default value: 146 * |[ 147 * <schemalist> 148 * <schema id="org.gtk.Test" path="/org/gtk/Test/" gettext-domain="test"> 149 * 150 * <key name="greeting" type="s"> 151 * <default l10n="messages">"Hello, earthlings"</default> 152 * <summary>A greeting</summary> 153 * <description> 154 * Greeting of the invading martians 155 * </description> 156 * </key> 157 * 158 * <key name="box" type="(ii)"> 159 * <default>(20,30)</default> 160 * </key> 161 * 162 * </schema> 163 * </schemalist> 164 * ]| 165 * 166 * An example for ranges, choices and enumerated types: 167 * |[ 168 * <schemalist> 169 * 170 * <enum id="org.gtk.Test.myenum"> 171 * <value nick="first" value="1"/> 172 * <value nick="second" value="2"/> 173 * </enum> 174 * 175 * <flags id="org.gtk.Test.myflags"> 176 * <value nick="flag1" value="1"/> 177 * <value nick="flag2" value="2"/> 178 * <value nick="flag3" value="4"/> 179 * </flags> 180 * 181 * <schema id="org.gtk.Test"> 182 * 183 * <key name="key-with-range" type="i"> 184 * <range min="1" max="100"/> 185 * <default>10</default> 186 * </key> 187 * 188 * <key name="key-with-choices" type="s"> 189 * <choices> 190 * <choice value='Elisabeth'/> 191 * <choice value='Annabeth'/> 192 * <choice value='Joe'/> 193 * </choices> 194 * <aliases> 195 * <alias value='Anna' target='Annabeth'/> 196 * <alias value='Beth' target='Elisabeth'/> 197 * </aliases> 198 * <default>'Joe'</default> 199 * </key> 200 * 201 * <key name='enumerated-key' enum='org.gtk.Test.myenum'> 202 * <default>'first'</default> 203 * </key> 204 * 205 * <key name='flags-key' flags='org.gtk.Test.myflags'> 206 * <default>["flag1","flag2"]</default> 207 * </key> 208 * </schema> 209 * </schemalist> 210 * ]| 211 * 212 * ## Vendor overrides 213 * 214 * Default values are defined in the schemas that get installed by 215 * an application. Sometimes, it is necessary for a vendor or distributor 216 * to adjust these defaults. Since patching the XML source for the schema 217 * is inconvenient and error-prone, 218 * [glib-compile-schemas][glib-compile-schemas] reads so-called vendor 219 * override' files. These are keyfiles in the same directory as the XML 220 * schema sources which can override default values. The schema id serves 221 * as the group name in the key file, and the values are expected in 222 * serialized GVariant form, as in the following example: 223 * |[ 224 * [org.gtk.Example] 225 * key1='string' 226 * key2=1.5 227 * ]| 228 * 229 * glib-compile-schemas expects schema files to have the extension 230 * `.gschema.override`. 231 * 232 * ## Binding 233 * 234 * A very convenient feature of GSettings lets you bind #GObject properties 235 * directly to settings, using g_settings_bind(). Once a GObject property 236 * has been bound to a setting, changes on either side are automatically 237 * propagated to the other side. GSettings handles details like mapping 238 * between GObject and GVariant types, and preventing infinite cycles. 239 * 240 * This makes it very easy to hook up a preferences dialog to the 241 * underlying settings. To make this even more convenient, GSettings 242 * looks for a boolean property with the name "sensitivity" and 243 * automatically binds it to the writability of the bound setting. 244 * If this 'magic' gets in the way, it can be suppressed with the 245 * #G_SETTINGS_BIND_NO_SENSITIVITY flag. 246 * 247 * ## Relocatable schemas # {#gsettings-relocatable} 248 * 249 * A relocatable schema is one with no `path` attribute specified on its 250 * <schema> element. By using g_settings_new_with_path(), a #GSettings object 251 * can be instantiated for a relocatable schema, assigning a path to the 252 * instance. Paths passed to g_settings_new_with_path() will typically be 253 * constructed dynamically from a constant prefix plus some form of instance 254 * identifier; but they must still be valid GSettings paths. Paths could also 255 * be constant and used with a globally installed schema originating from a 256 * dependency library. 257 * 258 * For example, a relocatable schema could be used to store geometry information 259 * for different windows in an application. If the schema ID was 260 * `org.foo.MyApp.Window`, it could be instantiated for paths 261 * `/org/foo/MyApp/main/`, `/org/foo/MyApp/document-1/`, 262 * `/org/foo/MyApp/document-2/`, etc. If any of the paths are well-known 263 * they can be specified as <child> elements in the parent schema, e.g.: 264 * |[ 265 * <schema id="org.foo.MyApp" path="/org/foo/MyApp/"> 266 * <child name="main" schema="org.foo.MyApp.Window"/> 267 * </schema> 268 * ]| 269 * 270 * ## Build system integration # {#gsettings-build-system} 271 * 272 * GSettings comes with autotools integration to simplify compiling and 273 * installing schemas. To add GSettings support to an application, add the 274 * following to your `configure.ac`: 275 * |[ 276 * GLIB_GSETTINGS 277 * ]| 278 * 279 * In the appropriate `Makefile.am`, use the following snippet to compile and 280 * install the named schema: 281 * |[ 282 * gsettings_SCHEMAS = org.foo.MyApp.gschema.xml 283 * EXTRA_DIST = $(gsettings_SCHEMAS) 284 * 285 * @GSETTINGS_RULES@ 286 * ]| 287 * 288 * No changes are needed to the build system to mark a schema XML file for 289 * translation. Assuming it sets the `gettext-domain` attribute, a schema may 290 * be marked for translation by adding it to `POTFILES.in`, assuming gettext 291 * 0.19 is in use (the preferred method for translation): 292 * |[ 293 * data/org.foo.MyApp.gschema.xml 294 * ]| 295 * 296 * Alternatively, if intltool 0.50.1 is in use: 297 * |[ 298 * [type: gettext/gsettings]data/org.foo.MyApp.gschema.xml 299 * ]| 300 * 301 * GSettings will use gettext to look up translations for the <summary> and 302 * <description> elements, and also any <default> elements which have a `l10n` 303 * attribute set. Translations must not be included in the `.gschema.xml` file 304 * by the build system, for example by using intltool XML rules with a 305 * `.gschema.xml.in` template. 306 * 307 * If an enumerated type defined in a C header file is to be used in a GSettings 308 * schema, it can either be defined manually using an <enum> element in the 309 * schema XML, or it can be extracted automatically from the C header. This 310 * approach is preferred, as it ensures the two representations are always 311 * synchronised. To do so, add the following to the relevant `Makefile.am`: 312 * |[ 313 * gsettings_ENUM_NAMESPACE = org.foo.MyApp 314 * gsettings_ENUM_FILES = my-app-enums.h my-app-misc.h 315 * ]| 316 * 317 * `gsettings_ENUM_NAMESPACE` specifies the schema namespace for the enum files, 318 * which are specified in `gsettings_ENUM_FILES`. This will generate a 319 * `org.foo.MyApp.enums.xml` file containing the extracted enums, which will be 320 * automatically included in the schema compilation, install and uninstall 321 * rules. It should not be committed to version control or included in 322 * `EXTRA_DIST`. 323 */ 324 public class Settings : ObjectG 325 { 326 /** the main Gtk struct */ 327 protected GSettings* gSettings; 328 329 /** Get the main Gtk struct */ 330 public GSettings* getSettingsStruct() 331 { 332 return gSettings; 333 } 334 335 /** the main Gtk struct as a void* */ 336 protected override void* getStruct() 337 { 338 return cast(void*)gSettings; 339 } 340 341 protected override void setStruct(GObject* obj) 342 { 343 gSettings = cast(GSettings*)obj; 344 super.setStruct(obj); 345 } 346 347 /** 348 * Sets our main struct and passes it to the parent class. 349 */ 350 public this (GSettings* gSettings, bool ownedRef = false) 351 { 352 this.gSettings = gSettings; 353 super(cast(GObject*)gSettings, ownedRef); 354 } 355 356 /** 357 */ 358 359 public static GType getType() 360 { 361 return g_settings_get_type(); 362 } 363 364 /** 365 * Creates a new #GSettings object with the schema specified by 366 * @schema_id. 367 * 368 * Signals on the newly created #GSettings object will be dispatched 369 * via the thread-default #GMainContext in effect at the time of the 370 * call to g_settings_new(). The new #GSettings will hold a reference 371 * on the context. See g_main_context_push_thread_default(). 372 * 373 * Params: 374 * schemaId = the id of the schema 375 * 376 * Return: a new #GSettings object 377 * 378 * Since: 2.26 379 * 380 * Throws: ConstructionException GTK+ fails to create the object. 381 */ 382 public this(string schemaId) 383 { 384 auto p = g_settings_new(Str.toStringz(schemaId)); 385 386 if(p is null) 387 { 388 throw new ConstructionException("null returned by new"); 389 } 390 391 this(cast(GSettings*) p, true); 392 } 393 394 /** 395 * Creates a new #GSettings object with a given schema, backend and 396 * path. 397 * 398 * It should be extremely rare that you ever want to use this function. 399 * It is made available for advanced use-cases (such as plugin systems 400 * that want to provide access to schemas loaded from custom locations, 401 * etc). 402 * 403 * At the most basic level, a #GSettings object is a pure composition of 404 * 4 things: a #GSettingsSchema, a #GSettingsBackend, a path within that 405 * backend, and a #GMainContext to which signals are dispatched. 406 * 407 * This constructor therefore gives you full control over constructing 408 * #GSettings instances. The first 3 parameters are given directly as 409 * @schema, @backend and @path, and the main context is taken from the 410 * thread-default (as per g_settings_new()). 411 * 412 * If @backend is %NULL then the default backend is used. 413 * 414 * If @path is %NULL then the path from the schema is used. It is an 415 * error if @path is %NULL and the schema has no path of its own or if 416 * @path is non-%NULL and not equal to the path that the schema does 417 * have. 418 * 419 * Params: 420 * schema = a #GSettingsSchema 421 * backend = a #GSettingsBackend 422 * path = the path to use 423 * 424 * Return: a new #GSettings object 425 * 426 * Since: 2.32 427 * 428 * Throws: ConstructionException GTK+ fails to create the object. 429 */ 430 public this(SettingsSchema schema, GSettingsBackend* backend, string path) 431 { 432 auto p = g_settings_new_full((schema is null) ? null : schema.getSettingsSchemaStruct(), backend, Str.toStringz(path)); 433 434 if(p is null) 435 { 436 throw new ConstructionException("null returned by new_full"); 437 } 438 439 this(cast(GSettings*) p, true); 440 } 441 442 /** 443 * Creates a new #GSettings object with the schema specified by 444 * @schema_id and a given #GSettingsBackend. 445 * 446 * Creating a #GSettings object with a different backend allows accessing 447 * settings from a database other than the usual one. For example, it may make 448 * sense to pass a backend corresponding to the "defaults" settings database on 449 * the system to get a settings object that modifies the system default 450 * settings instead of the settings for this user. 451 * 452 * Params: 453 * schemaId = the id of the schema 454 * backend = the #GSettingsBackend to use 455 * 456 * Return: a new #GSettings object 457 * 458 * Since: 2.26 459 * 460 * Throws: ConstructionException GTK+ fails to create the object. 461 */ 462 public this(string schemaId, GSettingsBackend* backend) 463 { 464 auto p = g_settings_new_with_backend(Str.toStringz(schemaId), backend); 465 466 if(p is null) 467 { 468 throw new ConstructionException("null returned by new_with_backend"); 469 } 470 471 this(cast(GSettings*) p, true); 472 } 473 474 /** 475 * Creates a new #GSettings object with the schema specified by 476 * @schema_id and a given #GSettingsBackend and path. 477 * 478 * This is a mix of g_settings_new_with_backend() and 479 * g_settings_new_with_path(). 480 * 481 * Params: 482 * schemaId = the id of the schema 483 * backend = the #GSettingsBackend to use 484 * path = the path to use 485 * 486 * Return: a new #GSettings object 487 * 488 * Since: 2.26 489 * 490 * Throws: ConstructionException GTK+ fails to create the object. 491 */ 492 public this(string schemaId, GSettingsBackend* backend, string path) 493 { 494 auto p = g_settings_new_with_backend_and_path(Str.toStringz(schemaId), backend, Str.toStringz(path)); 495 496 if(p is null) 497 { 498 throw new ConstructionException("null returned by new_with_backend_and_path"); 499 } 500 501 this(cast(GSettings*) p, true); 502 } 503 504 /** 505 * Creates a new #GSettings object with the relocatable schema specified 506 * by @schema_id and a given path. 507 * 508 * You only need to do this if you want to directly create a settings 509 * object with a schema that doesn't have a specified path of its own. 510 * That's quite rare. 511 * 512 * It is a programmer error to call this function for a schema that 513 * has an explicitly specified path. 514 * 515 * It is a programmer error if @path is not a valid path. A valid path 516 * begins and ends with '/' and does not contain two consecutive '/' 517 * characters. 518 * 519 * Params: 520 * schemaId = the id of the schema 521 * path = the path to use 522 * 523 * Return: a new #GSettings object 524 * 525 * Since: 2.26 526 * 527 * Throws: ConstructionException GTK+ fails to create the object. 528 */ 529 public this(string schemaId, string path) 530 { 531 auto p = g_settings_new_with_path(Str.toStringz(schemaId), Str.toStringz(path)); 532 533 if(p is null) 534 { 535 throw new ConstructionException("null returned by new_with_path"); 536 } 537 538 this(cast(GSettings*) p, true); 539 } 540 541 /** 542 * <!-- --> 543 * 544 * Deprecated: Use g_settings_schema_source_list_schemas() instead 545 * 546 * Return: a list of relocatable 547 * #GSettings schemas that are available. The list must not be 548 * modified or freed. 549 * 550 * Since: 2.28 551 */ 552 public static string[] listRelocatableSchemas() 553 { 554 return Str.toStringArray(g_settings_list_relocatable_schemas()); 555 } 556 557 /** 558 * <!-- --> 559 * 560 * Deprecated: Use g_settings_schema_source_list_schemas() instead. 561 * If you used g_settings_list_schemas() to check for the presence of 562 * a particular schema, use g_settings_schema_source_lookup() instead 563 * of your whole loop. 564 * 565 * Return: a list of #GSettings 566 * schemas that are available. The list must not be modified or 567 * freed. 568 * 569 * Since: 2.26 570 */ 571 public static string[] listSchemas() 572 { 573 return Str.toStringArray(g_settings_list_schemas()); 574 } 575 576 /** 577 * Ensures that all pending operations for the given are complete for 578 * the default backend. 579 * 580 * Writes made to a #GSettings are handled asynchronously. For this 581 * reason, it is very unlikely that the changes have it to disk by the 582 * time g_settings_set() returns. 583 * 584 * This call will block until all of the writes have made it to the 585 * backend. Since the mainloop is not running, no change notifications 586 * will be dispatched during this call (but some may be queued by the 587 * time the call is done). 588 */ 589 public static void sync() 590 { 591 g_settings_sync(); 592 } 593 594 /** 595 * Removes an existing binding for @property on @object. 596 * 597 * Note that bindings are automatically removed when the 598 * object is finalized, so it is rarely necessary to call this 599 * function. 600 * 601 * Params: 602 * object = the object 603 * property = the property whose binding is removed 604 * 605 * Since: 2.26 606 */ 607 public static void unbind(ObjectG object, string property) 608 { 609 g_settings_unbind((object is null) ? null : object.getObjectGStruct(), Str.toStringz(property)); 610 } 611 612 /** 613 * Applies any changes that have been made to the settings. This 614 * function does nothing unless @settings is in 'delay-apply' mode; 615 * see g_settings_delay(). In the normal case settings are always 616 * applied immediately. 617 */ 618 public void apply() 619 { 620 g_settings_apply(gSettings); 621 } 622 623 /** 624 * Create a binding between the @key in the @settings object 625 * and the property @property of @object. 626 * 627 * The binding uses the default GIO mapping functions to map 628 * between the settings and property values. These functions 629 * handle booleans, numeric types and string types in a 630 * straightforward way. Use g_settings_bind_with_mapping() if 631 * you need a custom mapping, or map between types that are not 632 * supported by the default mapping functions. 633 * 634 * Unless the @flags include %G_SETTINGS_BIND_NO_SENSITIVITY, this 635 * function also establishes a binding between the writability of 636 * @key and the "sensitive" property of @object (if @object has 637 * a boolean property by that name). See g_settings_bind_writable() 638 * for more details about writable bindings. 639 * 640 * Note that the lifecycle of the binding is tied to the object, 641 * and that you can have only one binding per object property. 642 * If you bind the same property twice on the same object, the second 643 * binding overrides the first one. 644 * 645 * Params: 646 * key = the key to bind 647 * object = a #GObject 648 * property = the name of the property to bind 649 * flags = flags for the binding 650 * 651 * Since: 2.26 652 */ 653 public void bind(string key, ObjectG object, string property, GSettingsBindFlags flags) 654 { 655 g_settings_bind(gSettings, Str.toStringz(key), (object is null) ? null : object.getObjectGStruct(), Str.toStringz(property), flags); 656 } 657 658 /** 659 * Create a binding between the @key in the @settings object 660 * and the property @property of @object. 661 * 662 * The binding uses the provided mapping functions to map between 663 * settings and property values. 664 * 665 * Note that the lifecycle of the binding is tied to the object, 666 * and that you can have only one binding per object property. 667 * If you bind the same property twice on the same object, the second 668 * binding overrides the first one. 669 * 670 * Params: 671 * key = the key to bind 672 * object = a #GObject 673 * property = the name of the property to bind 674 * flags = flags for the binding 675 * getMapping = a function that gets called to convert values 676 * from @settings to @object, or %NULL to use the default GIO mapping 677 * setMapping = a function that gets called to convert values 678 * from @object to @settings, or %NULL to use the default GIO mapping 679 * userData = data that gets passed to @get_mapping and @set_mapping 680 * destroy = #GDestroyNotify function for @user_data 681 * 682 * Since: 2.26 683 */ 684 public void bindWithMapping(string key, ObjectG object, string property, GSettingsBindFlags flags, GSettingsBindGetMapping getMapping, GSettingsBindSetMapping setMapping, void* userData, GDestroyNotify destroy) 685 { 686 g_settings_bind_with_mapping(gSettings, Str.toStringz(key), (object is null) ? null : object.getObjectGStruct(), Str.toStringz(property), flags, getMapping, setMapping, userData, destroy); 687 } 688 689 /** 690 * Create a binding between the writability of @key in the 691 * @settings object and the property @property of @object. 692 * The property must be boolean; "sensitive" or "visible" 693 * properties of widgets are the most likely candidates. 694 * 695 * Writable bindings are always uni-directional; changes of the 696 * writability of the setting will be propagated to the object 697 * property, not the other way. 698 * 699 * When the @inverted argument is %TRUE, the binding inverts the 700 * value as it passes from the setting to the object, i.e. @property 701 * will be set to %TRUE if the key is not writable. 702 * 703 * Note that the lifecycle of the binding is tied to the object, 704 * and that you can have only one binding per object property. 705 * If you bind the same property twice on the same object, the second 706 * binding overrides the first one. 707 * 708 * Params: 709 * key = the key to bind 710 * object = a #GObject 711 * property = the name of a boolean property to bind 712 * inverted = whether to 'invert' the value 713 * 714 * Since: 2.26 715 */ 716 public void bindWritable(string key, ObjectG object, string property, bool inverted) 717 { 718 g_settings_bind_writable(gSettings, Str.toStringz(key), (object is null) ? null : object.getObjectGStruct(), Str.toStringz(property), inverted); 719 } 720 721 /** 722 * Creates a #GAction corresponding to a given #GSettings key. 723 * 724 * The action has the same name as the key. 725 * 726 * The value of the key becomes the state of the action and the action 727 * is enabled when the key is writable. Changing the state of the 728 * action results in the key being written to. Changes to the value or 729 * writability of the key cause appropriate change notifications to be 730 * emitted for the action. 731 * 732 * For boolean-valued keys, action activations take no parameter and 733 * result in the toggling of the value. For all other types, 734 * activations take the new value for the key (which must have the 735 * correct type). 736 * 737 * Params: 738 * key = the name of a key in @settings 739 * 740 * Return: a new #GAction 741 * 742 * Since: 2.32 743 */ 744 public ActionIF createAction(string key) 745 { 746 auto p = g_settings_create_action(gSettings, Str.toStringz(key)); 747 748 if(p is null) 749 { 750 return null; 751 } 752 753 return ObjectG.getDObject!(Action, ActionIF)(cast(GAction*) p); 754 } 755 756 /** 757 * Changes the #GSettings object into 'delay-apply' mode. In this 758 * mode, changes to @settings are not immediately propagated to the 759 * backend, but kept locally until g_settings_apply() is called. 760 * 761 * Since: 2.26 762 */ 763 public void delay() 764 { 765 g_settings_delay(gSettings); 766 } 767 768 /** 769 * Gets the value that is stored at @key in @settings. 770 * 771 * A convenience variant of g_settings_get() for booleans. 772 * 773 * It is a programmer error to give a @key that isn't specified as 774 * having a boolean type in the schema for @settings. 775 * 776 * Params: 777 * key = the key to get the value for 778 * 779 * Return: a boolean 780 * 781 * Since: 2.26 782 */ 783 public bool getBoolean(string key) 784 { 785 return g_settings_get_boolean(gSettings, Str.toStringz(key)) != 0; 786 } 787 788 /** 789 * Creates a child settings object which has a base path of 790 * `base-path/@name`, where `base-path` is the base path of 791 * @settings. 792 * 793 * The schema for the child settings object must have been declared 794 * in the schema of @settings using a <child> element. 795 * 796 * Params: 797 * name = the name of the child schema 798 * 799 * Return: a 'child' settings object 800 * 801 * Since: 2.26 802 */ 803 public Settings getChild(string name) 804 { 805 auto p = g_settings_get_child(gSettings, Str.toStringz(name)); 806 807 if(p is null) 808 { 809 return null; 810 } 811 812 return ObjectG.getDObject!(Settings)(cast(GSettings*) p, true); 813 } 814 815 /** 816 * Gets the "default value" of a key. 817 * 818 * This is the value that would be read if g_settings_reset() were to be 819 * called on the key. 820 * 821 * Note that this may be a different value than returned by 822 * g_settings_schema_key_get_default_value() if the system administrator 823 * has provided a default value. 824 * 825 * Comparing the return values of g_settings_get_default_value() and 826 * g_settings_get_value() is not sufficient for determining if a value 827 * has been set because the user may have explicitly set the value to 828 * something that happens to be equal to the default. The difference 829 * here is that if the default changes in the future, the user's key 830 * will still be set. 831 * 832 * This function may be useful for adding an indication to a UI of what 833 * the default value was before the user set it. 834 * 835 * It is a programmer error to give a @key that isn't contained in the 836 * schema for @settings. 837 * 838 * Params: 839 * key = the key to get the default value for 840 * 841 * Return: the default value 842 * 843 * Since: 2.40 844 */ 845 public Variant getDefaultValue(string key) 846 { 847 auto p = g_settings_get_default_value(gSettings, Str.toStringz(key)); 848 849 if(p is null) 850 { 851 return null; 852 } 853 854 return new Variant(cast(GVariant*) p); 855 } 856 857 /** 858 * Gets the value that is stored at @key in @settings. 859 * 860 * A convenience variant of g_settings_get() for doubles. 861 * 862 * It is a programmer error to give a @key that isn't specified as 863 * having a 'double' type in the schema for @settings. 864 * 865 * Params: 866 * key = the key to get the value for 867 * 868 * Return: a double 869 * 870 * Since: 2.26 871 */ 872 public double getDouble(string key) 873 { 874 return g_settings_get_double(gSettings, Str.toStringz(key)); 875 } 876 877 /** 878 * Gets the value that is stored in @settings for @key and converts it 879 * to the enum value that it represents. 880 * 881 * In order to use this function the type of the value must be a string 882 * and it must be marked in the schema file as an enumerated type. 883 * 884 * It is a programmer error to give a @key that isn't contained in the 885 * schema for @settings or is not marked as an enumerated type. 886 * 887 * If the value stored in the configuration database is not a valid 888 * value for the enumerated type then this function will return the 889 * default value. 890 * 891 * Params: 892 * key = the key to get the value for 893 * 894 * Return: the enum value 895 * 896 * Since: 2.26 897 */ 898 public int getEnum(string key) 899 { 900 return g_settings_get_enum(gSettings, Str.toStringz(key)); 901 } 902 903 /** 904 * Gets the value that is stored in @settings for @key and converts it 905 * to the flags value that it represents. 906 * 907 * In order to use this function the type of the value must be an array 908 * of strings and it must be marked in the schema file as an flags type. 909 * 910 * It is a programmer error to give a @key that isn't contained in the 911 * schema for @settings or is not marked as a flags type. 912 * 913 * If the value stored in the configuration database is not a valid 914 * value for the flags type then this function will return the default 915 * value. 916 * 917 * Params: 918 * key = the key to get the value for 919 * 920 * Return: the flags value 921 * 922 * Since: 2.26 923 */ 924 public uint getFlags(string key) 925 { 926 return g_settings_get_flags(gSettings, Str.toStringz(key)); 927 } 928 929 /** 930 * Returns whether the #GSettings object has any unapplied 931 * changes. This can only be the case if it is in 'delayed-apply' mode. 932 * 933 * Return: %TRUE if @settings has unapplied changes 934 * 935 * Since: 2.26 936 */ 937 public bool getHasUnapplied() 938 { 939 return g_settings_get_has_unapplied(gSettings) != 0; 940 } 941 942 /** 943 * Gets the value that is stored at @key in @settings. 944 * 945 * A convenience variant of g_settings_get() for 32-bit integers. 946 * 947 * It is a programmer error to give a @key that isn't specified as 948 * having a int32 type in the schema for @settings. 949 * 950 * Params: 951 * key = the key to get the value for 952 * 953 * Return: an integer 954 * 955 * Since: 2.26 956 */ 957 public int getInt(string key) 958 { 959 return g_settings_get_int(gSettings, Str.toStringz(key)); 960 } 961 962 /** 963 * Gets the value that is stored at @key in @settings, subject to 964 * application-level validation/mapping. 965 * 966 * You should use this function when the application needs to perform 967 * some processing on the value of the key (for example, parsing). The 968 * @mapping function performs that processing. If the function 969 * indicates that the processing was unsuccessful (due to a parse error, 970 * for example) then the mapping is tried again with another value. 971 * 972 * This allows a robust 'fall back to defaults' behaviour to be 973 * implemented somewhat automatically. 974 * 975 * The first value that is tried is the user's setting for the key. If 976 * the mapping function fails to map this value, other values may be 977 * tried in an unspecified order (system or site defaults, translated 978 * schema default values, untranslated schema default values, etc). 979 * 980 * If the mapping function fails for all possible values, one additional 981 * attempt is made: the mapping function is called with a %NULL value. 982 * If the mapping function still indicates failure at this point then 983 * the application will be aborted. 984 * 985 * The result parameter for the @mapping function is pointed to a 986 * #gpointer which is initially set to %NULL. The same pointer is given 987 * to each invocation of @mapping. The final value of that #gpointer is 988 * what is returned by this function. %NULL is valid; it is returned 989 * just as any other value would be. 990 * 991 * Params: 992 * key = the key to get the value for 993 * mapping = the function to map the value in the 994 * settings database to the value used by the application 995 * userData = user data for @mapping 996 * 997 * Return: the result, which may be %NULL 998 */ 999 public void* getMapped(string key, GSettingsGetMapping mapping, void* userData) 1000 { 1001 return g_settings_get_mapped(gSettings, Str.toStringz(key), mapping, userData); 1002 } 1003 1004 /** 1005 * Queries the range of a key. 1006 * 1007 * Deprecated: Use g_settings_schema_key_get_range() instead. 1008 * 1009 * Params: 1010 * key = the key to query the range of 1011 * 1012 * Since: 2.28 1013 */ 1014 public Variant getRange(string key) 1015 { 1016 auto p = g_settings_get_range(gSettings, Str.toStringz(key)); 1017 1018 if(p is null) 1019 { 1020 return null; 1021 } 1022 1023 return new Variant(cast(GVariant*) p); 1024 } 1025 1026 /** 1027 * Gets the value that is stored at @key in @settings. 1028 * 1029 * A convenience variant of g_settings_get() for strings. 1030 * 1031 * It is a programmer error to give a @key that isn't specified as 1032 * having a string type in the schema for @settings. 1033 * 1034 * Params: 1035 * key = the key to get the value for 1036 * 1037 * Return: a newly-allocated string 1038 * 1039 * Since: 2.26 1040 */ 1041 public string getString(string key) 1042 { 1043 return Str.toString(g_settings_get_string(gSettings, Str.toStringz(key))); 1044 } 1045 1046 /** 1047 * A convenience variant of g_settings_get() for string arrays. 1048 * 1049 * It is a programmer error to give a @key that isn't specified as 1050 * having an array of strings type in the schema for @settings. 1051 * 1052 * Params: 1053 * key = the key to get the value for 1054 * 1055 * Return: a 1056 * newly-allocated, %NULL-terminated array of strings, the value that 1057 * is stored at @key in @settings. 1058 * 1059 * Since: 2.26 1060 */ 1061 public string[] getStrv(string key) 1062 { 1063 return Str.toStringArray(g_settings_get_strv(gSettings, Str.toStringz(key))); 1064 } 1065 1066 /** 1067 * Gets the value that is stored at @key in @settings. 1068 * 1069 * A convenience variant of g_settings_get() for 32-bit unsigned 1070 * integers. 1071 * 1072 * It is a programmer error to give a @key that isn't specified as 1073 * having a uint32 type in the schema for @settings. 1074 * 1075 * Params: 1076 * key = the key to get the value for 1077 * 1078 * Return: an unsigned integer 1079 * 1080 * Since: 2.30 1081 */ 1082 public uint getUint(string key) 1083 { 1084 return g_settings_get_uint(gSettings, Str.toStringz(key)); 1085 } 1086 1087 /** 1088 * Checks the "user value" of a key, if there is one. 1089 * 1090 * The user value of a key is the last value that was set by the user. 1091 * 1092 * After calling g_settings_reset() this function should always return 1093 * %NULL (assuming something is not wrong with the system 1094 * configuration). 1095 * 1096 * It is possible that g_settings_get_value() will return a different 1097 * value than this function. This can happen in the case that the user 1098 * set a value for a key that was subsequently locked down by the system 1099 * administrator -- this function will return the user's old value. 1100 * 1101 * This function may be useful for adding a "reset" option to a UI or 1102 * for providing indication that a particular value has been changed. 1103 * 1104 * It is a programmer error to give a @key that isn't contained in the 1105 * schema for @settings. 1106 * 1107 * Params: 1108 * key = the key to get the user value for 1109 * 1110 * Return: the user's value, if set 1111 * 1112 * Since: 2.40 1113 */ 1114 public Variant getUserValue(string key) 1115 { 1116 auto p = g_settings_get_user_value(gSettings, Str.toStringz(key)); 1117 1118 if(p is null) 1119 { 1120 return null; 1121 } 1122 1123 return new Variant(cast(GVariant*) p); 1124 } 1125 1126 /** 1127 * Gets the value that is stored in @settings for @key. 1128 * 1129 * It is a programmer error to give a @key that isn't contained in the 1130 * schema for @settings. 1131 * 1132 * Params: 1133 * key = the key to get the value for 1134 * 1135 * Return: a new #GVariant 1136 * 1137 * Since: 2.26 1138 */ 1139 public Variant getValue(string key) 1140 { 1141 auto p = g_settings_get_value(gSettings, Str.toStringz(key)); 1142 1143 if(p is null) 1144 { 1145 return null; 1146 } 1147 1148 return new Variant(cast(GVariant*) p); 1149 } 1150 1151 /** 1152 * Finds out if a key can be written or not 1153 * 1154 * Params: 1155 * name = the name of a key 1156 * 1157 * Return: %TRUE if the key @name is writable 1158 * 1159 * Since: 2.26 1160 */ 1161 public bool isWritable(string name) 1162 { 1163 return g_settings_is_writable(gSettings, Str.toStringz(name)) != 0; 1164 } 1165 1166 /** 1167 * Gets the list of children on @settings. 1168 * 1169 * The list is exactly the list of strings for which it is not an error 1170 * to call g_settings_get_child(). 1171 * 1172 * For GSettings objects that are lists, this value can change at any 1173 * time and you should connect to the "children-changed" signal to watch 1174 * for those changes. Note that there is a race condition here: you may 1175 * request a child after listing it only for it to have been destroyed 1176 * in the meantime. For this reason, g_settings_get_child() may return 1177 * %NULL even for a child that was listed by this function. 1178 * 1179 * For GSettings objects that are not lists, you should probably not be 1180 * calling this function from "normal" code (since you should already 1181 * know what children are in your schema). This function may still be 1182 * useful there for introspection reasons, however. 1183 * 1184 * You should free the return value with g_strfreev() when you are done 1185 * with it. 1186 * 1187 * Return: a list of the children on @settings 1188 */ 1189 public string[] listChildren() 1190 { 1191 return Str.toStringArray(g_settings_list_children(gSettings)); 1192 } 1193 1194 /** 1195 * Introspects the list of keys on @settings. 1196 * 1197 * You should probably not be calling this function from "normal" code 1198 * (since you should already know what keys are in your schema). This 1199 * function is intended for introspection reasons. 1200 * 1201 * You should free the return value with g_strfreev() when you are done 1202 * with it. 1203 * 1204 * Return: a list of the keys on @settings 1205 */ 1206 public string[] listKeys() 1207 { 1208 return Str.toStringArray(g_settings_list_keys(gSettings)); 1209 } 1210 1211 /** 1212 * Checks if the given @value is of the correct type and within the 1213 * permitted range for @key. 1214 * 1215 * Deprecated: Use g_settings_schema_key_range_check() instead. 1216 * 1217 * Params: 1218 * key = the key to check 1219 * value = the value to check 1220 * 1221 * Return: %TRUE if @value is valid for @key 1222 * 1223 * Since: 2.28 1224 */ 1225 public bool rangeCheck(string key, Variant value) 1226 { 1227 return g_settings_range_check(gSettings, Str.toStringz(key), (value is null) ? null : value.getVariantStruct()) != 0; 1228 } 1229 1230 /** 1231 * Resets @key to its default value. 1232 * 1233 * This call resets the key, as much as possible, to its default value. 1234 * That might the value specified in the schema or the one set by the 1235 * administrator. 1236 * 1237 * Params: 1238 * key = the name of a key 1239 */ 1240 public void reset(string key) 1241 { 1242 g_settings_reset(gSettings, Str.toStringz(key)); 1243 } 1244 1245 /** 1246 * Reverts all non-applied changes to the settings. This function 1247 * does nothing unless @settings is in 'delay-apply' mode; see 1248 * g_settings_delay(). In the normal case settings are always applied 1249 * immediately. 1250 * 1251 * Change notifications will be emitted for affected keys. 1252 */ 1253 public void revert() 1254 { 1255 g_settings_revert(gSettings); 1256 } 1257 1258 /** 1259 * Sets @key in @settings to @value. 1260 * 1261 * A convenience variant of g_settings_set() for booleans. 1262 * 1263 * It is a programmer error to give a @key that isn't specified as 1264 * having a boolean type in the schema for @settings. 1265 * 1266 * Params: 1267 * key = the name of the key to set 1268 * value = the value to set it to 1269 * 1270 * Return: %TRUE if setting the key succeeded, 1271 * %FALSE if the key was not writable 1272 * 1273 * Since: 2.26 1274 */ 1275 public bool setBoolean(string key, bool value) 1276 { 1277 return g_settings_set_boolean(gSettings, Str.toStringz(key), value) != 0; 1278 } 1279 1280 /** 1281 * Sets @key in @settings to @value. 1282 * 1283 * A convenience variant of g_settings_set() for doubles. 1284 * 1285 * It is a programmer error to give a @key that isn't specified as 1286 * having a 'double' type in the schema for @settings. 1287 * 1288 * Params: 1289 * key = the name of the key to set 1290 * value = the value to set it to 1291 * 1292 * Return: %TRUE if setting the key succeeded, 1293 * %FALSE if the key was not writable 1294 * 1295 * Since: 2.26 1296 */ 1297 public bool setDouble(string key, double value) 1298 { 1299 return g_settings_set_double(gSettings, Str.toStringz(key), value) != 0; 1300 } 1301 1302 /** 1303 * Looks up the enumerated type nick for @value and writes it to @key, 1304 * within @settings. 1305 * 1306 * It is a programmer error to give a @key that isn't contained in the 1307 * schema for @settings or is not marked as an enumerated type, or for 1308 * @value not to be a valid value for the named type. 1309 * 1310 * After performing the write, accessing @key directly with 1311 * g_settings_get_string() will return the 'nick' associated with 1312 * @value. 1313 * 1314 * Params: 1315 * key = a key, within @settings 1316 * value = an enumerated value 1317 * 1318 * Return: %TRUE, if the set succeeds 1319 */ 1320 public bool setEnum(string key, int value) 1321 { 1322 return g_settings_set_enum(gSettings, Str.toStringz(key), value) != 0; 1323 } 1324 1325 /** 1326 * Looks up the flags type nicks for the bits specified by @value, puts 1327 * them in an array of strings and writes the array to @key, within 1328 * @settings. 1329 * 1330 * It is a programmer error to give a @key that isn't contained in the 1331 * schema for @settings or is not marked as a flags type, or for @value 1332 * to contain any bits that are not value for the named type. 1333 * 1334 * After performing the write, accessing @key directly with 1335 * g_settings_get_strv() will return an array of 'nicks'; one for each 1336 * bit in @value. 1337 * 1338 * Params: 1339 * key = a key, within @settings 1340 * value = a flags value 1341 * 1342 * Return: %TRUE, if the set succeeds 1343 */ 1344 public bool setFlags(string key, uint value) 1345 { 1346 return g_settings_set_flags(gSettings, Str.toStringz(key), value) != 0; 1347 } 1348 1349 /** 1350 * Sets @key in @settings to @value. 1351 * 1352 * A convenience variant of g_settings_set() for 32-bit integers. 1353 * 1354 * It is a programmer error to give a @key that isn't specified as 1355 * having a int32 type in the schema for @settings. 1356 * 1357 * Params: 1358 * key = the name of the key to set 1359 * value = the value to set it to 1360 * 1361 * Return: %TRUE if setting the key succeeded, 1362 * %FALSE if the key was not writable 1363 * 1364 * Since: 2.26 1365 */ 1366 public bool setInt(string key, int value) 1367 { 1368 return g_settings_set_int(gSettings, Str.toStringz(key), value) != 0; 1369 } 1370 1371 /** 1372 * Sets @key in @settings to @value. 1373 * 1374 * A convenience variant of g_settings_set() for strings. 1375 * 1376 * It is a programmer error to give a @key that isn't specified as 1377 * having a string type in the schema for @settings. 1378 * 1379 * Params: 1380 * key = the name of the key to set 1381 * value = the value to set it to 1382 * 1383 * Return: %TRUE if setting the key succeeded, 1384 * %FALSE if the key was not writable 1385 * 1386 * Since: 2.26 1387 */ 1388 public bool setString(string key, string value) 1389 { 1390 return g_settings_set_string(gSettings, Str.toStringz(key), Str.toStringz(value)) != 0; 1391 } 1392 1393 /** 1394 * Sets @key in @settings to @value. 1395 * 1396 * A convenience variant of g_settings_set() for string arrays. If 1397 * @value is %NULL, then @key is set to be the empty array. 1398 * 1399 * It is a programmer error to give a @key that isn't specified as 1400 * having an array of strings type in the schema for @settings. 1401 * 1402 * Params: 1403 * key = the name of the key to set 1404 * value = the value to set it to, or %NULL 1405 * 1406 * Return: %TRUE if setting the key succeeded, 1407 * %FALSE if the key was not writable 1408 * 1409 * Since: 2.26 1410 */ 1411 public bool setStrv(string key, string[] value) 1412 { 1413 return g_settings_set_strv(gSettings, Str.toStringz(key), Str.toStringzArray(value)) != 0; 1414 } 1415 1416 /** 1417 * Sets @key in @settings to @value. 1418 * 1419 * A convenience variant of g_settings_set() for 32-bit unsigned 1420 * integers. 1421 * 1422 * It is a programmer error to give a @key that isn't specified as 1423 * having a uint32 type in the schema for @settings. 1424 * 1425 * Params: 1426 * key = the name of the key to set 1427 * value = the value to set it to 1428 * 1429 * Return: %TRUE if setting the key succeeded, 1430 * %FALSE if the key was not writable 1431 * 1432 * Since: 2.30 1433 */ 1434 public bool setUint(string key, uint value) 1435 { 1436 return g_settings_set_uint(gSettings, Str.toStringz(key), value) != 0; 1437 } 1438 1439 /** 1440 * Sets @key in @settings to @value. 1441 * 1442 * It is a programmer error to give a @key that isn't contained in the 1443 * schema for @settings or for @value to have the incorrect type, per 1444 * the schema. 1445 * 1446 * If @value is floating then this function consumes the reference. 1447 * 1448 * Params: 1449 * key = the name of the key to set 1450 * value = a #GVariant of the correct type 1451 * 1452 * Return: %TRUE if setting the key succeeded, 1453 * %FALSE if the key was not writable 1454 * 1455 * Since: 2.26 1456 */ 1457 public bool setValue(string key, Variant value) 1458 { 1459 return g_settings_set_value(gSettings, Str.toStringz(key), (value is null) ? null : value.getVariantStruct()) != 0; 1460 } 1461 1462 int[string] connectedSignals; 1463 1464 bool delegate(void*, int, Settings)[] onChangeListeners; 1465 /** 1466 * The "change-event" signal is emitted once per change event that 1467 * affects this settings object. You should connect to this signal 1468 * only if you are interested in viewing groups of changes before they 1469 * are split out into multiple emissions of the "changed" signal. 1470 * For most use cases it is more appropriate to use the "changed" signal. 1471 * 1472 * In the event that the change event applies to one or more specified 1473 * keys, @keys will be an array of #GQuark of length @n_keys. In the 1474 * event that the change event applies to the #GSettings object as a 1475 * whole (ie: potentially every key has been changed) then @keys will 1476 * be %NULL and @n_keys will be 0. 1477 * 1478 * The default handler for this signal invokes the "changed" signal 1479 * for each affected key. If any other connected handler returns 1480 * %TRUE then this default functionality will be suppressed. 1481 * 1482 * Params: 1483 * keys = an array of #GQuarks for the changed keys, or %NULL 1484 * nKeys = the length of the @keys array, or 0 1485 * 1486 * Return: %TRUE to stop other handlers from being invoked for the 1487 * event. FALSE to propagate the event further. 1488 */ 1489 void addOnChange(bool delegate(void*, int, Settings) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0) 1490 { 1491 if ( "change-event" !in connectedSignals ) 1492 { 1493 Signals.connectData( 1494 this, 1495 "change-event", 1496 cast(GCallback)&callBackChange, 1497 cast(void*)this, 1498 null, 1499 connectFlags); 1500 connectedSignals["change-event"] = 1; 1501 } 1502 onChangeListeners ~= dlg; 1503 } 1504 extern(C) static int callBackChange(GSettings* settingsStruct, void* keys, int nKeys, Settings _settings) 1505 { 1506 foreach ( bool delegate(void*, int, Settings) dlg; _settings.onChangeListeners ) 1507 { 1508 if ( dlg(keys, nKeys, _settings) ) 1509 { 1510 return 1; 1511 } 1512 } 1513 1514 return 0; 1515 } 1516 1517 void delegate(string, Settings)[] onChangedListeners; 1518 /** 1519 * The "changed" signal is emitted when a key has potentially changed. 1520 * You should call one of the g_settings_get() calls to check the new 1521 * value. 1522 * 1523 * This signal supports detailed connections. You can connect to the 1524 * detailed signal "changed::x" in order to only receive callbacks 1525 * when key "x" changes. 1526 * 1527 * Params: 1528 * key = the name of the key that changed 1529 */ 1530 void addOnChanged(void delegate(string, Settings) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0) 1531 { 1532 if ( "changed" !in connectedSignals ) 1533 { 1534 Signals.connectData( 1535 this, 1536 "changed", 1537 cast(GCallback)&callBackChanged, 1538 cast(void*)this, 1539 null, 1540 connectFlags); 1541 connectedSignals["changed"] = 1; 1542 } 1543 onChangedListeners ~= dlg; 1544 } 1545 extern(C) static void callBackChanged(GSettings* settingsStruct, char* key, Settings _settings) 1546 { 1547 foreach ( void delegate(string, Settings) dlg; _settings.onChangedListeners ) 1548 { 1549 dlg(Str.toString(key), _settings); 1550 } 1551 } 1552 1553 bool delegate(uint, Settings)[] onWritableChangeListeners; 1554 /** 1555 * The "writable-change-event" signal is emitted once per writability 1556 * change event that affects this settings object. You should connect 1557 * to this signal if you are interested in viewing groups of changes 1558 * before they are split out into multiple emissions of the 1559 * "writable-changed" signal. For most use cases it is more 1560 * appropriate to use the "writable-changed" signal. 1561 * 1562 * In the event that the writability change applies only to a single 1563 * key, @key will be set to the #GQuark for that key. In the event 1564 * that the writability change affects the entire settings object, 1565 * @key will be 0. 1566 * 1567 * The default handler for this signal invokes the "writable-changed" 1568 * and "changed" signals for each affected key. This is done because 1569 * changes in writability might also imply changes in value (if for 1570 * example, a new mandatory setting is introduced). If any other 1571 * connected handler returns %TRUE then this default functionality 1572 * will be suppressed. 1573 * 1574 * Params: 1575 * key = the quark of the key, or 0 1576 * 1577 * Return: %TRUE to stop other handlers from being invoked for the 1578 * event. FALSE to propagate the event further. 1579 */ 1580 void addOnWritableChange(bool delegate(uint, Settings) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0) 1581 { 1582 if ( "writable-change-event" !in connectedSignals ) 1583 { 1584 Signals.connectData( 1585 this, 1586 "writable-change-event", 1587 cast(GCallback)&callBackWritableChange, 1588 cast(void*)this, 1589 null, 1590 connectFlags); 1591 connectedSignals["writable-change-event"] = 1; 1592 } 1593 onWritableChangeListeners ~= dlg; 1594 } 1595 extern(C) static int callBackWritableChange(GSettings* settingsStruct, uint key, Settings _settings) 1596 { 1597 foreach ( bool delegate(uint, Settings) dlg; _settings.onWritableChangeListeners ) 1598 { 1599 if ( dlg(key, _settings) ) 1600 { 1601 return 1; 1602 } 1603 } 1604 1605 return 0; 1606 } 1607 1608 void delegate(string, Settings)[] onWritableChangedListeners; 1609 /** 1610 * The "writable-changed" signal is emitted when the writability of a 1611 * key has potentially changed. You should call 1612 * g_settings_is_writable() in order to determine the new status. 1613 * 1614 * This signal supports detailed connections. You can connect to the 1615 * detailed signal "writable-changed::x" in order to only receive 1616 * callbacks when the writability of "x" changes. 1617 * 1618 * Params: 1619 * key = the key 1620 */ 1621 void addOnWritableChanged(void delegate(string, Settings) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0) 1622 { 1623 if ( "writable-changed" !in connectedSignals ) 1624 { 1625 Signals.connectData( 1626 this, 1627 "writable-changed", 1628 cast(GCallback)&callBackWritableChanged, 1629 cast(void*)this, 1630 null, 1631 connectFlags); 1632 connectedSignals["writable-changed"] = 1; 1633 } 1634 onWritableChangedListeners ~= dlg; 1635 } 1636 extern(C) static void callBackWritableChanged(GSettings* settingsStruct, char* key, Settings _settings) 1637 { 1638 foreach ( void delegate(string, Settings) dlg; _settings.onWritableChangedListeners ) 1639 { 1640 dlg(Str.toString(key), _settings); 1641 } 1642 } 1643 }