Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
SettingDefinitions.h File Reference
#include "utils/Variant.h"
#include <functional>
#include <memory>
#include <string>
#include <utility>
#include <vector>

Classes

struct  IntegerSettingOption
 
struct  StringSettingOption
 
struct  TranslatableIntegerSettingOption
 

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 }
 

Variables

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

Typedef Documentation

◆ IntegerSettingOptions

◆ IntegerSettingOptionsFiller

Initial value:
std::function<void(
const std::shared_ptr<const CSetting>& setting, IntegerSettingOptions& list, int& current)>
std::vector< IntegerSettingOption > IntegerSettingOptions
Definition SettingDefinitions.h:119
typedef void(ATTR_APIENTRYP PFN_KODI_ADDON_SCREENSAVER_STOP_V1)(const KODI_ADDON_SCREENSAVER_HDL hdl)

◆ StringSettingOptions

◆ StringSettingOptionsFiller

Initial value:
std::function<void(const std::shared_ptr<const CSetting>& setting,
std::string& current)>
std::vector< StringSettingOption > StringSettingOptions
Definition SettingDefinitions.h:122

◆ TranslatableIntegerSettingOptions

◆ TranslatableStringSettingOption

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

◆ TranslatableStringSettingOptions

Enumeration Type Documentation

◆ SettingOptionsSort

enum class SettingOptionsSort
strong
Enumerator
NoSorting 
Ascending 
Descending 

Variable Documentation

◆ SETTING_XML_ATTR_AFTER

const char* SETTING_XML_ATTR_AFTER = "after"
constexpr

◆ SETTING_XML_ATTR_BEFORE

const char* SETTING_XML_ATTR_BEFORE = "before"
constexpr

◆ SETTING_XML_ATTR_DELAYED

const char* SETTING_XML_ATTR_DELAYED = "delayed"
constexpr

◆ SETTING_XML_ATTR_FORMAT

const char* SETTING_XML_ATTR_FORMAT = "format"
constexpr

◆ SETTING_XML_ATTR_HELP

const char* SETTING_XML_ATTR_HELP = "help"
constexpr

◆ SETTING_XML_ATTR_ID

const char* SETTING_XML_ATTR_ID = "id"
constexpr

◆ SETTING_XML_ATTR_LABEL

const char* SETTING_XML_ATTR_LABEL = "label"
constexpr

◆ SETTING_XML_ATTR_NAME

const char* SETTING_XML_ATTR_NAME = "name"
constexpr

◆ SETTING_XML_ATTR_ON

const char* SETTING_XML_ATTR_ON = "on"
constexpr

◆ SETTING_XML_ATTR_OPERATOR

const char* SETTING_XML_ATTR_OPERATOR = "operator"
constexpr

◆ SETTING_XML_ATTR_PARENT

const char* SETTING_XML_ATTR_PARENT = "parent"
constexpr

◆ SETTING_XML_ATTR_REFERENCE

const char* SETTING_XML_ATTR_REFERENCE = "ref"
constexpr

◆ SETTING_XML_ATTR_SETTING

const char* SETTING_XML_ATTR_SETTING = "setting"
constexpr

◆ SETTING_XML_ATTR_TYPE

const char* SETTING_XML_ATTR_TYPE = "type"
constexpr

◆ SETTING_XML_ELM_ACCESS

const char* SETTING_XML_ELM_ACCESS = "access"
constexpr

◆ SETTING_XML_ELM_ALLOWEMPTY

const char* SETTING_XML_ELM_ALLOWEMPTY = "allowempty"
constexpr

◆ SETTING_XML_ELM_ALLOWNEWOPTION

const char* SETTING_XML_ELM_ALLOWNEWOPTION = "allownewoption"
constexpr

◆ SETTING_XML_ELM_CATEGORY

const char* SETTING_XML_ELM_CATEGORY = "category"
constexpr

◆ SETTING_XML_ELM_CONDITION

const char* SETTING_XML_ELM_CONDITION = "condition"
constexpr

◆ SETTING_XML_ELM_CONSTRAINTS

const char* SETTING_XML_ELM_CONSTRAINTS = "constraints"
constexpr

◆ SETTING_XML_ELM_CONTROL

const char* SETTING_XML_ELM_CONTROL = "control"
constexpr

◆ SETTING_XML_ELM_DATA

const char* SETTING_XML_ELM_DATA = "data"
constexpr

◆ SETTING_XML_ELM_DEFAULT

const char* SETTING_XML_ELM_DEFAULT = "default"
constexpr

◆ SETTING_XML_ELM_DELIMITER

const char* SETTING_XML_ELM_DELIMITER = "delimiter"
constexpr

◆ SETTING_XML_ELM_DEPENDENCIES

const char* SETTING_XML_ELM_DEPENDENCIES = "dependencies"
constexpr

◆ SETTING_XML_ELM_DEPENDENCY

const char* SETTING_XML_ELM_DEPENDENCY = "dependency"
constexpr

◆ SETTING_XML_ELM_ENABLED

const char* SETTING_XML_ELM_ENABLED = "enable"
constexpr

◆ SETTING_XML_ELM_GROUP

const char* SETTING_XML_ELM_GROUP = "group"
constexpr

◆ SETTING_XML_ELM_LEVEL

const char* SETTING_XML_ELM_LEVEL = "level"
constexpr

◆ SETTING_XML_ELM_MAXIMUM

const char* SETTING_XML_ELM_MAXIMUM = "maximum"
constexpr

◆ SETTING_XML_ELM_MAXIMUM_ITEMS

const char* SETTING_XML_ELM_MAXIMUM_ITEMS = "maximumitems"
constexpr

◆ SETTING_XML_ELM_MINIMUM

const char* SETTING_XML_ELM_MINIMUM = "minimum"
constexpr

◆ SETTING_XML_ELM_MINIMUM_ITEMS

const char* SETTING_XML_ELM_MINIMUM_ITEMS = "minimumitems"
constexpr

◆ SETTING_XML_ELM_OPTION

const char* SETTING_XML_ELM_OPTION = "option"
constexpr

◆ SETTING_XML_ELM_OPTIONS

const char* SETTING_XML_ELM_OPTIONS = "options"
constexpr

◆ SETTING_XML_ELM_REQUIREMENT

const char* SETTING_XML_ELM_REQUIREMENT = "requirement"
constexpr

◆ SETTING_XML_ELM_SECTION

const char* SETTING_XML_ELM_SECTION = "section"
constexpr

◆ SETTING_XML_ELM_SETTING

const char* SETTING_XML_ELM_SETTING = "setting"
constexpr

◆ SETTING_XML_ELM_STEP

const char* SETTING_XML_ELM_STEP = "step"
constexpr

◆ SETTING_XML_ELM_UPDATE

const char* SETTING_XML_ELM_UPDATE = "update"
constexpr

◆ SETTING_XML_ELM_UPDATES

const char* SETTING_XML_ELM_UPDATES = "updates"
constexpr

◆ SETTING_XML_ELM_VALUE

const char* SETTING_XML_ELM_VALUE = "value"
constexpr

◆ SETTING_XML_ELM_VISIBLE

const char* SETTING_XML_ELM_VISIBLE = "visible"
constexpr

◆ SETTING_XML_ROOT

const char* SETTING_XML_ROOT = "settings"
constexpr

◆ SETTING_XML_ROOT_VERSION

const char* SETTING_XML_ROOT_VERSION = "version"
constexpr