The Battle for Wesnoth  1.19.5+dev
Public Types | Public Member Functions | Public Attributes | List of all members
preferences::option Struct Reference

#include <preferences.hpp>

Public Types

enum class  avd_type { TOGGLE , SLIDER , COMBO , SPECIAL }
 

Public Member Functions

 option (const config &pref)
 

Public Attributes

avd_type type
 The preference type. More...
 
t_string name
 Displayed name. More...
 
t_string description
 Displayed description. More...
 
std::string field
 The actual field saved in the prefs file and by which this preference may be accessed. More...
 
config cfg
 The full config, including type-specific options. More...
 

Detailed Description

Definition at line 141 of file preferences.hpp.

Member Enumeration Documentation

◆ avd_type

Enumerator
TOGGLE 
SLIDER 
COMBO 
SPECIAL 

Definition at line 165 of file preferences.hpp.

Constructor & Destructor Documentation

◆ option()

preferences::option::option ( const config pref)
inline

Definition at line 143 of file preferences.hpp.

References cfg, COMBO, name, SLIDER, SPECIAL, TOGGLE, and type.

Member Data Documentation

◆ cfg

config preferences::option::cfg

The full config, including type-specific options.

Definition at line 180 of file preferences.hpp.

Referenced by option().

◆ description

t_string preferences::option::description

Displayed description.

Definition at line 174 of file preferences.hpp.

◆ field

std::string preferences::option::field

The actual field saved in the prefs file and by which this preference may be accessed.

Definition at line 177 of file preferences.hpp.

◆ name

t_string preferences::option::name

Displayed name.

Definition at line 171 of file preferences.hpp.

Referenced by option().

◆ type

avd_type preferences::option::type

The preference type.

Definition at line 168 of file preferences.hpp.

Referenced by option().


The documentation for this struct was generated from the following file: