FILTER_BASE Class Reference

Base class for filters generally called by dialogs. More...

#include <mi32/filtbase.h>

Inheritance diagram for FILTER_BASE:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void Clear ()
ERRVALUE GetErrValue () const
MISTRING GetMessage (TEXTID TextID=TEXTID__None) const
TEXTID GetTextID () const

Protected Member Functions

 FILTER_BASE ()
 ~FILTER_BASE ()
void SetErrValue (ERRVALUE err)
void SetTextID (TEXTID TextID)

Detailed Description

Base class for filters generally called by dialogs.

Provides management methods for derived classes to set message TextID and error values.


Constructor & Destructor Documentation

FILTER_BASE::FILTER_BASE (  )  [inline, protected]

Default constructor.

FILTER_BASE::~FILTER_BASE (  )  [inline, protected]

Destructor.


Member Function Documentation

void FILTER_BASE::Clear (  )  [inline]

Clear current TEXTID and error value settings.

ERRVALUE FILTER_BASE::GetErrValue (  )  const [inline]

Get current error value.

MISTRING FILTER_BASE::GetMessage ( TEXTID  TextID = TEXTID__None  )  const

Get message based on the stored TEXTID and error value.

If both 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 FILTER_BASE::GetTextID (  )  const [inline]

Get current TEXTID setting.

void FILTER_BASE::SetErrValue ( ERRVALUE  err  )  [inline, protected]

Set error value.

void FILTER_BASE::SetTextID ( TEXTID  TextID  )  [inline, protected]

Set the current TEXTID for this filter.


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

Generated on Sun Oct 7 21:33:23 2012 for TNTsdk 2012 by  doxygen 1.6.1