IniGroup Struct Reference

A group within an ini file. More...

#include <ini_type.h>

Public Member Functions

 IniGroup (struct IniLoadFile *parent, const char *name, size_t len=0)
 Construct a new in-memory group of an Ini file.
 ~IniGroup ()
 Free everything we loaded.
IniItemGetItem (const char *name, bool create)
 Get the item with the given name, and if it doesn't exist and create is true it creates a new item.
void Clear ()
 Clear all items in the group.

Data Fields

IniGroupnext
 the next group within this file
IniGroupType type
 type of group
IniItemitem
 the first item in the group
IniItem ** last_item
 the last item in the group
char * name
 name of group
char * comment
 comment for group

Detailed Description

A group within an ini file.

Definition at line 36 of file ini_type.h.


Constructor & Destructor Documentation

IniGroup::IniGroup ( struct IniLoadFile parent,
const char *  name,
size_t  len = 0 
)

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

Parameters:
parent the file we belong to
name the name of the group
len the length of the name of the group

Definition at line 59 of file ini_load.cpp.

References IGT_LIST, IGT_SEQUENCE, item, IniLoadFile::last_group, last_item, IniLoadFile::list_group_names, next, IniLoadFile::seq_group_names, and type.

IniGroup::~IniGroup (  ) 

Free everything we loaded.

Definition at line 87 of file ini_load.cpp.

References comment, item, name, and next.


Member Function Documentation

IniItem * IniGroup::GetItem ( const char *  name,
bool  create 
)

Get the item with the given name, and if it doesn't exist and create is true it creates a new item.

Parameters:
name name of the item to find.
create whether to create an item when not found or not.
Returns:
the requested item or NULL if not found.

Definition at line 103 of file ini_load.cpp.

References item, IniItem::name, and IniItem::next.

Referenced by DumpSections(), BaseSet< T, Tnum_files, Tsubdir >::FillSetDetails(), FindItemValue(), IniLoadSettings(), IniSaveSettingList(), NewsDisplaySaveConfig(), and SaveVersionInConfig().


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

Generated on Sun May 8 07:31:13 2011 for OpenTTD by  doxygen 1.6.1