IniItem Struct Reference

A single "line" in an ini file. More...

#include <ini_type.h>

Public Member Functions
	IniItem (std::string_view name)
	Construct a new in-memory item of an Ini file.
void	SetValue (std::string_view value)
	Replace the current value with another value.

Data Fields
std::string	name
	The name of this item.
std::optional< std::string >	value
	The value of this item.
std::string	comment
	The comment associated with this item.

Detailed Description

A single "line" in an ini file.

Definition at line 23 of file ini_type.h.

Constructor & Destructor Documentation

IniItem()

IniItem::IniItem

(

std::string_view

name

)

Construct a new in-memory item of an Ini file.

Parameters

name	the name of the item

Definition at line 21 of file ini_load.cpp.

References name, and StrMakeValid().

Member Function Documentation

SetValue()

void IniItem::SetValue

(

std::string_view

value

)

Replace the current value with another value.

Parameters

value

the value to replace with.

Definition at line 30 of file ini_load.cpp.

References value.

Referenced by BadgeClassSaveConfigFeature(), GraphicsSetSaveConfig(), IniSaveSettingList(), HotkeyList::Save(), and SaveVersionInConfig().

Field Documentation

comment

std::string IniItem::comment

The comment associated with this item.

Definition at line 26 of file ini_type.h.

Referenced by IniLoadFile::LoadFromDisk(), and IniFile::SaveToDisk().

name

std::string IniItem::name

The name of this item.

Definition at line 24 of file ini_type.h.

Referenced by BadgeClassLoadConfigFeature(), DumpGroup(), BaseSet< T >::FillSetDetails(), GRFLoadConfig(), IniItem(), IniLoadSettingList(), PickerLoadConfig(), IniGroup::RemoveItem(), and IniFile::SaveToDisk().

value

std::optional<std::string> IniItem::value

The value of this item.

Definition at line 25 of file ini_type.h.

Referenced by BadgeClassLoadConfigFeature(), DumpLine(), DumpSections(), BaseSet< T >::FillSetDetails(), BaseSet< GraphicsSet >::FillSetDetails(), FindItemValue(), GraphicsSetLoadConfig(), GRFLoadConfig(), IniSaveSettings(), IntSettingDesc::IsSameValue(), StringSettingDesc::IsSameValue(), HotkeyList::Load(), LoadFromConfig(), IniLoadFile::LoadFromDisk(), IntSettingDesc::ParseValue(), ListSettingDesc::ParseValue(), StringSettingDesc::ParseValue(), IniFile::SaveToDisk(), and SetValue().

---

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

• src/ini_type.h
• src/ini_load.cpp