RVC::OBJITEMLIST Class Reference

List of OBJITEMs. More...

Inheritance diagram for RVC::OBJITEMLIST:

Public Member Functions
MISTRING	GetDisplayString (int MaxItemsListed, const CREDENTIALS *pCredentials=0) const
MISTRING	GetToolTipString (int MaxItemsListed, const CREDENTIALS *pCredentials=0) const
void	IniRead (INIHANDLE handle, const char group, const char field)
void	IniWrite (INIHANDLE handle, const char group, const char field, const CREDENTIALS *pCredentials=0) const
bool	IsAllSameFile () const

Detailed Description

List of OBJITEMs.

MISTRING RVC::OBJITEMLIST::GetDisplayString	(	int	MaxItemsListed,
		const CREDENTIALS *	pCredentials = `0`
	)			const

Get standard single-line "display" string for list.

Parameters:

pCredentials

Maximum number of items to list, will show ellipsis (...) if more

MISTRING RVC::OBJITEMLIST::GetToolTipString	(	int	MaxItemsListed,
		const CREDENTIALS *	pCredentials = `0`
	)			const

Get standard multi-line "tooltip" string for list.

Will use at most two lines per item.

Parameters:

pCredentials

Maximum number of items to list, will show ellipsis (...) if more

void RVC::OBJITEMLIST::IniRead	(	INIHANDLE	handle,
		const char *	group,
		const char *	field
	)

Read from .ini file.

List will be cleared prior to reading.

Parameters:

	handle	Ini Handle created by IniOpen()
	group	Group for ini entry, App Name if 0
	field	Field to read string from

void RVC::OBJITEMLIST::IniWrite	(	INIHANDLE	handle,
		const char *	group,
		const char *	field,
		const CREDENTIALS *	pCredentials = `0`
	)			const

Write to .ini file.

Parameters:

	handle	Ini Handle created by IniOpen()
	group	Group to write ini entry, App Name if 0
	field	Field to write string to

bool RVC::OBJITEMLIST::IsAllSameFile ( ) const

Determine if all items in list are in same file.

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