This documenta- tion describes the current state of development.
Note that interfaces and functionality may still change.

Prokee Modules:

open all | close all

GUI Elements:

open all | close all

GUI Interactions:

open all | close all

GUI Layouts:

open all | close all

Games/Demos:

open all | close all

Third Party Libraries:

open all | close all

Information about this Website / Informationen zu dieser Webseite:

In case of any questions, or comments, please feel free to contact me via email at apoll500@gmail.com.

Module settings

[Main Page] [Tests]

Requirements
Interfaces
Exported Symbols
Internal Pointers

Requirements

For the Prokee Module Library

Dynamically Linked Modules:

module file (version 1 - 0)
module strconv (version 1 - 0)

For the Standalone Executable

module file (version 1 - 0)
module strconv (version 1 - 0)
module dir (version 1 - 0)
module path (version 1 - 0)
module label (version 1 - 0)
module strman (version 1 - 0)

module str (version 1 - 0)
module conststr (version 1 - 0)
module osio (version 1 - 0)
module osfile (version 1 - 0)
module osdir (version 1 - 0)

Interfaces

Exported Symbols

Constructors

void *createSettings();
    

    void *createMultiSettings();

Destructors

void destroysettings(void *object);
    

    void destroyMultiSettings(void *object);

Methods

bool Settings_loadfile1(const char *filename,void *object);
    

    bool Settings_loadfile2(const char *filename,bool docreate,void *object);
    

    int Settings_getDefBlockCount(void *object);
    

    std::string Settings_getNextDefBlockName(void *object);
    

    void Settings_updateDefBlockNames(void *object);
    

    void Settings_insert(std::string defName,std::string name,std::string value,void *object);
    

    void Settings_set1(std::string defName,std::string name,std::string value,void *object);
    

    void Settings_set2(std::string defName,std::string name,int i,std::string value,void *object);
    

    std::string Settings_get1(std::string defName,std::string name,void *object);
    

    std::string Settings_get2(std::string defName,std::string name,int i,void *object);
    

    bool Settings_exists1(std::string defName,std::string name,void *object);
    

    bool Settings_exists2(std::string defName,std::string name,int i,void *object);
    

    int Settings_getNameCount1(std::string defName,void *object);
    

    int Settings_getNameCount2(std::string defName,std::string name,void *object);
    

    std::string Settings_getNextName1(std::string defName,void *object);
    

    std::string Settings_getNextName2(std::string defName,std::string name,void *object);
    

    std::string Settings_getNextValue(std::string defName,std::string name,void *object);
    

    void Settings_save(const char *filename,void *object);
    

    bool Settings_save2(const char *filename,void *object);
    

    bool MultiSettings_loadfile1(const char *filename,void *object);
    

    bool MultiSettings_loadfile2(const char *filename,bool docreate,void *object);
    

    void MultiSettings_setSelectedDefBlockName(const char *defBlockName,void *object);
    

    std::string MultiSettings_getSelectedDefBlockName(void *object);
    

    void MultiSettings_insert(std::string name,std::string value,void *object);
    

    void MultiSettings_set1(std::string name,std::string value,void *object);
    

    void MultiSettings_set2(std::string name,int i,std::string value,void *object);
    

    std::string MultiSettings_get1(std::string name,void *object);
    

    std::string MultiSettings_get2(std::string name,int i,void *object);
    

    bool MultiSettings_exists1(std::string name,void *object);
    

    bool MultiSettings_exists2(std::string name,int i,void *object);
    

    int MultiSettings_getNameCount1(void *object);
    

    int MultiSettings_getNameCount2(std::string name,void *object);
    

    std::string MultiSettings_getNextName1(void *object);
    

    std::string MultiSettings_getNextName2(std::string name,void *object);
    

    std::string MultiSettings_getNextValue2(std::string name,void *object);

Internal Pointers

Constructors

The functions listed below are the "constructor functions" for creating objects of the linked module.
These functions can be used directly to omit the static wrapper methods.

void *settings_Settings_createSettings();
    

    void *settings_MultiSettings_createMultiSettings();

