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