uiTreeView Class Reference

Inheritance diagram for uiTreeView:

Public Types
enum	ScrollMode { Auto , AlwaysOff , AlwaysOn }
enum	SelectionBehavior { SelectItems , SelectRows , SelectColumns }
enum	SelectionMode {   NoSelection =0 , Single , Multi , Extended ,   Contiguous }
enum	WidthMode {   Manual , Fixed , Stretch , ResizeToContents ,   Custom }
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

Public Member Functions
	uiTreeView (uiParent *parnt, const char *nm="uiTreeView", int preferredNrLines=0, bool rootdecorated=true)
virtual	~uiTreeView ()
void	addColumns (const BufferStringSet &)
void	addColumns (const uiStringSet &)
void	checkAll ()
void	clear ()
void	clearSelection ()
void	collapseAll ()
Alignment::HPos	columnAlignment (int) const
int	columnNotified ()
const char *	columnText (int column) const
int	columnWidth (int column) const
WidthMode	columnWidthMode (int column) const
int	currentColumn () const
uiTreeViewItem *	currentItem () const
void	deselectAll ()
void	ensureItemVisible (const uiTreeViewItem *)
void	expandAll ()
void	expandTo (int treedepth)
uiTreeViewItem *	findItem (const char *, int, bool) const
uiTreeViewItem *	firstItem () const
uiString	getColumnText (int column) const
uiTreeViewItem *	getItem (int) const
void	getSelectedItems (ObjectSet< uiTreeViewItem > &) const
bool	handleLongTabletPress () override
int	indexOfItem (uiTreeViewItem *) const
void	insertItem (int, uiTreeViewItem *)
bool	isEmpty () const override
bool	isSelected (const uiTreeViewItem *) const
int	itemMargin () const
uiTreeViewItem *	itemNotified ()
	item last notified. See notifiers below More...
uiTreeViewItem *	lastItem () const
int	nrColumns () const
int	nrItems (bool recursive=false) const
int	nrSelected () const
uiParent *	parent ()
void	removeColumn (int index)
void	removeSelectedItems ()
void	resizeHeightToContents (int minh=-1, int maxh=-1)
bool	rootDecorated () const
void	selectAll ()
uiTreeViewItem *	selectedItem () const
SelectionBehavior	selectionBehavior () const
SelectionMode	selectionMode () const
void	setColumnAlignment (Alignment::HPos)
void	setColumnAlignment (int, Alignment::HPos)
void	setColumnText (int column, const uiString &label)
void	setColumnWidth (int column, int width)
void	setColumnWidthMode (int column, WidthMode)
void	setColumnWidthMode (WidthMode)
void	setCurrentItem (uiTreeViewItem *, int column=0)
void	setEmpty ()
void	setFixedColumnWidth (int column, int width)
void	setHScrollBarMode (ScrollMode)
void	setItemMargin (int)
void	setNotifiedColumn (int col)
void	setNotifiedItem (QTreeWidgetItem *)
void	setNrColumns (int)
void	setNrLines (int)
void	setRootDecorated (bool yn)
void	setSelected (uiTreeViewItem *, bool)
void	setSelectionBehavior (SelectionBehavior)
void	setSelectionMode (SelectionMode)
void	setShowToolTips (bool)
void	setVScrollBarMode (ScrollMode)
void	showHeader (bool yn)
bool	showToolTips () const
void	takeItem (uiTreeViewItem *)
void	translateText () override
void	triggerUpdate ()
	re-draws at next X-loop More...
void	uncheckAll ()
void	unNotify ()
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
bool	hasFocus () const
virtual int	height () const
	Actual size in pixels. More...
bool	isCursorInside () const
bool	isDisplayed () 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
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

Public Attributes
Notifier< uiTreeView >	collapsed
Notifier< uiTreeView >	contextMenuRequested
Notifier< uiTreeView >	currentChanged
Notifier< uiTreeView >	doubleClicked
Notifier< uiTreeView >	expanded
Notifier< uiTreeView >	itemChanged
Notifier< uiTreeView >	itemRenamed
Notifier< uiTreeView >	leftButtonClicked
Notifier< uiTreeView >	leftButtonPressed
Notifier< uiTreeView >	mouseButtonClicked
Notifier< uiTreeView >	mouseButtonPressed
Notifier< uiTreeView >	returnPressed
Notifier< uiTreeView >	rightButtonClicked
Notifier< uiTreeView >	rightButtonPressed
Notifier< uiTreeView >	selectionChanged
Notifier< uiTreeView >	unusedKey
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
bool	allowDoubleClick () const
void	cursorSelectionChanged (CallBacker *)
void	itemChangedCB (CallBacker *)
uiTreeViewBody *	lvbody ()
const uiTreeViewBody *	lvbody () const
void	updateCheckStatus (uiTreeViewItem *)
void	updateHeaderLabels ()
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
OD::ButtonState	buttonstate_
int	column_
uiTreeViewItem *	lastitemnotified_
uiParent *	parent_
BufferString	rettxt
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_

Private Member Functions
uiTreeViewBody &	mkbody (uiParent *, const char *, int)

Private Attributes
uiTreeViewBody *	body_
uiStringSet	labels_

Friends
class	i_treeVwMessenger
class	uiTreeViewBody
class	uiTreeViewItem
class	uiTreeViewItemIterator

Additional Inherited Members
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 ()

Detailed Description

<>

Member Enumeration Documentation

ScrollMode

enum uiTreeView::ScrollMode

Enumerator
Auto
AlwaysOff
AlwaysOn

SelectionBehavior

enum uiTreeView::SelectionBehavior

Enumerator
SelectItems
SelectRows
SelectColumns

SelectionMode

enum uiTreeView::SelectionMode

Enumerator
NoSelection
Single
Multi
Extended
Contiguous

WidthMode

enum uiTreeView::WidthMode

Enumerator
Manual
Fixed
Stretch
ResizeToContents
Custom

Constructor & Destructor Documentation

uiTreeView()

uiTreeView::uiTreeView	(	uiParent *	parnt,
		const char *	nm = "uiTreeView",
		int	preferredNrLines = 0,
		bool	rootdecorated = true
	)

~uiTreeView()

virtual uiTreeView::~uiTreeView ( )

virtual

Member Function Documentation

addColumns() [1/2]

void uiTreeView::addColumns

(

const BufferStringSet &

)

addColumns() [2/2]

void uiTreeView::addColumns

(

const uiStringSet &

)

allowDoubleClick()

bool uiTreeView::allowDoubleClick ( ) const

protected

checkAll()

void uiTreeView::checkAll

(

)

clear()

void uiTreeView::clear

(

)

clearSelection()

void uiTreeView::clearSelection

(

)

collapseAll()

void uiTreeView::collapseAll

(

)

columnAlignment()

Alignment::HPos uiTreeView::columnAlignment

(

int

)

const

columnNotified()

int uiTreeView::columnNotified ( )

inline

columnText()

const char* uiTreeView::columnText

(

int

column

)

const

columnWidth()

int uiTreeView::columnWidth

(

int

column

)

const

columnWidthMode()

WidthMode uiTreeView::columnWidthMode

(

int

column

)

const

currentColumn()

int uiTreeView::currentColumn

(

)

const

currentItem()

uiTreeViewItem* uiTreeView::currentItem

(

)

const

cursorSelectionChanged()

void uiTreeView::cursorSelectionChanged ( CallBacker *  )

protected

deselectAll()

void uiTreeView::deselectAll

(

)

ensureItemVisible()

void uiTreeView::ensureItemVisible

(

const uiTreeViewItem *

)

expandAll()

void uiTreeView::expandAll

(

)

expandTo()

void uiTreeView::expandTo

(

int

treedepth

)

