GRE::DATATIPPARMS Struct Reference

DataTip parameters. More...

#include <gre/datatip.h>

List of all members.

Classes
class	FORM
	Form for editing DATATIPPARMS. More...
Public Types
enum	PREDEFINED { PREDEFINED_None = 0x00, PREDEFINED_ImageCellValue = 0x01, PREDEFINED_LinkTileName = 0x02 }
Public Member Functions
	DATATIPPARMS (const DATATIPPARMS &rhs)
	DATATIPPARMS ()
ERRVALUE	CheckField (RVC::DBTABLE &ObjTable)
void	FormatString (MISTRING &ostr, const MISTRING &istr) const
DATATIPPARMS &	operator= (const DATATIPPARMS &rhs)
int	ReadString (RVC::DBTABLE &ObjTable, ELEMTYPE ElemType, INT32 ElemNum, MISTRING &string, SPATMOD::IMAGE::STAGE_ARRAY &images, RVC::DBTABLE *pSourceTable=0) const
int	ReadStringFormatted (RVC::DBTABLE &ObjTable, ELEMTYPE ElemType, INT32 ElemNum, MISTRING &string, SPATMOD::IMAGE::STAGE_ARRAY &images, RVC::DBTABLE *pSourceTable=0) const
void	SetDefaultSuffix ()
Static Public Member Functions
static const SERIALIZERITEM *	GetSerialItemDef ()
Public Attributes
UINT8	DecPlaces
RVC::OBJECTNAME	FieldName
INT32	FieldNum
UINT8	HighlightElem
UINT8	IsNumeric
UINT8	m_Predefined
UINT8	NoChgField
MISTRING	Prefix
MISTRING	Suffix
RVC::OBJECTNAME	TableName
INT32	TableNum
UINT8	UnitShown
UINT8	UnitType
UINT8	Visible

---

Detailed Description

DataTip parameters.

---

Member Enumeration Documentation

enum GRE::DATATIPPARMS::PREDEFINED

Built-in datatip values.

Enumerator:

PREDEFINED_None
PREDEFINED_ImageCellValue
PREDEFINED_LinkTileName

---

Constructor & Destructor Documentation

GRE::DATATIPPARMS::DATATIPPARMS

(

)

Default constructor.

GRE::DATATIPPARMS::DATATIPPARMS

(

const DATATIPPARMS &

rhs

)

---

Member Function Documentation

ERRVALUE GRE::DATATIPPARMS::CheckField

(

RVC::DBTABLE &

ObjTable

)

Check field name for validity in specified table.

void GRE::DATATIPPARMS::FormatString	(	MISTRING &	ostr,
		const MISTRING &	istr
	)			const

Do string formatting with prefix/suffix.

Parameters:

	ostr	String to append to
	istr	DataTip value

static const SERIALIZERITEM* GRE::DATATIPPARMS::GetSerialItemDef

(

)

[static]

Get serialization item definition array.

DATATIPPARMS& GRE::DATATIPPARMS::operator=

(

const DATATIPPARMS &

rhs

)

int GRE::DATATIPPARMS::ReadString	(	RVC::DBTABLE &	ObjTable,
		ELEMTYPE	ElemType,
		INT32	ElemNum,
		MISTRING &	string,
		SPATMOD::IMAGE::STAGE_ARRAY &	images,
		RVC::DBTABLE *	pSourceTable = 0
	)			const

Read string from table with minimal formatting.

Returns:

TRUE if have value, FALSE if not, < 0 if error.

Parameters:

	ObjTable	Table to read from
	ElemType	Element type
	ElemNum	Element number
	string	String to append result to
	images	Images to insert into the string in place of {~IMG #} tags
	pSourceTable	Source table if required

int GRE::DATATIPPARMS::ReadStringFormatted	(	RVC::DBTABLE &	ObjTable,
		ELEMTYPE	ElemType,
		INT32	ElemNum,
		MISTRING &	string,
		SPATMOD::IMAGE::STAGE_ARRAY &	images,
		RVC::DBTABLE *	pSourceTable = 0
	)			const

Read string from table and format with prefix/suffix.

Returns:

TRUE if have value, FALSE if not, < 0 if error.

Parameters:

	ObjTable	Table to read from
	ElemType	Element type
	ElemNum	Element number
	string	String to append result to
	images	Images to insert into the string in place of {~IMG #} tags
	pSourceTable	Source table if required

void GRE::DATATIPPARMS::SetDefaultSuffix

(

)

Set suffix to default based on unit type/shown.

---

Member Data Documentation

UINT8 GRE::DATATIPPARMS::DecPlaces

Decimal places for floating-point fields.

RVC::OBJECTNAME GRE::DATATIPPARMS::FieldName

Field name.

INT32 GRE::DATATIPPARMS::FieldNum [mutable]

Field number.

UINT8 GRE::DATATIPPARMS::HighlightElem

Set to highlight element in view when datatip shown.

UINT8 GRE::DATATIPPARMS::IsNumeric

Set if field is numeric.

UINT8 GRE::DATATIPPARMS::m_Predefined

Predefined value to show.

UINT8 GRE::DATATIPPARMS::NoChgField

Set if user cannot change field (eg. for RGB raster).

MISTRING GRE::DATATIPPARMS::Prefix

Label to place before value in string, defaults to table.field name.

MISTRING GRE::DATATIPPARMS::Suffix

Label to place after value in string, defaults to unit name.

RVC::OBJECTNAME GRE::DATATIPPARMS::TableName

Table name.

INT32 GRE::DATATIPPARMS::TableNum

Table number.

UINT8 GRE::DATATIPPARMS::UnitShown

Unit to show field in.

UINT8 GRE::DATATIPPARMS::UnitType

Field unit type, here for validation against DBFIELDINFO.

UINT8 GRE::DATATIPPARMS::Visible

Show this DataTip.

---

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

• gre/datatip.h