RVC::UI::FORM_SELECT_CHILD Class Reference

Combobox that contains the list of children from a given parent to select from given a possible filter. More...

#include <rvc/uiformselectchild.h>

Inheritance diagram for RVC::UI::FORM_SELECT_CHILD:

[legend]

List of all members.

Public Member Functions
	FORM_SELECT_CHILD ()
virtual	~FORM_SELECT_CHILD ()
void	AddChildren (const RVC::OBJITEM &ObjItemParent, RVC::OBJTYPE ObjTypeChild, bool DftLastUsed, bool resize=true, RVC::OBJECT::FILTER *pFilter=0)
void	AddChildren (const RVC::OBJECT &ParentObj, RVC::OBJTYPE ObjTypeChild, bool DftLastUsed, bool resize=true, RVC::OBJECT::FILTER *pFilter=0)
void	DeleteChildren ()
const RVC::OBJECTNAME &	GetSelectedChildName () const
bool	HasSelectedChild () const
bool	SetSelectedChildName (const RVC::OBJECTNAME &ChildName, bool notify=false)

---

Detailed Description

Combobox that contains the list of children from a given parent to select from given a possible filter.

No predefined items (such as "none") will be automatically added. Use the AddItem method to add non-child choices to the combobox.

---

Constructor & Destructor Documentation

RVC::UI::FORM_SELECT_CHILD::FORM_SELECT_CHILD

(

)

Constructor.

virtual RVC::UI::FORM_SELECT_CHILD::~FORM_SELECT_CHILD

(

)

[virtual]

Destructor.

---

Member Function Documentation

void RVC::UI::FORM_SELECT_CHILD::AddChildren	(	const RVC::OBJITEM &	ObjItemParent,
		RVC::OBJTYPE	ObjTypeChild,
		bool	DftLastUsed,
		bool	resize = true,
		RVC::OBJECT::FILTER *	pFilter = 0
	)

Add list of children for specified parent OBJITEM.

See documention for other AddChildren method for additional details.

Parameters:

	ObjItemParent	OBJITEM of parent
	ObjTypeChild	OBJTYPE of children to add
	DftLastUsed	Default to last-used child of specified type
	resize	Resize to content width
	pFilter	Optional filter to limit choices

void RVC::UI::FORM_SELECT_CHILD::AddChildren	(	const RVC::OBJECT &	ParentObj,
		RVC::OBJTYPE	ObjTypeChild,
		bool	DftLastUsed,
		bool	resize = true,
		RVC::OBJECT::FILTER *	pFilter = 0
	)

Add list of children for specified parent OBJECT.

Create must be called before using this method. Any previous children will be automatically removed prior to adding the new child list at the end. Other items may be freely added or removed from the combobox using AddItem without the need to avoid conflicting IDs. However, if using DeleteAllItems, DeleteChildren should be called first to properly update. When determining which item is selected, first use GetSelectedChild and if the returned name is empty then GetSelectedItemID may be used to determine which non-child selection was used. The ID used for child items will be INT32_MIN.

Parameters:

	ParentObj	Parent object
	ObjTypeChild	OBJTYPE of children to add
	DftLastUsed	Default to last-used child of specified type
	resize	Resize to content width
	pFilter	Optional filter to limit choices

void RVC::UI::FORM_SELECT_CHILD::DeleteChildren

(

)

Delete all children from combobox.

const RVC::OBJECTNAME& RVC::UI::FORM_SELECT_CHILD::GetSelectedChildName

(

)

const

Get the short name of the currectly selected child object.

If a non-child choice is selected, the OBJECTNAME returned will be empty.

bool RVC::UI::FORM_SELECT_CHILD::HasSelectedChild

(

)

const

Determine if child object is currently selected.

bool RVC::UI::FORM_SELECT_CHILD::SetSelectedChildName	(	const RVC::OBJECTNAME &	ChildName,
		bool	notify = false
	)

Set the selected combobox item via the child's short name.

Has no effect if Create() has not been called.

Returns:

true if match found, false if not.

Parameters:

	ChildName	Short name of child to select, has no effect if no match found
	notify	Notify via delegate

---

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

• rvc/uiformselectchild.h