SettingDefinitions.h File Reference

#include "utils/Variant.h"
#include <memory>
#include <string>
#include <utility>
#include <vector>

Classes
struct	IntegerSettingOption
struct	StringSettingOption
struct	TranslatableIntegerSettingOption

Macros
#define	SETTING_XML_ROOT   "settings"
#define	SETTING_XML_ROOT_VERSION   "version"
#define	SETTING_XML_ELM_SECTION   "section"
#define	SETTING_XML_ELM_CATEGORY   "category"
#define	SETTING_XML_ELM_GROUP   "group"
#define	SETTING_XML_ELM_SETTING   "setting"
#define	SETTING_XML_ELM_VISIBLE   "visible"
#define	SETTING_XML_ELM_REQUIREMENT   "requirement"
#define	SETTING_XML_ELM_CONDITION   "condition"
#define	SETTING_XML_ELM_ENABLED   "enable"
#define	SETTING_XML_ELM_LEVEL   "level"
#define	SETTING_XML_ELM_DEFAULT   "default"
#define	SETTING_XML_ELM_VALUE   "value"
#define	SETTING_XML_ELM_CONTROL   "control"
#define	SETTING_XML_ELM_CONSTRAINTS   "constraints"
#define	SETTING_XML_ELM_OPTIONS   "options"
#define	SETTING_XML_ELM_OPTION   "option"
#define	SETTING_XML_ELM_MINIMUM   "minimum"
#define	SETTING_XML_ELM_STEP   "step"
#define	SETTING_XML_ELM_MAXIMUM   "maximum"
#define	SETTING_XML_ELM_ALLOWEMPTY   "allowempty"
#define	SETTING_XML_ELM_ALLOWNEWOPTION   "allownewoption"
#define	SETTING_XML_ELM_DEPENDENCIES   "dependencies"
#define	SETTING_XML_ELM_DEPENDENCY   "dependency"
#define	SETTING_XML_ELM_UPDATES   "updates"
#define	SETTING_XML_ELM_UPDATE   "update"
#define	SETTING_XML_ELM_ACCESS   "access"
#define	SETTING_XML_ELM_DELIMITER   "delimiter"
#define	SETTING_XML_ELM_MINIMUM_ITEMS   "minimumitems"
#define	SETTING_XML_ELM_MAXIMUM_ITEMS   "maximumitems"
#define	SETTING_XML_ELM_DATA   "data"
#define	SETTING_XML_ATTR_ID   "id"
#define	SETTING_XML_ATTR_REFERENCE   "ref"
#define	SETTING_XML_ATTR_LABEL   "label"
#define	SETTING_XML_ATTR_HELP   "help"
#define	SETTING_XML_ATTR_TYPE   "type"
#define	SETTING_XML_ATTR_PARENT   "parent"
#define	SETTING_XML_ATTR_FORMAT   "format"
#define	SETTING_XML_ATTR_DELAYED   "delayed"
#define	SETTING_XML_ATTR_ON   "on"
#define	SETTING_XML_ATTR_OPERATOR   "operator"
#define	SETTING_XML_ATTR_NAME   "name"
#define	SETTING_XML_ATTR_SETTING   "setting"
#define	SETTING_XML_ATTR_BEFORE   "before"
#define	SETTING_XML_ATTR_AFTER   "after"

Typedefs
using	TranslatableIntegerSettingOptions = std::vector<TranslatableIntegerSettingOption>
using	IntegerSettingOptions = std::vector<IntegerSettingOption>
using	TranslatableStringSettingOption = std::pair<int, std::string>
using	TranslatableStringSettingOptions = std::vector<TranslatableStringSettingOption>
using	StringSettingOptions = std::vector<StringSettingOption>
using	IntegerSettingOptionsFiller
using	StringSettingOptionsFiller

Enumerations
enum class	SettingOptionsSort { NoSorting , Ascending , Descending }

Macro Definition Documentation

SETTING_XML_ATTR_AFTER

#define SETTING_XML_ATTR_AFTER   "after"

SETTING_XML_ATTR_BEFORE

#define SETTING_XML_ATTR_BEFORE   "before"

SETTING_XML_ATTR_DELAYED

#define SETTING_XML_ATTR_DELAYED   "delayed"

SETTING_XML_ATTR_FORMAT

#define SETTING_XML_ATTR_FORMAT   "format"

SETTING_XML_ATTR_HELP

#define SETTING_XML_ATTR_HELP   "help"

SETTING_XML_ATTR_ID

#define SETTING_XML_ATTR_ID   "id"

SETTING_XML_ATTR_LABEL

#define SETTING_XML_ATTR_LABEL   "label"

SETTING_XML_ATTR_NAME

#define SETTING_XML_ATTR_NAME   "name"

SETTING_XML_ATTR_ON

#define SETTING_XML_ATTR_ON   "on"

SETTING_XML_ATTR_OPERATOR

#define SETTING_XML_ATTR_OPERATOR   "operator"

SETTING_XML_ATTR_PARENT

#define SETTING_XML_ATTR_PARENT   "parent"

