Class Setting
setting object
class Setting;
Constructors
| Name | Description |
|---|---|
this
()
|
|
this
(v)
|
|
this
(v)
|
|
this
(v)
|
|
this
(v)
|
|
this
(v)
|
|
this
(v)
|
|
this
(v)
|
|
this
(v)
|
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[get]
|
inout(double) | read as double value |
floating[set]
|
double | set ulong value for object |
intArray[get]
|
int[] | returns items as int array |
intArray[set]
|
int[] | sets 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[get]
|
Setting[string] | returns items as Setting[string] map |
map[set]
|
Setting[string] | sets Setting[string] map |
parent[get]
|
inout(Setting) | get parent |
parent[set]
|
Setting | set parent |
str[get]
|
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[get]
|
string[string] | returns items as string[string] map |
strMap[set]
|
string[string] | sets string[string] map |
type[get]
|
SettingType | returns SettingType of setting |
uinteger[get]
|
inout(long) | read as ulong value |
uinteger[set]
|
ulong | set ulong value for object |
Methods
| Name | Description |
|---|---|
apply
(settings)
|
|
booleanDef
(defValue)
|
read as boolean value |
clear
(newType)
|
clear value and set new type |
clear
()
|
clear value |
clone
()
|
deep copy of settings |
convertEols
(src)
|
convert CR LF, LF CR, LF, CR to '\n' eol format |
floatingDef
(defValue)
|
read as double value with default |
getBoolean
(index, defValue)
|
returns bool item by index of array or map |
getBoolean
(key, defValue)
|
returns bool item by key from map |
getFloating
(index, defValue)
|
returns double item by index of array or map |
getFloating
(key, defValue)
|
returns double item by key from map |
getInteger
(index, defValue)
|
returns long item by index of array or map |
getInteger
(key, defValue)
|
returns long item by key from map |
getString
(index, defValue)
|
returns str item by index of array or map |
getString
(key, defValue)
|
returns str item by key from map |
getStringArray
(key)
|
returns string array item by key from map, returns null if not found |
getUinteger
(index, defValue)
|
returns ulong item by index of array or map |
getUinteger
(key, defValue)
|
returns ulong item by key from map |
integerDef
(defValue)
|
read as long value |
length
()
|
get number of elements for array or map, returns 0 for other types |
load
(filename)
|
load from file; autodetect SDL format using ".sdl" and ".SDL" extension mask; returns true if loaded successfully |
objectByPath
(path, createIfNotExist)
|
get (or optionally create) object (map) by slash delimited path (e.g. key1/subkey2/subkey3) |
opApply
(dg)
|
to iterate using foreach |
opApply
(dg)
|
to iterate over OBJECT using foreach(key, value; map) |
opApplyReverse
(dg)
|
to iterate using foreach_reverse |
opAssign
(value)
|
|
opAssign
(value)
|
|
opAssign
(value)
|
|
opAssign
(value)
|
|
opAssign
(value)
|
|
opAssign
(value)
|
|
opAssign
(value)
|
|
opAssign
(value)
|
|
opAssign
(value)
|
|
opAssign
(value)
|
|
opAssign
(value)
|
|
opIndex
(index)
|
for array or object returns item by index, null if index is out of bounds or setting is neither array nor object |
opIndex
(key)
|
for object returns item by key, null if not found or this setting is not an object |
opIndexAssign
(value, index)
|
sets value for array item by integer index |
opIndexAssign
(value, key)
|
sets value for object item by string key |
parseBool
(v, defValue)
|
parse string as boolean; supports 1, 0, y, n, yes, no, t, f, true, false; returns defValue if cannot be parsed |
parseJSON
(s)
|
|
parseSDL
(s)
|
|
remove
(index)
|
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 |
remove
(key)
|
for object remove item by key, returns removed item or null if is not found or setting is not an object |
save
(filename, pretty)
|
save to file |
setBoolean
(index, value)
|
sets bool item by index of array or map |
setBoolean
(key, value)
|
sets bool item of map |
setBooleanDef
(index, value)
|
sets bool item by index of array or map only if it's фдкуфвн present |
setBooleanDef
(key, value)
|
sets bool item of map if key is not yet present in map |
setDef
(value, index)
|
sets value for array item by integer index if not already present |
setDef
(value, key)
|
sets value for object item by string key |
setFloating
(index, value)
|
sets double item by index of array or map |
setFloating
(key, value)
|
sets double item of map |
setFloatingDef
(index, value)
|
sets double item by index of array or map only if it's фдкуфвн present |
setFloatingDef
(key, value)
|
sets double item of map if key is not yet present in map |
setInteger
(index, value)
|
sets long item by index of array or map |
setInteger
(key, value)
|
sets long item of map |
setIntegerDef
(index, value)
|
sets long item by index of array or map only if it's фдкуфвн present |
setIntegerDef
(key, value)
|
sets long item of map if key is not yet present in map |
setString
(index, value)
|
sets str item by index of array or map |
setString
(key, value)
|
sets str item of map |
setStringDef
(index, value)
|
sets str item by index of array or map only if it's фдкуфвн present |
setStringDef
(key, value)
|
sets str item of map if key is not yet present in map |
settingByPath
(path, type, createIfNotExist)
|
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
(index, value)
|
sets ulong item by index of array or map |
setUinteger
(key, value)
|
sets ulong item of map |
setUintegerDef
(index, value)
|
sets ulong item by index of array or map only if it's фдкуфвн present |
setUintegerDef
(key, value)
|
sets ulong item of map if key is not yet present in map |
strDef
(defValue)
|
read as string value |
toJSON
(pretty)
|
serialize to json |
toJSON
(buf, level, pretty)
|
|
uintegerDef
(defValue)
|
read as ulong value |
isArrayIdent
(ident)
|
|
isArrayItemNameIdent
(ident)
|
|
isObjectItemNameIdent
(ident)
|
Unions
| Name | Description |
|---|---|
Store
|