Class | Fox::FXSettings |
In: |
rdoc-sources/FXSettings.rb
|
Parent: | FXDict |
The Settings class manages a key-value database. This is normally used as part of Registry, but can also be used separately in applications that need to maintain a key-value database in a file of their own. String values can contain any character, and will be escaped when written to the file.
Obtain the string dictionary (an FXStringDict instance) for the requested section number.
pos: | the section number of interest [Integer] |
Delete the registry entry for the specified section and key. Returns true on success, false otherwise.
section: | the section containing the key to be deleted [String] |
key: | the key to be deleted [String] |
Delete an entire section from this settings database. Returns true on success, false otherwise.
section: | the name of the section to be deleted [String] |
Returns true if a registry entry exists for the specified section and key.
section: | the section containing the key of interest [String] |
key: | the key of interest [String] |
Returns true if the named section exists.
section: | the name of the section of interest [String] |
Find a section given its name. Returns the section (an FXStringDict instance) if found, otherwise returns nil.
section: | the section name of interest [String] |
Read a boolean valued registry entry from the specified section and key. If no value is found, the default value is returned.
section: | the section name [String] |
key: | the key for the setting of interest [String] |
default: | the default value to return if key is not found [true or false] |
Read a color value registry entry from the specified section and key. If no value is found, the default value is returned.
section: | the section name [String] |
key: | the key for the setting of interest [String] |
default: | the default value to return if key is not found [FXColor] |
Read an integer registry entry from the specified section and key. If no value is found, the default value is returned.
section: | the section name [String] |
key: | the key for the setting of interest [String] |
default: | the default value to return if key is not found [Integer] |
Read a double-precision floating point registry entry from the specified section and key. If no value is found, the default value is returned.
section: | the section name [String] |
key: | the key for the setting of interest [String] |
default: | the default value to return if key is not found [Float] |
Read a string registry entry from the specified section and key. If no value is found, the default value is returned.
section: | the section name [String] |
key: | the key for the setting of interest [String] |
default: | the default value to return if key is not found [String] |
Read an unsigned integer registry entry from the specified section and key. If no value is found, the default value is returned.
section: | the section name [String] |
key: | the key for the setting of interest [String] |
default: | the default value to return if key is not found [Integer] |
Write a boolean registry value to the specified section and key. Returns true on success, false otherwise.
section: | the section name [String] |
key: | the key for this setting [String] |
value: | the value for this setting [true or false] |
Write a color registry value to the specified section and key. Returns true on success, false otherwise.
section: | the section name [String] |
key: | the key for this setting [String] |
value: | the value for this setting [FXColor] |
Write an integer registry value to the specified section and key. Returns true on success, false otherwise.
section: | the section name [String] |
key: | the key for this setting [String] |
value: | the value for this setting [Integer] |
Write a double-precision floating point registry value to the specified section and key. Returns true on success, false otherwise.
section: | the section name [String] |
key: | the key for this setting [String] |
value: | the value for this setting [Float] |
Write a string registry value to the specified section and key. Returns true on success, false otherwise.
section: | the section name [String] |
key: | the key for this setting [String] |
value: | the value for this setting [String] |