Gambas Documentation - /comp/gb.settings

/comp/gb.settings

# gb.settings

This component allows your project to deal with application configuration files.

Author | Benoît Minisini.

Class | Description
--- | ---
Settings | This class manages global configuration files.

### Configuration Files

These files, typically called "xyzzy.conf" (where "xyzzy" is the name of your application), can be interrogated to obtain locally specific settings and can be used to store such settings between invocations of the application.

### Configuration File Syntax

A configuration file is a text file, in which each line is:

- A void line, that is ignored.

- A comment line, beginning with a '`#`' or a '`;`' character, that is ignored.

- A value line, which is a `"Key=Value"` pair.

- A slot line, which begins with a '`[`' character, and ends with a '`]`' character. This groups key/value lines together in a slot.

A value is accessed from its full key, which is the slot name followed by a slash and the key.

A slot name can contain slashes too.

### Examples

    [Editor]
    Font="Bitstream Vera Sans Mono"
    Toolbar=1
    CleanOnSave=0
    ShowProc=1
    ShowChange=1
    ShowCurrent=1
    UseRelief=1
    Color[0]="&FFFFFF&"
    Color[1]="&000000&"
    Color[2]="&00C0A0&"
    Color[3]="&00C000&"

    [ExistingFile]
    ExplorerType=0
    Splitter="249,249"
    TreeSequence="0"
    PreviewImg=0
    ShowHidden=0

    [ExistingImage]
    Path="/usr/share/icons/crystalsvg/64x64/devices"
    Key="1"
    ExplorerType=1
    Splitter="212,434"
    TreeSequence="1"
    PreviewImg=1
    ShowHidden=0

    [...]