RVC::UI::FORM_DB_RECORD Class Reference

Form for viewing and editing single database record. More...

#include <rvc/uiformdbrecord.h>

Inheritance diagram for RVC::UI::FORM_DB_RECORD:

[legend]

List of all members.

Classes
class	SETTINGS
Public Types
enum	FORMSTYLE { FORMSTYLE_Grid, FORMSTYLE_UserDefined }
Public Member Functions
	FORM_DB_RECORD (DBEDIT_TINSTANCE *idata, FORMSTYLE formstyle)
virtual	~FORM_DB_RECORD ()
void	ClearChangedSettings ()
ERRVALUE	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, const SETTINGS *pSettings=0)
void	DlgEditUserDefined ()
void	GetRecordRef (DBTABLE::RECORDREFTYPE &RefType, INT32 &RefNum) const
INT32	GetRecordRefNum () const
DBTABLE::RECORDREFTYPE	GetRecordRefType () const
void	GetSettings (SETTINGS &settings) const
ERRVALUE	GetValues (RVC::DBTABLE::RECORD &record)
bool	HasChangedSettings () const
bool	IsRecordChanged () const
void	NotifyDlgClose ()
void	NotifyDlgOpen ()
ERRVALUE	Reread ()
INT32	SaveRecord (bool AskUser=true)
void	SetDelegateOnChangedFieldValue (DELEGATE_VOID_INT32 delegate)
ERRVALUE	SetRecordRef (DBTABLE::RECORDREFTYPE RefType, INT32 RefNum)
ERRVALUE	SetValues (const RVC::DBTABLE::RECORD &record, bool IsChanged)
void	UndoAll ()
bool	UndoLast ()
Static Public Member Functions
static void	SML_Install (SML::CONTEXT *context)

---

Detailed Description

Form for viewing and editing single database record.

---

Member Enumeration Documentation

enum RVC::UI::FORM_DB_RECORD::FORMSTYLE

Form style.

Enumerator:

FORMSTYLE_Grid
FORMSTYLE_UserDefined

---

Constructor & Destructor Documentation

RVC::UI::FORM_DB_RECORD::FORM_DB_RECORD	(	DBEDIT_TINSTANCE *	idata,
		FORMSTYLE	formstyle
	)

Constructor.

virtual RVC::UI::FORM_DB_RECORD::~FORM_DB_RECORD

(

)

[virtual]

Destructor.

---

Member Function Documentation

void RVC::UI::FORM_DB_RECORD::ClearChangedSettings

(

)

Clear layout settings "changed" status.

ERRVALUE RVC::UI::FORM_DB_RECORD::Create	(	MGUI::LAYOUT_PANE_BASE &	ParentPane,
		const SETTINGS *	pSettings = 0
	)

Create form.

Parameters:

pSettings

Optional layout settings

void RVC::UI::FORM_DB_RECORD::DlgEditUserDefined

(

)

Open dialog to edit user-defined form (MODE_UserDefined only).

void RVC::UI::FORM_DB_RECORD::GetRecordRef	(	DBTABLE::RECORDREFTYPE &	RefType,
		INT32 &	RefNum
	)			const

Get current record reference type and number.

Parameters:

	RefType	Reference type returned
	RefNum	Position number returned

INT32 RVC::UI::FORM_DB_RECORD::GetRecordRefNum

(

)

const

Get current record reference number.

DBTABLE::RECORDREFTYPE RVC::UI::FORM_DB_RECORD::GetRecordRefType

(

)

const

Get record reference type.

void RVC::UI::FORM_DB_RECORD::GetSettings

(

SETTINGS &

settings

)

const

Get layout settings.

Parameters:

settings

Settings returned

ERRVALUE RVC::UI::FORM_DB_RECORD::GetValues

(

RVC::DBTABLE::RECORD &

record

)

Get current values.

Parameters:

record

Values returned

bool RVC::UI::FORM_DB_RECORD::HasChangedSettings

(

)

const

Determine if layout settings have changed.

bool RVC::UI::FORM_DB_RECORD::IsRecordChanged

(

)

const

Determine if any field values have been changed since last saved.

void RVC::UI::FORM_DB_RECORD::NotifyDlgClose

(

)

Notify form that containing dialog is being closed.

Will hide, but not destroy, any open field value dialogs.

void RVC::UI::FORM_DB_RECORD::NotifyDlgOpen

(

)

Notify form that containing dialog was opened.

Will show any existing field value dialogs.

ERRVALUE RVC::UI::FORM_DB_RECORD::Reread

(

)

Reread current record from table.

INT32 RVC::UI::FORM_DB_RECORD::SaveRecord

(

bool

AskUser = true

)

Save record with optional prompt to user.

Returns:

EUserCancel if user chooses cancel, or error < 0, TRUE if saved, FALSE if not saved or no change.

Parameters:

AskUser

Whether to prompt user to save or not

void RVC::UI::FORM_DB_RECORD::SetDelegateOnChangedFieldValue

(

DELEGATE_VOID_INT32

delegate

)

Set delegate for notifying when field value changed by user.

ERRVALUE RVC::UI::FORM_DB_RECORD::SetRecordRef	(	DBTABLE::RECORDREFTYPE	RefType,
		INT32	RefNum
	)

Set current record, will read values from table if existing.

Parameters:

	RefType	Reference type
	RefNum	Reference number, -1 for RECORDREFTYPE_New record

ERRVALUE RVC::UI::FORM_DB_RECORD::SetValues	(	const RVC::DBTABLE::RECORD &	record,
		bool	IsChanged
	)

Set values from record.

Parameters:

	record	Values to set
	IsChanged	Whether to treat as "changed" for saving

static void RVC::UI::FORM_DB_RECORD::SML_Install

(

SML::CONTEXT *

context

)

[static]

Install SML interface.

void RVC::UI::FORM_DB_RECORD::UndoAll

(

)

Undo all edits, restoring from saved record.

bool RVC::UI::FORM_DB_RECORD::UndoLast

(

)

Undo last edit.

Returns:

true if more edits to undo, false if not.

---

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

• rvc/uiformdbrecord.h