diff options
Diffstat (limited to 'doc/fl_preferences.html')
| -rw-r--r-- | doc/fl_preferences.html | 326 |
1 files changed, 251 insertions, 75 deletions
diff --git a/doc/fl_preferences.html b/doc/fl_preferences.html index b3d5ec0..aece3c6 100644 --- a/doc/fl_preferences.html +++ b/doc/fl_preferences.html @@ -1,4 +1,3 @@ - <!DOCTYPE html> <html lang="en"> @@ -14,6 +13,9 @@ <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> @@ -31,12 +33,22 @@ <tr> <td>Fl_Preferences</td> - <td>Preferences</td> + <td>Database</td> </tr> <tr> <td> </td> - <td>Preferences_Reference</td> + <td>Database_Reference</td> + </tr> + + <tr> + <td>Fl_Preferences</td> + <td>Pref_Group</td> + </tr> + + <tr> + <td> </td> + <td>Pref_Group_Reference</td> </tr> <tr> @@ -45,6 +57,11 @@ </tr> <tr> + <td>Name</td> + <td> </td> + </tr> + + <tr> <td>Root</td> <td>Scope</td> </tr> @@ -58,57 +75,149 @@ +<table class="type"> + <tr><th colspan="2">Errors</th></tr> + + <tr> + <td>char</td> + <td>Preference_Error</td> + </tr> + +</table> + + + <table class="function"> - <tr><th colspan="2">Functions and Procedures</th></tr> + <tr><th colspan="2">Protected Attributes</th></tr> + + <tr> +<td><pre> +Node * node; +</pre></td> +<td>Intentionally left unbound.</td> + </tr> + + <tr> +<td><pre> +RootNode * rootNode; +</pre></td> +<td>Intentionally left unbound.</td> + </tr> + +</table> + + + +<table class="function"> + <tr><th colspan="2">Constructors</th></tr> <tr> <td><pre> Fl_Preferences(Root root, const char *vendor, const char *application); </pre></td> -<td>TBA</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); +Fl_Preferences(const char *path, const char *vendor, + const char *application); </pre></td> <td><pre> function From_Filesystem - (Path, Vendor, Application : in String) - return Preferences; + (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>TBA</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>TBA</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>TBA</td> +<td><pre> +function Root + (From : in Database) + return Pref_Group'Class; +</pre></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>Intentionally left unbound.</td> + </tr> + +</table> + + + +<table class="function"> + <tr><th colspan="2">Functions and Procedures</th></tr> + <tr> <td><pre> char clear(); </pre></td> <td><pre> procedure Clear - (This : in out Preferences); + (This : in out Pref_Group) +with Post => This.Number_Of_Entries = 0 and + This.Number_Of_Groups = 0; </pre></td> </tr> @@ -118,7 +227,8 @@ char deleteAllEntries(); </pre></td> <td><pre> procedure Delete_All_Entries - (This : in out Preferences); + (This : in out Pref_Group) +with Post => This.Number_Of_Entries = 0; </pre></td> </tr> @@ -126,7 +236,11 @@ procedure Delete_All_Entries <td><pre> char deleteAllGroups(); </pre></td> -<td>TBA</td> +<td><pre> +procedure Delete_All_Groups + (This : in out Pref_Group) +with Post => This.Number_Of_Groups = 0; +</pre></td> </tr> <tr> @@ -135,8 +249,9 @@ char deleteEntry(const char *entry); </pre></td> <td><pre> procedure Delete_Entry - (This : in out Preferences; - Key : in String); + (This : in out Pref_Group; + Key : in String) +with Post => This.Key_Exists (Key) = False; </pre></td> </tr> @@ -144,7 +259,12 @@ procedure Delete_Entry <td><pre> char deleteGroup(const char *group); </pre></td> -<td>TBA</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> @@ -153,7 +273,7 @@ int entries(); </pre></td> <td><pre> function Number_Of_Entries - (This : in Preferences) + (This : in Pref_Group) return Natural; </pre></td> </tr> @@ -163,10 +283,11 @@ function Number_Of_Entries const char * entry(int index); </pre></td> <td><pre> -function Get_Key - (This : in Preferences; - Index : in Natural) - return String; +function Entry_Key + (This : in Pref_Group; + Index : in Positive) + return String +with Pre => Index in 1 .. This.Number_Of_Entries; </pre></td> </tr> @@ -175,8 +296,8 @@ function Get_Key char entryExists(const char *key); </pre></td> <td><pre> -function Entry_Exists - (This : in Preferences; +function Key_Exists + (This : in Pref_Group; Key : in String) return Boolean; </pre></td> @@ -188,7 +309,7 @@ void flush(); </pre></td> <td><pre> procedure Flush - (This : in Preferences); + (This : in Database); </pre></td> </tr> @@ -198,12 +319,12 @@ char get(const char *entry, int &value, int defaultValue); </pre></td> <td><pre> function Get - (This : in Preferences; + (This : in Pref_Group; Key : in String) return Integer; function Get - (This : in Preferences; + (This : in Pref_Group; Key : in String; Default : in Integer) return Integer; @@ -216,12 +337,12 @@ char get(const char *entry, float &value, float defaultValue); </pre></td> <td><pre> function Get - (This : in Preferences; + (This : in Pref_Group; Key : in String) return Float; function Get - (This : in Preferences; + (This : in Pref_Group; Key : in String; Default : in Float) return Float; @@ -234,12 +355,12 @@ char get(const char *entry, double &value, double defaultValue); </pre></td> <td><pre> function Get - (This : in Preferences; + (This : in Pref_Group; Key : in String) return Long_Float; function Get - (This : in Preferences; + (This : in Pref_Group; Key : in String; Default : in Long_Float) return Long_Float; @@ -252,12 +373,12 @@ char get(const char *entry, char *&value, const char *defaultValue); </pre></td> <td><pre> function Get - (This : in Preferences; + (This : in Pref_Group; Key : in String) return String; function Get - (This : in Preferences; + (This : in Pref_Group; Key : in String; Default : in String) return String; @@ -266,72 +387,129 @@ function Get <tr> <td><pre> -char get(const char *entry, char *value, const char *defaultValue, int maxSize); +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> -<td>TBA</td> </tr> <tr> <td><pre> -char get(const char *entry, void *&value, const void *defaultValue, int defaultSize); +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> -<td>TBA</td> </tr> <tr> <td><pre> -char get(const char *entry, void *value, const void *defaultValue, int defaultSize, int maxSize); +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> -<td>TBA</td> </tr> <tr> <td><pre> char getUserdataPath(char *path, int pathlen); </pre></td> -<td>TBA</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>TBA</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>TBA</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>TBA</td> +<td><pre> +function Number_Of_Groups + (This : in Pref_Group) + return Natural; +</pre></td> </tr> <tr> <td><pre> ID id(); </pre></td> -<td>TBA</td> +<td>Intentionally left unbound.</td> </tr> <tr> <td><pre> const char * name(); </pre></td> -<td>TBA</td> +<td><pre> +function At_Name + (This : in Pref_Group) + return String; +</pre></td> </tr> <tr> <td><pre> const char * path(); </pre></td> -<td>TBA</td> +<td><pre> +function At_Path + (This : in Pref_Group) + return String; +</pre></td> </tr> <tr> @@ -340,9 +518,10 @@ char set(const char *entry, int value); </pre></td> <td><pre> procedure Set - (This : in out Preferences; + (This : in out Pref_Group; Key : in String; - Value : in Integer); + Value : in Integer) +with Post => This.Key_Exists (Key); </pre></td> </tr> @@ -352,9 +531,10 @@ char set(const char *entry, float value); </pre></td> <td><pre> procedure Set - (This : in out Preferences; + (This : in out Pref_Group; Key : in String; - Value : in Float); + Value : in Float) +with Post => This.Key_Exists (Key); </pre></td> </tr> @@ -364,10 +544,11 @@ char set(const char *entry, float value, int precision); </pre></td> <td><pre> procedure Set - (This : in out Preferences; + (This : in out Pref_Group; Key : in String; Value : in Float; - Precision : in Natural); + Precision : in Natural) +with Post => This.Key_Exists (Key); </pre></td> </tr> @@ -377,9 +558,10 @@ char set(const char *entry, double value); </pre></td> <td><pre> procedure Set - (This : in out Preferences; + (This : in out Pref_Group; Key : in String; - Value : in Long_Float); + Value : in Long_Float) +with Post => This.Key_Exists (Key); </pre></td> </tr> @@ -389,10 +571,11 @@ char set(const char *entry, double value, int precision); </pre></td> <td><pre> procedure Set - (This : in out Preferences; + (This : in out Pref_Group; Key : in String; Value : in Long_Float; - Precision : in Natural); + Precision : in Natural) +with Post => This.Key_Exists (Key); </pre></td> </tr> @@ -402,9 +585,10 @@ char set(const char *entry, const char *value); </pre></td> <td><pre> procedure Set - (This : in out Preferences; + (This : in out Pref_Group; Key : in String; - Value : in String); + Value : in String) +with Post => This.Key_Exists (Key); </pre></td> </tr> @@ -412,7 +596,13 @@ procedure Set <td><pre> char set(const char *entry, const void *value, int size); </pre></td> -<td>TBA</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> @@ -420,27 +610,13 @@ char set(const char *entry, const void *value, int size); int size(const char *entry); </pre></td> <td><pre> -function Entry_Size - (This : in Preferences; +function Value_Size + (This : in Pref_Group; Key : in String) return Natural; </pre></td> </tr> - <tr> -<td><pre> -static const char * newUUID(); -</pre></td> -<td>TBA</td> - </tr> - - <tr> -<td><pre> -static char remove(ID id_); -</pre></td> -<td>TBA</td> - </tr> - </table> |