RVC::GETTABLEFIELDFILTER Class Reference

Base class for table/field selection filter. More...

Public Member Functions
	GETTABLEFIELDFILTER ()
void	Clear ()
ERRVALUE	GetErrValue () const
MISTRING	GetMessage (TEXTID TextID=TEXTID__None) const
TEXTID	GetTextID () const
virtual bool	IsFieldValid (const RVC::DBTABLE &TableObj, INT32 FieldNum, const RVC::DBTABLE::FIELDINFO &FieldInfo)
virtual bool	IsTableValid (const RVC::DBTABLE &TableObj)
void	SetErrValue (ERRVALUE err)
void	SetTextID (TEXTID TextID)

Detailed Description

Base class for table/field selection filter.

RVC::GETTABLEFIELDFILTER::GETTABLEFIELDFILTER ( )

Default constructor.

void RVC::GETTABLEFIELDFILTER::Clear ( ) [inline]

Clear current TEXTID and error value settings.

ERRVALUE RVC::GETTABLEFIELDFILTER::GetErrValue ( ) const [inline]

Get current error value.

MISTRING RVC::GETTABLEFIELDFILTER::GetMessage ( TEXTID TextID = TEXTID__None ) const

Get message based on the stored TEXTID and error value.

If both and error value and a TEXTID are set the error value will take precedence.

Parameters:

TextID

Text ID to use for message if none previously set

TEXTID RVC::GETTABLEFIELDFILTER::GetTextID ( ) const [inline]

Get current TEXTID setting.

virtual bool RVC::GETTABLEFIELDFILTER::IsFieldValid	(	const RVC::DBTABLE &	TableObj,
		INT32	FieldNum,
		const RVC::DBTABLE::FIELDINFO &	FieldInfo
	)			`[virtual]`

Determine if the field is selectable.

Returns:: 'true' if selectable, 'false' if not. Default implementation always returns 'true'.

virtual bool RVC::GETTABLEFIELDFILTER::IsTableValid ( const RVC::DBTABLE & TableObj ) [virtual]

Determine if the table is selectable.

Returns:: 'true' if selectable, 'false' if not. Default implementation always returns 'true'.

void RVC::GETTABLEFIELDFILTER::SetErrValue ( ERRVALUE err ) [inline]

Set error value.

void RVC::GETTABLEFIELDFILTER::SetTextID ( TEXTID TextID ) [inline]

Set the current TEXTID for this filter.

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