RVC::UI::FORM_DB_FIELD_PICKLIST Class Reference

Form for picking database field value from list. More...

#include <rvc/uiformdbfieldpicklist.h>

Inheritance diagram for RVC::UI::FORM_DB_FIELD_PICKLIST:

[legend]

List of all members.

Classes
class	SETTINGS
Public Types
enum	FORMSTYLE {   FORMSTYLE_SelectSingle = 0x0000, FORMSTYLE_SelectMulti = 0x0001, FORMSTYLE_ComboBox = 0x0002, FORMSTYLE_AllowSelectNone = 0x0004,   FORMSTYLE_UseGroupBox = 0x0008, FORMSTYLE_NoEditSettings = 0x0010 }
Public Member Functions
	FORM_DB_FIELD_PICKLIST ()
virtual	~FORM_DB_FIELD_PICKLIST ()
ERRVALUE	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, const MISTRING &label, const RVC::DBTABLE &TableFor, INT32 FieldNumFor, const SETTINGS &settings, FORMSTYLE FormStyle, MGUI::LAYOUT_SIZEALIGN SizeAlign=MGUI::LAYOUT_SIZEALIGN_Expand)
ERRVALUE	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, const MISTRING &label, const RVC::DBTABLE &TableFor, INT32 FieldNumFor, FORMSTYLE FormStyle, MGUI::LAYOUT_SIZEALIGN SizeAlign=MGUI::LAYOUT_SIZEALIGN_Expand)
const SETTINGS &	GetSettings () const
const RVC::DBTABLE &	GetTablePickFrom () const
ERRVALUE	GetValueSelected (RVC::DBTABLE::RECORD &RecordRet, INT32 FieldNumRet) const
bool	HasSelection () const
bool	IsValueSelected (const RVC::DBTABLE::RECORD &RecordTest, INT32 FieldNumTest) const
void	SetDelegateOnChangeSelection (DELEGATE_VOID_NOPARMS delegate)
ERRVALUE	SetValueSelected (const RVC::DBTABLE::RECORD &RecordSet, INT32 FieldNumSet, bool notify=true)
Static Public Member Functions
static int	DlgEditSettings (MDLGPARENT dlgparent, const RVC::DBTABLE &TableFor, INT32 FieldNumFor, FORM_DB_FIELD_PICKLIST::SETTINGS &settings, bool ForGrouping=false)

---

Detailed Description

Form for picking database field value from list.

---

Member Enumeration Documentation

enum RVC::UI::FORM_DB_FIELD_PICKLIST::FORMSTYLE

Enumerator:

FORMSTYLE_SelectSingle	Single selection.
FORMSTYLE_SelectMulti	Allow selection of multiple items.
FORMSTYLE_ComboBox	Use combobox for selection, cannot use with FORMSTYLE_SelectMulti.
FORMSTYLE_AllowSelectNone	User is allowed choice of <none>.
FORMSTYLE_UseGroupBox	Place form in groupbox even if no label.
FORMSTYLE_NoEditSettings	Don't include Settings choice on popup menu.

---

Constructor & Destructor Documentation

RVC::UI::FORM_DB_FIELD_PICKLIST::FORM_DB_FIELD_PICKLIST

(

)

Constructor.

virtual RVC::UI::FORM_DB_FIELD_PICKLIST::~FORM_DB_FIELD_PICKLIST

(

)

[virtual]

Destructor.

---

Member Function Documentation

ERRVALUE RVC::UI::FORM_DB_FIELD_PICKLIST::Create	(	MGUI::LAYOUT_PANE_BASE &	ParentPane,
		const MISTRING &	label,
		const RVC::DBTABLE &	TableFor,
		INT32	FieldNumFor,
		const SETTINGS &	settings,
		FORMSTYLE	FormStyle,
		MGUI::LAYOUT_SIZEALIGN	SizeAlign = MGUI::LAYOUT_SIZEALIGN_Expand
	)

Create with specified settings.

Parameters:

	TableFor	Table picklist is FOR
	FieldNumFor	Field picklist is FOR

ERRVALUE RVC::UI::FORM_DB_FIELD_PICKLIST::Create	(	MGUI::LAYOUT_PANE_BASE &	ParentPane,
		const MISTRING &	label,
		const RVC::DBTABLE &	TableFor,
		INT32	FieldNumFor,
		FORMSTYLE	FormStyle,
		MGUI::LAYOUT_SIZEALIGN	SizeAlign = MGUI::LAYOUT_SIZEALIGN_Expand
	)

Create with default settings.

Parameters:

	TableFor	Table picklist is FOR
	FieldNumFor	Field picklist is FOR

static int RVC::UI::FORM_DB_FIELD_PICKLIST::DlgEditSettings	(	MDLGPARENT	dlgparent,
		const RVC::DBTABLE &	TableFor,
		INT32	FieldNumFor,
		FORM_DB_FIELD_PICKLIST::SETTINGS &	settings,
		bool	ForGrouping = false
	)			[static]

Dialog to change picklist form settings.

Returns:

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

Parameters:

settings

Settings passed/returned

const SETTINGS& RVC::UI::FORM_DB_FIELD_PICKLIST::GetSettings

(

)

const [inline]

Get current settings.

const RVC::DBTABLE& RVC::UI::FORM_DB_FIELD_PICKLIST::GetTablePickFrom

(

)

const

Get table picking from.

ERRVALUE RVC::UI::FORM_DB_FIELD_PICKLIST::GetValueSelected	(	RVC::DBTABLE::RECORD &	RecordRet,
		INT32	FieldNumRet
	)			const

Get value for selected item in single-selection mode, if any.

Parameters:

	RecordRet	Record to place value into
	FieldNumRet	Field in RecordRet to contain value

bool RVC::UI::FORM_DB_FIELD_PICKLIST::HasSelection

(

)

const

Determine if has any item selected.

bool RVC::UI::FORM_DB_FIELD_PICKLIST::IsValueSelected	(	const RVC::DBTABLE::RECORD &	RecordTest,
		INT32	FieldNumTest
	)			const

Determine if value from specified record is selected.

Parameters:

	RecordTest	Record containing value to test
	FieldNumTest	Field in RecordTest containing value to test

void RVC::UI::FORM_DB_FIELD_PICKLIST::SetDelegateOnChangeSelection

(

DELEGATE_VOID_NOPARMS

delegate

)

[inline]

Set delegate for when selection changed.

ERRVALUE RVC::UI::FORM_DB_FIELD_PICKLIST::SetValueSelected	(	const RVC::DBTABLE::RECORD &	RecordSet,
		INT32	FieldNumSet,
		bool	notify = true
	)

Set value selected.

Parameters:

	RecordSet	Record to get value to set from
	FieldNumSet	Field in RecordSet to set from
	notify	Notify via delegate if changed

---

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

• rvc/uiformdbfieldpicklist.h