<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="utf-8">
    <title>Fl_Preferences Binding Map</title>
    <link href="map.css" rel="stylesheet">
  </head>

  <body>


<h2>Fl_Preferences Binding Map</h2>


<a href="index.html">Back to Index</a>


<table class="package">
  <tr><th colspan="2">Package name</th></tr>

  <tr>
    <td>Fl_Preferences</td>
    <td>FLTK.Environment</td>
  </tr>

</table>



<table class="type">
  <tr><th colspan="2">Types</th></tr>

  <tr>
    <td>Fl_Preferences</td>
    <td>Database</td>
  </tr>

  <tr>
    <td>&nbsp;</td>
    <td>Database_Reference</td>
  </tr>

  <tr>
    <td>&nbsp;</td>
    <td>Pref_Group</td>
  </tr>

  <tr>
    <td>&nbsp;</td>
    <td>Pref_Group_Reference</td>
  </tr>

  <tr>
    <td>Entry</td>
    <td>&nbsp;</td>
  </tr>

  <tr>
    <td>Name</td>
    <td>&nbsp;</td>
  </tr>

  <tr>
    <td>Root</td>
    <td>Scope</td>
  </tr>

  <tr>
    <td>ID</td>
    <td>&nbsp;</td>
  </tr>

</table>



<table class="type">
  <tr><th colspan="2">Errors</th></tr>

  <tr>
    <td>&nbsp;</td>
    <td>Preference_Error</td>
  </tr>

</table>



<table class="function">
  <tr><th colspan="2">Static Functions and Procedures</th></tr>

  <tr>
<td><pre>
static const char * newUUID();
</pre></td>
<td><pre>
function New_UUID
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
static char remove(ID id_);
</pre></td>
<td>&nbsp;</td>
  </tr>

</table>



<table class="function">
  <tr><th colspan="2">Functions and Procedures</th></tr>

  <tr>
<td><pre>
Fl_Preferences(Root root, const char *vendor, const char *application);
</pre></td>
<td><pre>
function From_Scope
       (Extent              : in Scope;
        Vendor, Application : in String)
    return Database;
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Preferences(const char *path, const char *vendor,
    const char *application);
</pre></td>
<td><pre>
function From_Filesystem
       (Directory, Vendor, Application : in String)
    return Database;
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Preferences(Fl_Preferences &parent, const char *group);
Fl_Preferences(Fl_Preferences *parent, const char *group);
</pre></td>
<td><pre>
function By_Name
       (From : in Pref_Group;
        Name : in String)
    return Pref_Group'Class;

function In_Memory
       (Name : in String)
    return Pref_Group;
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Preferences(Fl_Preferences &parent, int groupIndex);
Fl_Preferences(Fl_Preferences *parent, int groupIndex);
</pre></td>
<td><pre>
function By_Index
       (From  : in Pref_Group;
        Index : in Positive)
    return Pref_Group'Class;
</pre></td>
  </tr>

  <tr>
<td><pre>
Fl_Preferences(const Fl_Preferences &);
</pre></td>
<td><pre>
function Root
       (From : in Database)
    return Pref_Group'Class;
</pre></td>
  </tr>

  <tr>
<td><pre>
char clear();
</pre></td>
<td><pre>
procedure Clear
       (This : in out Pref_Group)
with Post => This.Number_Of_Entries = 0 and
        This.Number_Of_Groups = 0;
</pre></td>
  </tr>

  <tr>
<td><pre>
char deleteAllEntries();
</pre></td>
<td><pre>
procedure Delete_All_Entries
       (This : in out Pref_Group)
with Post => This.Number_Of_Entries = 0;
</pre></td>
  </tr>

  <tr>
<td><pre>
char deleteAllGroups();
</pre></td>
<td><pre>
procedure Delete_All_Groups
       (This : in out Pref_Group)
with Post => This.Number_Of_Groups = 0;
</pre></td>
  </tr>

  <tr>
<td><pre>
char deleteEntry(const char *entry);
</pre></td>
<td><pre>
procedure Delete_Entry
       (This : in out Pref_Group;
        Key  : in     String)
with Post => This.Key_Exists (Key) = False;
</pre></td>
  </tr>

  <tr>
<td><pre>
char deleteGroup(const char *group);
</pre></td>
<td><pre>
procedure Delete_Group
       (This : in out Pref_Group;
        Name : in     String)
with Post => This.Group_Exists (Name) = False;
</pre></td>
  </tr>

  <tr>
<td><pre>
int entries();
</pre></td>
<td><pre>
function Number_Of_Entries
       (This : in Pref_Group)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
const char * entry(int index);
</pre></td>
<td><pre>
function Entry_Key
       (This  : in Pref_Group;
        Index : in Positive)
    return String
with Pre => Index in 1 .. This.Number_Of_Entries;
</pre></td>
  </tr>

  <tr>
<td><pre>
char entryExists(const char *key);
</pre></td>
<td><pre>
function Key_Exists
       (This : in Pref_Group;
        Key  : in String)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
void flush();
</pre></td>
<td><pre>
procedure Flush
       (This : in Database);
</pre></td>
  </tr>

  <tr>
<td><pre>
char get(const char *entry, int &value, int defaultValue);
</pre></td>
<td><pre>
function Get
       (This : in Pref_Group;
        Key  : in String)
    return Integer;

function Get
       (This    : in Pref_Group;
        Key     : in String;
        Default : in Integer)
    return Integer;
</pre></td>
  </tr>

  <tr>