findItem()

uiTreeViewItem* uiTreeView::findItem	(	const char *	,
		int	,
		bool
	)		const

firstItem()

uiTreeViewItem* uiTreeView::firstItem

(

)

const

getColumnText()

uiString uiTreeView::getColumnText

(

int

column

)

const

getItem()

uiTreeViewItem* uiTreeView::getItem

(

int

)

const

getSelectedItems()

void uiTreeView::getSelectedItems

(

ObjectSet< uiTreeViewItem > &

)

const

handleLongTabletPress()

bool uiTreeView::handleLongTabletPress ( )

overridevirtual

Reimplemented from uiObject.

indexOfItem()

int uiTreeView::indexOfItem

(

uiTreeViewItem *

)

const

insertItem()

void uiTreeView::insertItem	(	int	,
		uiTreeViewItem *
	)

isEmpty()

bool uiTreeView::isEmpty ( ) const

overridevirtual

Reimplemented from uiObject.

isSelected()

bool uiTreeView::isSelected

(

const uiTreeViewItem *

)

const

itemChangedCB()

void uiTreeView::itemChangedCB ( CallBacker *  )

protected

itemMargin()

int uiTreeView::itemMargin

(

)

const

itemNotified()

uiTreeViewItem* uiTreeView::itemNotified ( )

inline

item last notified. See notifiers below

lastItem()

uiTreeViewItem* uiTreeView::lastItem

(

)

const

lvbody() [1/2]

uiTreeViewBody* uiTreeView::lvbody ( )

inlineprotected

lvbody() [2/2]

const uiTreeViewBody* uiTreeView::lvbody ( ) const

inlineprotected

mkbody()

uiTreeViewBody& uiTreeView::mkbody ( uiParent *  , const char *  , int    )

private

nrColumns()

int uiTreeView::nrColumns

(

)

const

nrItems()

int uiTreeView::nrItems

(

bool

recursive = false

)

const

nrSelected()

int uiTreeView::nrSelected

(

)

const

parent()

uiParent* uiTreeView::parent ( )

inline

removeColumn()

void uiTreeView::removeColumn

(

int

index

)

removeSelectedItems()

void uiTreeView::removeSelectedItems

(

)

resizeHeightToContents()

void uiTreeView::resizeHeightToContents	(	int	minh = -1,
		int	maxh = -1
	)

rootDecorated()

bool uiTreeView::rootDecorated

(

)

const

selectAll()

void uiTreeView::selectAll

(

)

selectedItem()

uiTreeViewItem* uiTreeView::selectedItem

(

)

const

selectionBehavior()

SelectionBehavior uiTreeView::selectionBehavior

(

)

const

selectionMode()

SelectionMode uiTreeView::selectionMode

(

)

const

setColumnAlignment() [1/2]

void uiTreeView::setColumnAlignment

(

Alignment::HPos

)

setColumnAlignment() [2/2]

void uiTreeView::setColumnAlignment	(	int	,
		Alignment::HPos
	)

setColumnText()

void uiTreeView::setColumnText	(	int	column,
		const uiString &	label
	)

setColumnWidth()

void uiTreeView::setColumnWidth	(	int	column,
		int	width
	)

setColumnWidthMode() [1/2]

void uiTreeView::setColumnWidthMode	(	int	column,
		WidthMode
	)

setColumnWidthMode() [2/2]

void uiTreeView::setColumnWidthMode

(

WidthMode

)

setCurrentItem()

void uiTreeView::setCurrentItem	(	uiTreeViewItem *	,
		int	column = 0
	)

setEmpty()

void uiTreeView::setEmpty

(

)

setFixedColumnWidth()

void uiTreeView::setFixedColumnWidth	(	int	column,
		int	width
	)

setHScrollBarMode()

void uiTreeView::setHScrollBarMode

(

ScrollMode

)

setItemMargin()

void uiTreeView::setItemMargin