SETTING_XML_ATTR_REFERENCE

#define SETTING_XML_ATTR_REFERENCE   "ref"

SETTING_XML_ATTR_SETTING

#define SETTING_XML_ATTR_SETTING   "setting"

SETTING_XML_ATTR_TYPE

#define SETTING_XML_ATTR_TYPE   "type"

SETTING_XML_ELM_ACCESS

#define SETTING_XML_ELM_ACCESS   "access"

SETTING_XML_ELM_ALLOWEMPTY

#define SETTING_XML_ELM_ALLOWEMPTY   "allowempty"

SETTING_XML_ELM_ALLOWNEWOPTION

#define SETTING_XML_ELM_ALLOWNEWOPTION   "allownewoption"

SETTING_XML_ELM_CATEGORY

#define SETTING_XML_ELM_CATEGORY   "category"

SETTING_XML_ELM_CONDITION

#define SETTING_XML_ELM_CONDITION   "condition"

SETTING_XML_ELM_CONSTRAINTS

#define SETTING_XML_ELM_CONSTRAINTS   "constraints"

SETTING_XML_ELM_CONTROL

#define SETTING_XML_ELM_CONTROL   "control"

SETTING_XML_ELM_DATA

#define SETTING_XML_ELM_DATA   "data"

SETTING_XML_ELM_DEFAULT

#define SETTING_XML_ELM_DEFAULT   "default"

SETTING_XML_ELM_DELIMITER

#define SETTING_XML_ELM_DELIMITER   "delimiter"

SETTING_XML_ELM_DEPENDENCIES

#define SETTING_XML_ELM_DEPENDENCIES   "dependencies"

SETTING_XML_ELM_DEPENDENCY

#define SETTING_XML_ELM_DEPENDENCY   "dependency"

SETTING_XML_ELM_ENABLED

#define SETTING_XML_ELM_ENABLED   "enable"

SETTING_XML_ELM_GROUP

#define SETTING_XML_ELM_GROUP   "group"

SETTING_XML_ELM_LEVEL

#define SETTING_XML_ELM_LEVEL   "level"

SETTING_XML_ELM_MAXIMUM

#define SETTING_XML_ELM_MAXIMUM   "maximum"

SETTING_XML_ELM_MAXIMUM_ITEMS

#define SETTING_XML_ELM_MAXIMUM_ITEMS   "maximumitems"

SETTING_XML_ELM_MINIMUM

#define SETTING_XML_ELM_MINIMUM   "minimum"

SETTING_XML_ELM_MINIMUM_ITEMS

#define SETTING_XML_ELM_MINIMUM_ITEMS   "minimumitems"

SETTING_XML_ELM_OPTION

#define SETTING_XML_ELM_OPTION   "option"

SETTING_XML_ELM_OPTIONS

#define SETTING_XML_ELM_OPTIONS   "options"

SETTING_XML_ELM_REQUIREMENT

#define SETTING_XML_ELM_REQUIREMENT   "requirement"

SETTING_XML_ELM_SECTION

#define SETTING_XML_ELM_SECTION   "section"

SETTING_XML_ELM_SETTING

#define SETTING_XML_ELM_SETTING   "setting"

SETTING_XML_ELM_STEP

#define SETTING_XML_ELM_STEP   "step"

SETTING_XML_ELM_UPDATE

#define SETTING_XML_ELM_UPDATE   "update"

SETTING_XML_ELM_UPDATES

#define SETTING_XML_ELM_UPDATES   "updates"

SETTING_XML_ELM_VALUE

#define SETTING_XML_ELM_VALUE   "value"

SETTING_XML_ELM_VISIBLE

#define SETTING_XML_ELM_VISIBLE   "visible"

SETTING_XML_ROOT

#define SETTING_XML_ROOT   "settings"

SETTING_XML_ROOT_VERSION

#define SETTING_XML_ROOT_VERSION   "version"

Typedef Documentation

IntegerSettingOptions

using IntegerSettingOptions = std::vector<IntegerSettingOption>

IntegerSettingOptionsFiller

using IntegerSettingOptionsFiller

Initial value:

 void (*)(const std::shared_ptr<const CSetting>& setting,
                                             IntegerSettingOptions& list,
                                             int& current,
                                             void* data)

StringSettingOptions

using StringSettingOptions = std::vector<StringSettingOption>

StringSettingOptionsFiller

using StringSettingOptionsFiller

Initial value:

 void (*)(const std::shared_ptr<const CSetting>& setting,
                                            StringSettingOptions& list,
                                            std::string& current,
                                            void* data)

TranslatableIntegerSettingOptions

using TranslatableIntegerSettingOptions = std::vector<TranslatableIntegerSettingOption>

TranslatableStringSettingOption

using TranslatableStringSettingOption = std::pair<int, std::string>

TranslatableStringSettingOptions

using TranslatableStringSettingOptions = std::vector<TranslatableStringSettingOption>

Enumeration Type Documentation

SettingOptionsSort

enum class SettingOptionsSort

strong

Enumerator
NoSorting
Ascending
Descending