RVC::UI::DLG_DB_FIELD_REVALUE Class Reference

Base dialog to allow user to revalue fields. More...

#include <rvc/uidlgdbfieldrevalue.h>

Inheritance diagram for RVC::UI::DLG_DB_FIELD_REVALUE:

[legend]

List of all members.

Public Types
enum	DLGSTYLE { DLGSTYLE_Default = 0, DLGSTYLE_AllowRedrawOnApply = 0x01 }
Public Member Functions
	DLG_DB_FIELD_REVALUE (const MISTRING &title, DLGSTYLE dlgstyle=DLGSTYLE_Default)
virtual	~DLG_DB_FIELD_REVALUE ()
bool	ApplyToRecord (RVC::DBTABLE::RECORD &record) const
int	ApplyToRecordNum (INT32 RecordNum)
bool	CanApply () const
INT32	GetFieldNumFor () const
bool	GetRedrawOnApply () const
MGUI::CTRL_STATUSBAR &	GetStatusBar ()
const RVC::DBTABLE &	GetTableFor () const
void	SaveSettings ()
ERRVALUE	Setup (const RVC::DBTABLE &ObjTable, INT32 FieldNum, INT32 RelFieldDisplay=-1, INT32 RelFieldSortBy=-1)
Protected Member Functions
virtual void	v_OnClose ()

---

Detailed Description

Base dialog to allow user to revalue fields.

Controls are provided to let user pick existing values along with a new value. Override the v_OnApply to handle the Apply/OK buttons.

---

Member Enumeration Documentation

enum RVC::UI::DLG_DB_FIELD_REVALUE::DLGSTYLE

Enumerator:

DLGSTYLE_Default
DLGSTYLE_AllowRedrawOnApply	Include toggle for "Redraw after apply changes".

---

Constructor & Destructor Documentation

RVC::UI::DLG_DB_FIELD_REVALUE::DLG_DB_FIELD_REVALUE	(	const MISTRING &	title,
		DLGSTYLE	dlgstyle = DLGSTYLE_Default
	)			[explicit]

Constructor.

virtual RVC::UI::DLG_DB_FIELD_REVALUE::~DLG_DB_FIELD_REVALUE

(

)

[virtual]

Destructor.

---

Member Function Documentation

bool RVC::UI::DLG_DB_FIELD_REVALUE::ApplyToRecord

(

RVC::DBTABLE::RECORD &

record

)

const

Apply change to record if matches user selection.

Returns:

true if changed, false if not.

Parameters:

record

Record to place value into

int RVC::UI::DLG_DB_FIELD_REVALUE::ApplyToRecordNum

(

INT32

RecordNum

)

Apply change to specified record number if matches user selection.

Returns:

TRUE if changed, FALSE if not, < 0 if error.

bool RVC::UI::DLG_DB_FIELD_REVALUE::CanApply

(

)

const [inline]

Determine if can apply reclassification.

INT32 RVC::UI::DLG_DB_FIELD_REVALUE::GetFieldNumFor

(

)

const [inline]

Get field number being revalued.

bool RVC::UI::DLG_DB_FIELD_REVALUE::GetRedrawOnApply

(

)

const [inline]

Get whether to redraw after apply.

MGUI::CTRL_STATUSBAR& RVC::UI::DLG_DB_FIELD_REVALUE::GetStatusBar

(

)

[inline]

Get statusbar control.

const RVC::DBTABLE& RVC::UI::DLG_DB_FIELD_REVALUE::GetTableFor

(

)

const [inline]

Get table revaluing field for.

void RVC::UI::DLG_DB_FIELD_REVALUE::SaveSettings

(

)

Save current settings if changed.

ERRVALUE RVC::UI::DLG_DB_FIELD_REVALUE::Setup	(	const RVC::DBTABLE &	ObjTable,
		INT32	FieldNum,
		INT32	RelFieldDisplay = -1,
		INT32	RelFieldSortBy = -1
	)

Setup with table and field to revalue.

Field must related to a primary key from which values are selected. Must be done only once and before dialog is created.

Parameters:

	ObjTable	Table revalue field for
	FieldNum	Field to revalue
	RelFieldDisplay	Field number in related picklist table to display values from
	RelFieldSortBy	Field number in related picklist table to sort by

virtual void RVC::UI::DLG_DB_FIELD_REVALUE::v_OnClose

(

)

[protected, virtual]

Called when dialog closed - derived class should call base method to save settings.

Reimplemented from MGUI::DLGSHELL.

---

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

• rvc/uidlgdbfieldrevalue.h