The names of the functions are constructed according to the following pattern:

 <module>_<namespace>_<class>_create<class>(...)

where:
   <module> is the name of the module.
   <namespace> is the name of the namespace (optional).
   <class> is the name of the class.

Destructors

There are also destructor functions. These are equivalent to calling delete object;.
Do not call this functions directly.

void settings_Settings_destroysettings(void *object);
    

    void settings_MultiSettings_destroyMultiSettings(void *object);

The names of the functions are constructed according to the following pattern:

 <<module>_<namespace>_<class>_destroy<class>(void *object)

where:
   <module> is the name of the module.
   <namespace> is the name of the namespace (optional).
   <class> is the name of the class.
   object is the object to be destroyed.

Methods

These functions are used, if you created the object locally.
Do not call this functions directly.

bool settings_Settings_loadfile1(const char *filename,void *object);
    

    bool settings_Settings_loadfile2(const char *filename,bool docreate,void *object);
    

    int settings_Settings_getDefBlockCount(void *object);
    

    std::string settings_Settings_getNextDefBlockName(void *object);
    

    void settings_Settings_updateDefBlockNames(void *object);
    

    void settings_Settings_insert(std::string defName,std::string name,std::string value,void *object);
    

    void settings_Settings_set1(std::string defName,std::string name,std::string value,void *object);
    

    void settings_Settings_set2(std::string defName,std::string name,int i,std::string value,void *object);
    

    std::string settings_Settings_get1(std::string defName,std::string name,void *object);
    

    std::string settings_Settings_get2(std::string defName,std::string name,int i,void *object);
    

    bool settings_Settings_exists1(std::string defName,std::string name,void *object);
    

    bool settings_Settings_exists2(std::string defName,std::string name,int i,void *object);
    

    int settings_Settings_getNameCount1(std::string defName,void *object);
    

    int settings_Settings_getNameCount2(std::string defName,std::string name,void *object);
    

    std::string settings_Settings_getNextName1(std::string defName,void *object);
    

    std::string settings_Settings_getNextName2(std::string defName,std::string name,void *object);
    

    std::string settings_Settings_getNextValue(std::string defName,std::string name,void *object);
    

    void settings_Settings_save(const char *filename,void *object);
    

    bool settings_Settings_save2(const char *filename,void *object);
    

    bool settings_MultiSettings_loadfile1(const char *filename,void *object);
    

    bool settings_MultiSettings_loadfile2(const char *filename,bool docreate,void *object);
    

    void settings_MultiSettings_setSelectedDefBlockName(const char *defBlockName,void *object);
    

    std::string settings_MultiSettings_getSelectedDefBlockName(void *object);
    

    void settings_MultiSettings_insert(std::string name,std::string value,void *object);
    

    void settings_MultiSettings_set1(std::string name,std::string value,void *object);
    

    void settings_MultiSettings_set2(std::string name,int i,std::string value,void *object);
    

    std::string settings_MultiSettings_get1(std::string name,void *object);
    

    std::string settings_MultiSettings_get2(std::string name,int i,void *object);
    

    bool settings_MultiSettings_exists1(std::string name,void *object);
    

    bool settings_MultiSettings_exists2(std::string name,int i,void *object);
    

    int settings_MultiSettings_getNameCount1(void *object);
    

    int settings_MultiSettings_getNameCount2(std::string name,void *object);
    

    std::string settings_MultiSettings_getNextName1(void *object);
    

    std::string settings_MultiSettings_getNextName2(std::string name,void *object);
    

    std::string settings_MultiSettings_getNextValue2(std::string name,void *object);

The names of the functions are constructed according to the following pattern:

 <module>_<namespace>_<class>_<method>(...,void *object)

where:
   <module> is the name of the module.
   <namespace> is the name of the namespace (optional).
   <class> is the name of the class.
   <method> is the name of the method.
   object is the object of which the method is called.

Module settings

Contents

Requirements

Interfaces

Exported Symbols

Constructors

Destructors

Methods

Internal Pointers

Constructors

Destructors

Methods