Inheritance diagram for uiListBoxObj:

Public Member Functions
	uiListBoxObj (uiParent , const char nm, OD::ChoiceMode)

	~uiListBoxObj ()

uiListBoxBody &	body ()

Public Member Functions inherited from uiObject
	~uiObject ()

uiSize	actualSize (bool include_border=true) const

void	attach (constraintType, int margin=-1)
	attaches object to another In case the stretched... options are used, margin=-1 (default) stretches the object not to cross the border. margin=-2 stretches the object to fill the parent's border. This looks nice with separators. More...

void	attach (constraintType, uiObject *, int margin=-1, bool reciprocal=true)

void	attach (constraintType, uiParent *, int margin=-1, bool reciprocal=true)

virtual OD::Color	backgroundColor () const

virtual const ObjectSet< uiBaseObject > *	childList () const

void	close ()

void	deepRedraw ()

void	disabFocus ()

void	display (bool yn, bool shrink=false, bool maximized=false)

const uiFont *	font () const

QWidget *	getWidget () override

virtual bool	handleLongTabletPress ()

bool	hasFocus () const

virtual int	height () const
	Actual size in pixels. More...

bool	isCursorInside () const

bool	isDisplayed () const

virtual bool	isEmpty () const

bool	isSensitive () const

uiMainWin *	mainwin ()

uiParent *	parent ()

const uiParent *	parent () const

int	prefHNrPics () const

int	prefVNrPics () const

QWidget *	qwidget ()

const QWidget *	qwidget () const

void	reDraw (bool deep)

void	reParent (uiParent *)

OD::Color	roBackgroundColor () const

bool	sensitive () const

virtual void	setBackgroundColor (const OD::Color &)

virtual void	setBackgroundPixmap (const uiPixmap &)

void	setCaption (const uiString &)

virtual void	setCursor (const MouseCursor &)

void	setFocus ()

void	setFont (const uiFont &)

void	setHSzPol (SzPolicy)

void	setMaximumHeight (int)

void	setMaximumHeightInChar (int)

void	setMaximumWidth (int)

void	setMaximumWidthInChar (int)

void	setMinimumHeight (int)

void	setMinimumHeightInChar (int)

void	setMinimumWidth (int)

void	setMinimumWidthInChar (int)

virtual void	setName (const char *) override

virtual void	setPrefHeight (int)

void	setPrefHeightInChar (float)

void	setPrefHeightInChar (int)

virtual void	setPrefWidth (int)

void	setPrefWidthInChar (float)

void	setPrefWidthInChar (int)

void	setSensitive (bool yn=true)

void	setStretch (int hor, int ver)
	Sets stretch factors for object If stretch factor is > 1, then object will already grow at pop-up. More...

virtual void	setStyleSheet (const char *)

virtual void	setTextColor (const OD::Color &)

void	setToolTip (const uiString &)

void	setVSzPol (SzPolicy)

void	shallowRedraw ()

int	stretch (bool hor) const

SzPolicy	szPol (bool hor=true) const

const uiString &	toolTip () const

void	translateText () override

bool	visible () const

virtual int	width () const
	Actual size in pixels. More...

Public Member Functions inherited from uiBaseObject
	uiBaseObject (const char nm, uiBody =0)

virtual	~uiBaseObject ()

int	beginCmdRecEvent (const BufferString &msg)

int	beginCmdRecEvent (const char *msg=0)

int	beginCmdRecEvent (od_uint64 id, const char *msg=0)

uiBody *	body ()

const uiBody *	body () const

void	clear ()

void	endCmdRecEvent (int refnr, const char *msg=0)

void	endCmdRecEvent (od_uint64 id, int refnr, const char *msg=0)

void	finalise ()

bool	finalised () const

void	finalize ()

bool	finalized () const

const QWidget *	getWidget () const

virtual Notifier< uiBaseObject > &	postFinalise ()

virtual Notifier< uiBaseObject > &	postFinalize ()

virtual Notifier< uiBaseObject > &	preFinalise ()

virtual Notifier< uiBaseObject > &	preFinalize ()

Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=0)

	NamedCallBacker (const NamedCallBacker &)

virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const

bool	operator== (const NamedCallBacker &oth) const

bool	operator== (const NamedObject &oth) const

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

virtual CallBacker *	trueCaller ()

Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=nullptr)

	NamedObject (const NamedObject &oth)