<td><pre>
char get(const char *entry, float &value, float defaultValue);
</pre></td>
<td><pre>
function Get
       (This : in Pref_Group;
        Key  : in String)
    return Float;

function Get
       (This    : in Pref_Group;
        Key     : in String;
        Default : in Float)
    return Float;
</pre></td>
  </tr>

  <tr>
<td><pre>
char get(const char *entry, double &value, double defaultValue);
</pre></td>
<td><pre>
function Get
       (This : in Pref_Group;
        Key  : in String)
    return Long_Float;

function Get
       (This    : in Pref_Group;
        Key     : in String;
        Default : in Long_Float)
    return Long_Float;
</pre></td>
  </tr>

  <tr>
<td><pre>
char get(const char *entry, char *&value, const char *defaultValue);
</pre></td>
<td><pre>
function Get
       (This : in Pref_Group;
        Key  : in String)
    return String;

function Get
       (This    : in Pref_Group;
        Key     : in String;
        Default : in String)
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
char get(const char *entry, char *value, const char *defaultValue,
    int maxSize);
</pre></td>
<td><pre>
function Get
       (This       : in Pref_Group;
        Key        : in String;
        Default    : in String;
        Max_Length : in Natural)
    return String
with Post => Get'Result'Length <= Max_Length;
</pre></td>
  </tr>

  <tr>
<td><pre>
char get(const char *entry, void *&value, const void *defaultValue,
    int defaultSize);
</pre></td>
<td><pre>
function Get
       (This : in Pref_Group;
        Key  : in String)
    return Binary_Data;

function Get
       (This    : in Pref_Group;
        Key     : in String;
        Default : in Binary_Data)
    return Binary_Data;
</pre></td>
  </tr>

  <tr>
<td><pre>
char get(const char *entry, void *value, const void *defaultValue,
    int defaultSize, int maxSize);
</pre></td>
<td><pre>
function Get
       (This       : in Pref_Group;
        Key        : in String;
        Default    : in Binary_Data;
        Max_Length : in Natural)
    return Binary_Data
with Post => Get'Result'Length <= Max_Length;
</pre></td>
  </tr>

  <tr>
<td><pre>
char getUserdataPath(char *path, int pathlen);
</pre></td>
<td><pre>
function Userdata_Path
       (This : in Database)
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
const char * group(int num_group);
</pre></td>
<td><pre>
function Group_Name
       (This  : in Pref_Group;
        Index : in Positive)
    return String
with Pre => Index in 1 .. This.Number_Of_Groups;
</pre></td>
  </tr>

  <tr>
<td><pre>
char groupExists(const char *key);
</pre></td>
<td><pre>
function Group_Exists
       (This : in Pref_Group;
        Name : in String)
    return Boolean;
</pre></td>
  </tr>

  <tr>
<td><pre>
int groups();
</pre></td>
<td><pre>
function Number_Of_Groups
       (This : in Pref_Group)
    return Natural;
</pre></td>
  </tr>

  <tr>
<td><pre>
ID id();
</pre></td>
<td>&nbsp;</td>
  </tr>

  <tr>
<td><pre>
const char * name();
</pre></td>
<td><pre>
function At_Name
       (This : in Pref_Group)
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
const char * path();
</pre></td>
<td><pre>
function At_Path
       (This : in Pref_Group)
    return String;
</pre></td>
  </tr>

  <tr>
<td><pre>
char set(const char *entry, int value);
</pre></td>
<td><pre>
procedure Set
       (This  : in out Pref_Group;
        Key   : in     String;
        Value : in     Integer)
with Post => This.Key_Exists (Key);
</pre></td>
  </tr>

  <tr>
<td><pre>
char set(const char *entry, float value);
</pre></td>
<td><pre>
procedure Set
       (This  : in out Pref_Group;
        Key   : in     String;
        Value : in     Float)
with Post => This.Key_Exists (Key);
</pre></td>
  </tr>

  <tr>
<td><pre>
char set(const char *entry, float value, int precision);
</pre></td>
<td><pre>
procedure Set
       (This      : in out Pref_Group;
        Key       : in     String;
        Value     : in     Float;
        Precision : in     Natural)
with Post => This.Key_Exists (Key);
</pre></td>
  </tr>

  <tr>
<td><pre>
char set(const char *entry, double value);
</pre></td>
<td><pre>
procedure Set
       (This  : in out Pref_Group;
        Key   : in     String;
        Value : in     Long_Float)
with Post => This.Key_Exists (Key);
</pre></td>
  </tr>

  <tr>
<td><pre>
char set(const char *entry, double value, int precision);
</pre></td>
<td><pre>
procedure Set
       (This      : in out Pref_Group;
        Key       : in     String;
        Value     : in     Long_Float;
        Precision : in     Natural)
with Post => This.Key_Exists (Key);
</pre></td>
  </tr>

  <tr>
<td><pre>
char set(const char *entry, const char *value);
</pre></td>
<td><pre>
procedure Set
       (This  : in out Pref_Group;
        Key   : in     String;
        Value : in     String)
with Post => This.Key_Exists (Key);
</pre></td>
  </tr>

  <tr>
<td><pre>
char set(const char *entry, const void *value, int size);
</pre></td>
<td><pre>
procedure Set
       (This  : in out Pref_Group;
        Key   : in     String;
        Value : in     Binary_Data)
with Post => This.Key_Exists (Key);
</pre></td>
  </tr>

  <tr>
<td><pre>
int size(const char *entry);
</pre></td>
<td><pre>
function Value_Size
       (This : in Pref_Group;
        Key  : in String)
    return Natural;
</pre></td>
  </tr>

</table>


  </body>
</html>