MiKTeX::Configuration::ConfigValue Class Reference

MiKTeX configuration value. More...

#include <miktex/Configuration/ConfigValue.h>

Public Types
enum class	Type {   None , String , Int , Bool ,   Tri , Char , StringArray }
	Value type. More...

Public Member Functions
	ConfigValue (const ConfigValue &other)
ConfigValue &	operator= (const ConfigValue &other)=delete
	ConfigValue (ConfigValue &&other) noexcept
ConfigValue &	operator= (ConfigValue &&other) noexcept
	ConfigValue (const std::string &s)
	ConfigValue (const char *lpsz)
	ConfigValue (int i)
	ConfigValue (bool b)
	ConfigValue (TriState t)
	ConfigValue (char c)
	ConfigValue (const std::vector< std::string > &sa)
std::string	GetString () const
int	GetInt () const
bool	GetBool () const
TriState	GetTriState () const
char	GetChar () const
std::time_t	GetTimeT () const
std::vector< std::string >	GetStringArray () const
Type	GetType () const
bool	HasValue () const
std::string	GetSection () const
std::string	GetDescription () const

Public Attributes
Type	type = Type::None
bool	b
char	c
int	i
std::string	s
std::vector< std::string >	sa
TriState	t

Detailed Description

MiKTeX configuration value.

Member Enumeration Documentation

Type

enum class MiKTeX::Configuration::ConfigValue::Type

strong

Value type.

Member Function Documentation

GetBool()

bool MiKTeX::Configuration::ConfigValue::GetBool ( ) const

inline

Gets the configuration value as a boolean.

Returns

Returns the configuration value.

GetChar()

char MiKTeX::Configuration::ConfigValue::GetChar ( ) const

inline

Gets the configuration value as a character.

Returns

Returns the configuration value.

GetDescription()

std::string MiKTeX::Configuration::ConfigValue::GetDescription ( ) const

inline

Gets the description of the configuration value.

Returns

Returns the description.

GetInt()

int MiKTeX::Configuration::ConfigValue::GetInt ( ) const

inline

Gets the configuration value as an integer.

Returns

Returns the configuration value.

GetSection()

std::string MiKTeX::Configuration::ConfigValue::GetSection ( ) const

inline

Gets the section of the configuration value.

Returns

Returns the section name.

GetString()

std::string MiKTeX::Configuration::ConfigValue::GetString ( ) const

inline

Gets the configuration value as a string.

Returns

Returns the configuration value.

GetStringArray()

std::vector< std::string > MiKTeX::Configuration::ConfigValue::GetStringArray ( ) const

inline

Gets the configuration value as a string list.

Returns

Returns the configuration value.

GetTimeT()

std::time_t MiKTeX::Configuration::ConfigValue::GetTimeT ( ) const

inline

Gets the configuration value as a time_t.

Returns

Returns the configuration value.

GetTriState()

TriState MiKTeX::Configuration::ConfigValue::GetTriState ( ) const

inline

Gets the configuration value as a tri-state.

Returns

Returns the configuration value.

GetType()

ConfigValue::Type MiKTeX::Configuration::ConfigValue::GetType ( ) const

inline

Gets the value type.

Returns

Returns the value type

HasValue()

bool MiKTeX::Configuration::ConfigValue::HasValue ( ) const

inline

Tests whether the configuration value is defined.

Returns

Returns true, if the configuration value is defined.

---

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

• Libraries/MiKTeX/Configuration/include/miktex/Configuration/ConfigValue.h