RVC::LEGEND Class Reference

Manages RVC::OBJTYPE_Legend objects. More...

#include <rvc/legend.h>

Inheritance diagram for RVC::LEGEND:

[legend]

List of all members.

Classes
class	GETOBJFILTER_ISSELECTABLE
class	LINE
class	MAKEPARMS
Public Member Functions
	LEGEND (const RVC::LEGEND &rhs)
	LEGEND ()
virtual	~LEGEND ()
ERRVALUE	Clear ()
ERRVALUE	GetMakeParms (MAKEPARMS &MakeParms) const
INT32	GetNumItems () const
ERRVALUE	Make (RVC::OBJITEM &ObjItem, const MAKEPARMS &MakeParms, const char *Source=0, const CREDENTIALS *Credentials=0)
ERRVALUE	Make (const RVC::OBJECT &parent, const DESCRIPTOR &Descriptor, const MAKEPARMS &MakeParms, const CREDENTIALS *Credentials=0)
RVC::LEGEND &	operator= (const RVC::LEGEND &rhs)
ERRVALUE	Read (INT32 LegendNum, MISTRING &string) const
ERRVALUE	Read (INT32 LegendNum, LINE &LegendLine) const
ERRVALUE	Read (MISTRING &StyleObjectPath, FILEPATH &StyleFilePath, MISTRING &DftQuery, MISTRING &ContabObjectPath) const
ERRVALUE	SetMakeParms (const MAKEPARMS &MakeParms)
ERRVALUE	Write (INT32 LegendNum, const MISTRING &string)
ERRVALUE	Write (INT32 LegendNum, const LINE &LegendLine)
ERRVALUE	Write (const MISTRING &StyleObjectPath, const FILEPATH &StyleFilePath, const MISTRING &DftQuery, const MISTRING &ContabObjectPath)

---

Detailed Description

Manages RVC::OBJTYPE_Legend objects.

Valid parents for this class:

• RVC::OBJTYPE_ColorPalette
• RVC::OBJTYPE_Style

---

Constructor & Destructor Documentation

RVC::LEGEND::LEGEND

(

)

Default constructor.

RVC::LEGEND::LEGEND

(

const RVC::LEGEND &

rhs

)

Copy constructor.

virtual RVC::LEGEND::~LEGEND

(

)

[virtual]

Destructor.

---

Member Function Documentation

ERRVALUE RVC::LEGEND::Clear

(

)

ERRVALUE RVC::LEGEND::GetMakeParms

(

MAKEPARMS &

MakeParms

)

const

INT32 RVC::LEGEND::GetNumItems

(

)

const

ERRVALUE RVC::LEGEND::Make	(	RVC::OBJITEM &	ObjItem,
		const MAKEPARMS &	MakeParms,
		const char *	Source = 0,
		const CREDENTIALS *	Credentials = 0
	)

Parameters:

	ObjItem	Parent object and DESCRIPTOR of object to create, new location RETURNED
	Credentials	User credentials passed in, NULL for default behavior

ERRVALUE RVC::LEGEND::Make	(	const RVC::OBJECT &	parent,
		const DESCRIPTOR &	Descriptor,
		const MAKEPARMS &	MakeParms,
		const CREDENTIALS *	Credentials = 0
	)

Parameters:

Credentials

User credentials passed in, NULL for default behavior

RVC::LEGEND& RVC::LEGEND::operator=

(

const RVC::LEGEND &

rhs

)

Assignment, will close and re-open object if possible.

Parameters:

rhs

Assignment operator, will close and re-open object if possible

Reimplemented from RVC::OBJECT.

ERRVALUE RVC::LEGEND::Read	(	INT32	LegendNum,
		MISTRING &	string
	)			const

ERRVALUE RVC::LEGEND::Read	(	INT32	LegendNum,
		LINE &	LegendLine
	)			const

ERRVALUE RVC::LEGEND::Read	(	MISTRING &	StyleObjectPath,
		FILEPATH &	StyleFilePath,
		MISTRING &	DftQuery,
		MISTRING &	ContabObjectPath
	)			const

ERRVALUE RVC::LEGEND::SetMakeParms

(

const MAKEPARMS &

MakeParms

)

ERRVALUE RVC::LEGEND::Write	(	INT32	LegendNum,
		const MISTRING &	string
	)

ERRVALUE RVC::LEGEND::Write	(	INT32	LegendNum,
		const LINE &	LegendLine
	)

ERRVALUE RVC::LEGEND::Write	(	const MISTRING &	StyleObjectPath,
		const FILEPATH &	StyleFilePath,
		const MISTRING &	DftQuery,
		const MISTRING &	ContabObjectPath
	)

---

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

• rvc/legend.h