Class Setting

setting object

Inherits from

Object (base class)

Constructors

Name	Description
`this`
`this`
`this`
`this`
`this`
`this`
`this`
`this`
`this`

Properties

Name	Type	Description
`array` [get]	`Setting[]`	returns items as `Setting` `array`
`array` [set]	`Setting[]`	sets `Setting` `array`
`boolean` [get]	`inout(bool)`	read as `boolean` value
`boolean` [set]	`bool`	set bool value for object
`changed` [get]	`bool`	returns true if setting has been `changed`
`changed` [set]	`bool`	sets change flag
`floating` [set]	`double`	set ulong value for object
`floating` [get]	`inout(double)`	read as double value
`intArray` [set]	`int[]`	sets int `array`
`intArray` [get]	`int[]`	returns items as int `array`
`integer` [get]	`inout(long)`	read as long value
`integer` [set]	`long`	set long value for object
`intMap` [get]	`int[string]`	returns items as int[string] `map`
`intMap` [set]	`int[string]`	sets int[string] `map`
`isArray` [get]	`bool`
`isBoolean` [get]	`bool`
`isFloating` [get]	`bool`
`isInteger` [get]	`bool`
`isNull` [get]	`bool`
`isObject` [get]	`bool`
`isString` [get]	`bool`
`isUinteger` [get]	`bool`
`map` [set]	`Setting[string]`	sets `Setting`[string] `map`
`map` [get]	`Setting[string]`	returns items as `Setting`[string] `map`
`parent` [get]	`inout(Setting)`	get `parent`
`parent` [set]	`Setting`	set `parent`
`str` [get]	`inout(string)`	read as string value
`str` [set]	`string`	set string value for object
`strArray` [get]	`string[]`	returns items as string `array`
`strArray` [set]	`string[]`	sets string `array`
`strMap` [set]	`string[string]`	sets string[string] `map`
`strMap` [get]	`string[string]`	returns items as string[string] `map`
`type` [get]	`SettingType`	returns `SettingType` of setting
`uinteger` [set]	`ulong`	set ulong value for object
`uinteger` [get]	`inout(long)`	read as ulong value

Methods

Name	Description
`apply`
`booleanDef`	read as `boolean` value
`clear`	`clear` value
`clear`	`clear` value and set new `type`
`clone`	deep copy of settings
`floatingDef`	read as double value with default
`getBoolean`	returns bool item by `index` of `array` or `map`
`getBoolean`	returns bool item by `key` from `map`
`getFloating`	returns double item by `index` of `array` or `map`
`getFloating`	returns double item by `key` from `map`
`getInteger`	returns long item by `index` of `array` or `map`
`getInteger`	returns long item by `key` from `map`
`getString`	returns `str` item by `index` of `array` or `map`
`getString`	returns `str` item by `key` from `map`
`getStringArray`	returns string `array` item by `key` from `map`, returns null if not found
`getUinteger`	returns ulong item by `key` from `map`
`getUinteger`	returns ulong item by `index` of `array` or `map`
`integerDef`	read as long value
`length`	get number of elements for `array` or `map`, returns 0 for other types
`load`
`objectByPath`	get (or optionally create) object (`map`) by slash delimited `path` (e.g. key1/subkey2/subkey3)
`opApply`	to iterate using foreach
`opApply`	to iterate over OBJECT using foreach(key, value; `map`)
`opApplyReverse`	to iterate using foreach_reverse
`opAssign`
`opAssign`
`opAssign`
`opAssign`
`opAssign`
`opAssign`
`opAssign`
`opAssign`
`opAssign`
`opAssign`
`opAssign`
`opIndex`	for `array` or object returns item by `index`, null if `index` is out of bounds or setting is neither `array` nor object
`opIndex`	for object returns item by `key`, null if not found or this setting is not an object
`opIndexAssign`	sets `value` for object item by string `key`
`opIndexAssign`	sets `value` for `array` item by `integer` `index`
`parseBool`	parse string as `boolean`; supports 1, 0, y, n, yes, no, t, f, true, false; returns `defValue` if cannot be parsed
`parseJSON`
`remove`	for object `remove` item by `key`, returns removed item or null if is not found or setting is not an object
`remove`	for `array` or object `remove` item by `index`, returns removed item or null if `index` is out of bounds or setting is neither `array` nor object
`save`	`save` to file
`setBoolean`	sets bool item of `map`
`setBoolean`	sets bool item by `index` of `array` or `map`
`setBooleanDef`	sets bool item of `map` if `key` is not yet present in `map`
`setBooleanDef`	sets bool item by `index` of `array` or `map` only if it's фдкуфвн present
`setDef`	sets `value` for `array` item by `integer` `index` if not already present
`setDef`	sets `value` for object item by string `key`
`setFloating`	sets double item of `map`
`setFloating`	sets double item by `index` of `array` or `map`
`setFloatingDef`	sets double item of `map` if `key` is not yet present in `map`
`setFloatingDef`	sets double item by `index` of `array` or `map` only if it's фдкуфвн present
`setInteger`	sets long item of `map`
`setInteger`	sets long item by `index` of `array` or `map`
`setIntegerDef`	sets long item of `map` if `key` is not yet present in `map`
`setIntegerDef`	sets long item by `index` of `array` or `map` only if it's фдкуфвн present
`setString`	sets `str` item of `map`
`setString`	sets `str` item by `index` of `array` or `map`
`setStringDef`	sets `str` item by `index` of `array` or `map` only if it's фдкуфвн present
`setStringDef`	sets `str` item of `map` if `key` is not yet present in `map`
`settingByPath`	returns setting by `path` like "editors/sourceEditor/tabSize", creates object tree "editors/sourceEditor" and object of specified `type` if part of `path` does not exist.
`setUinteger`	sets ulong item of `map`
`setUinteger`	sets ulong item by `index` of `array` or `map`
`setUintegerDef`	sets ulong item of `map` if `key` is not yet present in `map`
`setUintegerDef`	sets ulong item by `index` of `array` or `map` only if it's фдкуфвн present
`strDef`	read as string value
`toJSON`	serialize to json
`toJSON`
`uintegerDef`	read as ulong value

Unions

Name	Description
`Store`

Authors

Vadim Lopatin, coolreader.org@gmail.com

Copyright

Vadim Lopatin, 2014

License

Boost License 1.0