virtual	~NamedObject ()

virtual BufferString	getName () const

bool	getNameFromPar (const IOPar &)

const name_type &	name () const override

NamedObject &	operator= (const NamedObject &)

bool	operator== (const NamedObject &oth) const

Public Member Functions inherited from ObjectWithName
virtual	~ObjectWithName ()

bool	hasName (const char *nm) const

bool	hasName (const name_type &nm) const

void	putNameInPar (IOPar &) const

Private Member Functions
uiListBoxBody &	mkbody (uiParent , const char , OD::ChoiceMode)

Private Attributes
uiListBoxBody *	body_

Additional Inherited Members
Public Types inherited from uiObject
enum	SzPolicy { Undef , Small , Medium , Wide , SmallVar , MedVar , WideVar , SmallMax , MedMax , WideMax }
	How should the object's size behave? Undef : use default. Small : 1 base sz. Medium : 2* base sz + 1. Wide : 4* base sz + 3. The xxVar options specify that the element may have a bigger internal preferred size. In that case, the maximum is taken. The xxMax options specify that the element should take all available space ( stretch = 2 ) More...

Public Types inherited from ObjectWithName
typedef OD::String	name_type

Static Public Member Functions inherited from uiObject
static int	baseFldSize ()

static int	iconSize ()

static void	setTabOrder (uiObject first, uiObject second)

static void	updateToolTips ()

Static Public Member Functions inherited from uiBaseObject
static void	addCmdRecorder (const CallBack &)

static void	removeCmdRecorder (const CallBack &)

Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()

static void	removeReceiverForCurrentThread ()

Public Attributes inherited from uiObject
Notifier< uiObject >	closed
	Triggered when object closes. More...

CNotifier< uiObject, uiRect & >	setGeometry
	triggered when getting a new geometry A reference to the new geometry is passed which can be manipulated, before the geometry is actually set to the QWidget. More...

Protected Member Functions inherited from uiObject
	uiObject (uiParent , const char nm)

	uiObject (uiParent , const char nm, uiObjectBody &)

virtual bool	closeOK ()
	hook. Accepts/denies closing of window. More...

uiObjectBody *	objBody ()

const uiObjectBody *	objBody () const

void	triggerSetGeometry (const i_LayoutItem *, uiRect &)
	setGeometry should be triggered by this's layoutItem More...

void	updateToolTip (CallBacker *=nullptr)

Protected Member Functions inherited from uiBaseObject
void	setBody (uiBody *b)

Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const

Protected Attributes inherited from uiObject
uiString	tooltip_

uiObjEventFilter *	uiobjeventfilter_

Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool >	delalreadytriggered_

Notifier< NamedCallBacker >	delnotif_

Protected Attributes inherited from NamedObject
BufferString	name_

Detailed Description

List Box.

The size of the box is determined automatically (prefNrLines=0) but can be overruled by setNrLines().

If the user can select multiple items, then there is a difference between selected and current item. In the old (Windows) style, you got something that resembles having many current items. Two main problems make us want to phase out this style: The fact that the user can in fact choose multiple items is visually hidden, In many styles you don't know what the current item is after selecting blocks Especially the first problem is a big thing.

New style multi-select works with a check boxes in front of each item. This delivers a challenge because what if the current item is not checked?

This is the basis for the 'chosen' concept, which works in both single- and multi-selection modes. In multi-selection, an item is chosen if it is checked. If no box is checked, then you can have the listbox report the current item as the chosen item. To switch this off, tell the listbox that no chosen is a valid thing, i.e. pick the ZeroOrMore mode.

Lastly, you can have some of the items marked. This will be done by surrounding the item with curly braces, like: '{the item}'. This will not affect selection/checked/chosen status.

<>

Constructor & Destructor Documentation

◆ uiListBoxObj()

uiListBoxObj::uiListBoxObj	(	uiParent *	,
		const char *	nm,
		OD::ChoiceMode
	)

◆ ~uiListBoxObj()

uiListBoxObj::~uiListBoxObj ( )

Member Function Documentation

◆ body()

uiListBoxBody& uiListBoxObj::body ( )

inline

◆ mkbody()

uiListBoxBody& uiListBoxObj::mkbody	(	uiParent *	,
		const char *	,
		OD::ChoiceMode
	)

private

Member Data Documentation

◆ body_

uiListBoxBody* uiListBoxObj::body_