Class Fox::FXSettings
In: rdoc-sources/FXSettings.rb
lib/fox12/core.rb
Parent: FXDict

FXSettings is a key-value database. This is normally used as part of FXRegistry, but can also be used separately in application that need to maintain a key-value database of their own.

Methods

data   deleteEntry   deleteSection   each_section   existingEntry?   existingSection?   find   modified=   modified?   new   parseFile   readBoolEntry   readColorEntry   readIntEntry   readRealEntry   readStringEntry   readUnsignedEntry   unparseFile   writeBoolEntry   writeColorEntry   writeIntEntry   writeRealEntry   writeStringEntry   writeUnsignedEntry  

Public Class methods

new( {|theSettings| ...}

Return an initialized FXSettings instance.

Public Instance methods

data(pos)

Obtain the string dictionary (an FXStringDict instance) for the requested section number.

Parameters:

pos:the section number of interest [Integer]
deleteEntry(section, key)

Delete the registry entry for the specified section and key. Returns true on success, false otherwise.

Parameters:

section:the section containing the key to be deleted [String]
key:the key to be deleted [String]
deleteSection(section)

Delete an entire section from this settings database. Returns true on success, false otherwise.

Parameters:

section:the name of the section to be deleted [String]
each_section( {|aStringDict| ...}

Iterate over sections (where each section is a dictionary).

existingEntry?(section, key)

Returns true if a registry entry exists for the specified section and key.

Parameters:

section:the section containing the key of interest [String]
key:the key of interest [String]
existingSection?(section)

Returns true if the named section exists.

Parameters:

section:the name of the section of interest [String]
find(section)

Find a section given its name. Returns the section (an FXStringDict instance) if found, otherwise returns nil.

Parameters:

section:the section name of interest [String]
modified=(mdfy=true)

Mark as changed.

modified?()

Returns true if this settings object has been modified.

parseFile(filename, mark)

Parse a file containing a settings database. Returns true on success, false otherwise.

readBoolEntry(section, key, default=false)

Read a boolean registry entry from the specified section and key. If no value is found, the default value is returned.

readColorEntry(section, key, default=0)

Read a color value registry entry from the specified section and key. If no value is found, the default value is returned.

Parameters:

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]
readIntEntry(section, key, default=0)

Read an integer registry entry from the specified section and key. If no value is found, the default value is returned.

Parameters:

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]
readRealEntry(section, key, default=0.0)

Read a double-precision floating point registry entry from the specified section and key. If no value is found, the default value is returned.

Parameters:

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]
readStringEntry(section, key, default="")

Read a string registry entry from the specified section and key. If no value is found, the default value is returned.

Parameters:

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]
readUnsignedEntry(section, key, default=0)

Read an unsigned integer registry entry from the specified section and key. If no value is found, the default value is returned.

Parameters:

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]
unparseFile(filename)

Unparse settings database into given file. Returns true on success, false otherwise.

writeBoolEntry(section, key, value)

Write a boolean registry value to the specified section and key.

writeColorEntry(section, key, value)

Write a color registry value to the specified section and key. Returns true on success, false otherwise.

Parameters:

section:the section name [String]
key:the key for this setting [String]
value:the value for this setting [FXColor]
writeIntEntry(section, key, value)

Write an integer registry value to the specified section and key. Returns true on success, false otherwise.

Parameters:

section:the section name [String]
key:the key for this setting [String]
value:the value for this setting [Integer]
writeRealEntry(section, key, value)

Write a double-precision floating point registry value to the specified section and key. Returns true on success, false otherwise.

Parameters:

section:the section name [String]
key:the key for this setting [String]
value:the value for this setting [Float]
writeStringEntry(section, key, value)

Write a string registry value to the specified section and key. Returns true on success, false otherwise.

Parameters:

section:the section name [String]
key:the key for this setting [String]
value:the value for this setting [String]
writeUnsignedEntry(section, key, value)

Write an unsigned integer registry value to the specified section and key. Returns true on success, false otherwise.

Parameters:

section:the section name [String]
key:the key for this setting [String]
value:the value for this setting [Integer]

[Validate]