WXP::ResrcDBList Class Reference

This class stores resource database information. More...

#include "../include/ResrcDBList.h"

Public Member Functions
	ResrcDBList ()
int	add (const char *name, const char *env, const char *cmdln, const char *help)
int	add (ResrcDBItem &item)
int	rewind ()
const ResrcDBItem *	first ()
int	first (ResrcDBItem &item)
const ResrcDBItem *	next ()
int	next (ResrcDBItem &item)
const ResrcDBItem *	get (int ind)
int	get (int ind, ResrcDBItem &item)
int	getNum ()
int	print ()

Detailed Description

This class stores resource database information.

Author

Dan Vietor

Constructor & Destructor Documentation

ResrcDBList()

ResrcDBList::ResrcDBList

(

)

Constructor. Initializes the class values.

Member Function Documentation

add()

int ResrcDBList::add	(	const char *	name,
		const char *	env,
		const char *	cmdln,
		const char *	help )

Adds a new resource to the database linked list.

Parameters

name	Resource name
env	Environment variable shortcut
cmdln	Command line key shortcut
help	Resource help string

Referenced by WXP::WxpResrc::add().

first() [1/2]

const ResrcDBItem * ResrcDBList::first

(

)

Returns the first resource item in the list

Returns

A ResrcDBItem with first resource parameter

first() [2/2]

int ResrcDBList::first

(

ResrcDBItem &

item

)

Returns the first resource item in the list

Return values

item	A ResrcDBItem with first resource parameter

get() [1/2]

const ResrcDBItem * ResrcDBList::get

(

int

ind

)

Returns a specific resource item from the list

Parameters

ind	The index in the list

Returns

A ResrcDBItem with the resource parameters

Referenced by WXP::ResrcDB::create().

get() [2/2]

int ResrcDBList::get	(	int	ind,
		ResrcDBItem &	item )

Returns a specific resource item from the list

Parameters

ind	The index in the list

Return values

item	A ResrcDBItem with the resource parameters

getNum()

int WXP::ResrcDBList::getNum ( )

inline

Returns number of resources in list

Referenced by WXP::ResrcDB::create().

next() [1/2]

const ResrcDBItem * ResrcDBList::next

(

)

Returns the next resource item in the list

Returns

A ResrcDBItem with next resource parameter

Referenced by WXP::ResrcDB::create(), and WXP::ResrcDB::printHelp().

next() [2/2]

int ResrcDBList::next

(

ResrcDBItem &

item

)

Returns the next resource item in the list

Return values

item	A ResrcDBItem with next resource parameter

print()

int ResrcDBList::print

(

)

Prints the contents of the database list to standard output

References WXP::ResrcDBItem::cmdln, WXP::ResrcDBItem::env, WXP::ResrcDBItem::help, and WXP::ResrcDBItem::name.

rewind()

int ResrcDBList::rewind

(

)

Rewinds the list

Referenced by WXP::ResrcDB::create(), and WXP::ResrcDB::printHelp().

---

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

• ResrcDBList.h
• ResrcDBList.cc