(

int

)

setNotifiedColumn()

void uiTreeView::setNotifiedColumn ( int  col )

inline

setNotifiedItem()

void uiTreeView::setNotifiedItem

(

QTreeWidgetItem *

)

setNrColumns()

void uiTreeView::setNrColumns

(

int

)

setNrLines()

void uiTreeView::setNrLines

(

int

)

setRootDecorated()

void uiTreeView::setRootDecorated

(

bool

yn

)

setSelected()

void uiTreeView::setSelected	(	uiTreeViewItem *	,
		bool
	)

setSelectionBehavior()

void uiTreeView::setSelectionBehavior

(

SelectionBehavior

)

setSelectionMode()

void uiTreeView::setSelectionMode

(

SelectionMode

)

setShowToolTips()

void uiTreeView::setShowToolTips

(

bool

)

setVScrollBarMode()

void uiTreeView::setVScrollBarMode

(

ScrollMode

)

showHeader()

void uiTreeView::showHeader

(

bool

yn

)

showToolTips()

bool uiTreeView::showToolTips

(

)

const

takeItem()

void uiTreeView::takeItem

(

uiTreeViewItem *

)

translateText()

void uiTreeView::translateText ( )

overridevirtual

Triggers translation of object and all members to current language.

Reimplemented from uiObject.

triggerUpdate()

void uiTreeView::triggerUpdate

(

)

re-draws at next X-loop

uncheckAll()

void uiTreeView::uncheckAll

(

)

unNotify()

void uiTreeView::unNotify ( )

inline

updateCheckStatus()

void uiTreeView::updateCheckStatus ( uiTreeViewItem *  )

protected

updateHeaderLabels()

void uiTreeView::updateHeaderLabels ( )

protected

Friends And Related Function Documentation

i_treeVwMessenger

friend class i_treeVwMessenger

friend

uiTreeViewBody

friend class uiTreeViewBody

friend

uiTreeViewItem

friend class uiTreeViewItem

friend

uiTreeViewItemIterator

friend class uiTreeViewItemIterator

friend

Member Data Documentation

body_

uiTreeViewBody* uiTreeView::body_

private

buttonstate_

OD::ButtonState uiTreeView::buttonstate_

protected

collapsed

Notifier<uiTreeView> uiTreeView::collapsed

column_

int uiTreeView::column_

protected

contextMenuRequested

Notifier<uiTreeView> uiTreeView::contextMenuRequested

currentChanged

Notifier<uiTreeView> uiTreeView::currentChanged

doubleClicked

Notifier<uiTreeView> uiTreeView::doubleClicked

expanded

Notifier<uiTreeView> uiTreeView::expanded

itemChanged

Notifier<uiTreeView> uiTreeView::itemChanged

itemRenamed

Notifier<uiTreeView> uiTreeView::itemRenamed

labels_

uiStringSet uiTreeView::labels_

private

lastitemnotified_

uiTreeViewItem* uiTreeView::lastitemnotified_

protected

leftButtonClicked

Notifier<uiTreeView> uiTreeView::leftButtonClicked

leftButtonPressed

Notifier<uiTreeView> uiTreeView::leftButtonPressed

mouseButtonClicked

Notifier<uiTreeView> uiTreeView::mouseButtonClicked

mouseButtonPressed

Notifier<uiTreeView> uiTreeView::mouseButtonPressed

parent_

uiParent* uiTreeView::parent_

protected

rettxt

BufferString uiTreeView::rettxt

mutableprotected

returnPressed

Notifier<uiTreeView> uiTreeView::returnPressed

rightButtonClicked

Notifier<uiTreeView> uiTreeView::rightButtonClicked

rightButtonPressed

Notifier<uiTreeView> uiTreeView::rightButtonPressed

selectionChanged

Notifier<uiTreeView> uiTreeView::selectionChanged

unusedKey

Notifier<uiTreeView> uiTreeView::unusedKey