Class Xiron::ConfigEntry
In: lib/xiron/config.rb
Parent: Object

An instance of this class represents a configuration entry

Methods

commit   get   new   set  

Attributes

default  [RW]  The default value of the config entry. A new default value is checked against the domain.
description  [RW]  A short description of this entry
domain  [RW]  Holds the valid range of values and default values. The values and defaults are checked if a new domain is assigned and if they are not nil. The type of the domain determines the type of the config entry as a whole. So initialize to 0 or "" for Number or String values. For enum-Entries, use an Array, for range-Entries use a Range.
help  [RW]  A help text associated with this entry
key  [R]  The key of this config entry (a String)
level  [RW]  The user experience level for this entry. 0 for beginner, 10 for average, 20 for masters.
value  [RW]  The value of the config entry. A new value is checked against the domain.

Public Class methods

get(key)

returns the value of the entry specified by given key

new(key) → ConfigEntry
new(key) { |entry| ... } → ConfigEntry

constructs a config entry object with given key (String). if the given key is known to the xine engine, the new instance is initialized with the stored config values.

if a block is given, it is yielded with the new object, and after this, ConfigEntry#commit is called.

set(key,value)

a helper to easily set a single entry value. returns a new ConfigEntry instance, but the given value has already been commited.

Public Instance methods

commit() → self

Stores the current state into the configuration system of xine

[Validate]