uiListBoxChoiceIO Class Reference

Allows save/restore of chosen items for a uiListBox. More...

Inheritance diagram for uiListBoxChoiceIO:

Public Member Functions
	uiListBoxChoiceIO (uiListBox &, const char *omftypekey)
	~uiListBoxChoiceIO ()
const BufferStringSet &	chosenKeys () const
const BufferStringSet &	chosenNames () const
BufferStringSet &	keys ()
void	setChosen (const BufferStringSet &names)
Public Member Functions inherited from CallBacker
	CallBacker ()
	CallBacker (const CallBacker &)
virtual	~CallBacker ()
bool	attachCB (const NotifierAccess &, const CallBack &, bool onlyifnew=false) const
bool	attachCB (const NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false) const
void	detachAllNotifiers () const
	Call from the destructor of your inherited object. More...
void	detachCB (const NotifierAccess &, const CallBack &) const
void	detachCB (const NotifierAccess *notif, const CallBack &cb) const
virtual bool	isCapsule () const
bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use. More...
void	stopReceivingNotifications () const

Public Attributes
Notifier< uiListBoxChoiceIO >	readDone
	now use setChosen More...
Notifier< uiListBoxChoiceIO >	storeRequested
	opportunity to set the keys More...

Protected Member Functions
void	readReqCB (CallBacker *)
void	storeReqCB (CallBacker *)

Protected Attributes
BufferStringSet	chosennames_
CtxtIOObj &	ctio_
BufferStringSet	keys_
uiListBox &	lb_

Additional Inherited Members
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()

Detailed Description

Allows save/restore of chosen items for a uiListBox.

If you provide keys (one for each item), then these will be stored too.

If you have no keys, then you can simply do setChosen( chosenNames() ). Otherwise you need to construct the display names yourself and then use setChosen().

Note: this object needs to be deleted explicitly; it will not be deleted automatically like the uiListBox itself.

<>

Constructor & Destructor Documentation

uiListBoxChoiceIO()

uiListBoxChoiceIO::uiListBoxChoiceIO	(	uiListBox &	,
		const char *	omftypekey
	)

~uiListBoxChoiceIO()

uiListBoxChoiceIO::~uiListBoxChoiceIO

(

)

Member Function Documentation

chosenKeys()

const BufferStringSet& uiListBoxChoiceIO::chosenKeys ( ) const

inline

chosenNames()

const BufferStringSet& uiListBoxChoiceIO::chosenNames ( ) const

inline

keys()

BufferStringSet& uiListBoxChoiceIO::keys ( )

inline

readReqCB()

void uiListBoxChoiceIO::readReqCB ( CallBacker *  )

protected

setChosen()

void uiListBoxChoiceIO::setChosen

(

const BufferStringSet &

names

)

storeReqCB()

void uiListBoxChoiceIO::storeReqCB ( CallBacker *  )

protected

Member Data Documentation

chosennames_

BufferStringSet uiListBoxChoiceIO::chosennames_

protected

ctio_

CtxtIOObj& uiListBoxChoiceIO::ctio_

protected

keys_

BufferStringSet uiListBoxChoiceIO::keys_

protected

lb_

uiListBox& uiListBoxChoiceIO::lb_

protected

readDone

Notifier<uiListBoxChoiceIO> uiListBoxChoiceIO::readDone

now use setChosen

storeRequested

Notifier<uiListBoxChoiceIO> uiListBoxChoiceIO::storeRequested

opportunity to set the keys