#include <iUserControlTreeView.h>

Inherits igor::iUserControl.

Public Member Functions
	iUserControlTreeView (const iWidgetPtr parent=nullptr)

virtual	~iUserControlTreeView ()

void	setItems (iItemData *itemData)

const std::vector< iItemPath > &	getSelectedItemPaths () const

void	setSelectedItemPaths (const std::vector< iItemPath > &itemPaths)

iClickTreeViewEvent &	getClickEvent ()

iContextMenuTreeViewEvent &	getContextMenuTreeViewEvent ()

void	clearFilter ()

void	setFilter (const iaString &key, const iaString &value)

void	clear () override

Public Member Functions inherited from igor::iUserControl
	iUserControl (iWidgetType type=iWidgetType::iUserControl, const iWidgetPtr parent=nullptr)

virtual	~iUserControl ()=default

Public Member Functions inherited from igor::iWidget
iWidgetType	getWidgetType () const

iWidgetKind	getWidgetKind () const

void	setZValue (uint32 zvalue)

uint32	getZValue () const

void	setBackground (const iaColor4f &color)

const iaColor4f &	getBackground () const

void	setForeground (const iaColor4f &color)

const iaColor4f &	getForeground () const

bool	isBlocked () const

bool	hasKeyboardFocus () const

iWidgetState	getState () const

iClickEvent &	getClickEvent ()

iMouseOffClickEvent &	getMouseOffClickEvent ()

iDoubleClickEvent &	getDoubleClickEvent ()

iMouseOverEvent &	getMouseOverEvent ()

iMouseOffEvent &	getMouseOffEvent ()

iChangeEvent &	getChangeEvent ()

iFocusEvent &	getFocusEvent ()

iWheelUpEvent &	getWheelUpEvent ()

iWheelDownEvent &	getWheelDownEvent ()

iContextMenuEvent &	getContextMenuEvent ()

iSelectionChangedEvent &	getSelectionChangedEvent ()

iaVector2f	getActualPos () const

int32	getActualPosX () const

int32	getActualPosY () const

int32	getActualWidth () const

int32	getActualHeight () const

iaRectanglef	getActualRect () const

iaRectanglef	getActualClientRect () const

int32	getRelativePosX () const

int32	getRelativePosY () const

int32	getMinWidth () const

int32	getMinHeight () const

int32	getConfiguredMinWidth () const

int32	getConfiguredMinHeight () const

void	setMinWidth (int32 width)

void	setMinHeight (int32 height)

void	setMinSize (int32 width, int32 height)

void	setAcceptOutOfBoundsClicks (bool acceptOutOfBoundsClick=true)

bool	getAcceptOutOfBoundsClicks () const

iHorizontalAlignment	getHorizontalAlignment () const

iVerticalAlignment	getVerticalAlignment () const

void	setHorizontalAlignment (iHorizontalAlignment horizontalAlignment)

void	setVerticalAlignment (iVerticalAlignment verticalAlignment)

bool	isVisible () const

bool	isEnabled () const

void	setVisible (bool visible=true)

void	setEnabled (bool enabled=true)

iWidgetID	getID () const

iWidgetID	getParentID () const

iWidgetPtr	getParent () const

bool	isMouseOver ()

void	setAcceptDrag (bool acceptDrag)

bool	isAcceptingDrag ()

void	setAcceptDrop (bool acceptDrop)

bool	isAcceptingDrop ()

bool	hasParent () const

void	setGrowingByContent (bool grow=true)

bool	isGrowingByContent () const

iaString	getInfo () const

void	setTooltip (const iaString &text)

iaString	getTooltip () const

const std::vector< iWidgetPtr > &	getChildren () const

virtual void	clear ()

void	setIgnoreChildEventConsumption (bool value=true)

bool	isIgnoringChildEventConsumption () const

iWidgetPtr	getRoot ()

virtual void	blockEvents ()

virtual void	unblockEvents ()

void	setOverlayEnabled (bool overlay)

bool	isOverlayEnabled () const

virtual void	draw ()

virtual void	drawOverlay ()

virtual void	addWidget (iWidgetPtr widget)

virtual void	removeWidget (iWidgetPtr widget)

void	setCursor (iMouseCursorType cursorType)

void	setUserData (const std::any &userData)

std::any	getUserData () const

void	setSelectable (bool selectable)

bool	isSelectable () const

void	setMultiSelection (bool enabled)

bool	isMultiSelectionEnabled () const

void	setSelect (bool select)

bool	isSelected () const

void	clearSelection ()

const std::vector< iWidgetPtr >	getSelection () const

void	setSelection (const std::vector< iWidgetPtr > &selection)

void	refresh ()

Protected Member Functions
void	onClick (const iWidgetPtr source)

void	onContextMenu (const iWidgetPtr source)

void	initUI ()

virtual void	updateUI (iItem *item, const iItemPath &itemPath, int indentation=0)

Protected Member Functions inherited from igor::iUserControl
virtual void	calcMinSize ()

Protected Member Functions inherited from igor::iWidget
void	clearChildren ()

void	updateMinSize (int32 width, int32 height)

void	setParent (iWidgetPtr parent)

void	setKeyboardFocus ()

void	resetKeyboardFocus ()

void	setClientArea (int32 left, int32 right, int32 top, int32 bottom)

const iaVector2f &	getLastMousePos () const

	iWidget (iWidgetType type, iWidgetKind kind, const iWidgetPtr parent=nullptr)

virtual	~iWidget ()

virtual bool	onEvent (iEvent &event)

virtual bool	onMouseWheel (const iEventMouseWheel &event)

virtual bool	onMouseKeyDown (const iEventMouseKeyDown &event)

virtual bool	onMouseDoubleClick (const iEventMouseKeyDoubleClick &event)

virtual bool	onMouseKeyUp (const iEventMouseKeyUp &event)

virtual void	onMouseMove (const iEventMouseMove &event)

virtual bool	onASCII (const iEventKeyASCII &event)

virtual bool	onKeyDown (const iEventKeyDown &event)

virtual bool	onKeyUp (const iEventKeyUp &event)

virtual void	onLostKeyboardFocus ()

virtual void	onGainedKeyboardFocus ()

virtual void	calcMinSize ()

virtual void	updateAlignment (int32 clientWidth, int32 clientHeight)

virtual void	calcChildOffsets (std::vector< iaRectanglef > &offsets)

virtual void	onDragEnter (iDrag &drag)

virtual void	onDragMove (iDrag &drag, const iaVector2f &mousePos)

virtual void	onDragLeave (iDrag &drag)

virtual void	onDrop (const iDrag &drag, const iaVector2f &mousePos)

virtual void	onDrag ()

virtual void	onRefresh ()

Protected Attributes
iWidgetBoxLayoutPtr	_vboxLayout = nullptr

iWidgetScrollPtr	_scroll = nullptr

iClickTreeViewEvent	_clickEvent

iContextMenuTreeViewEvent	_contextMenuTreeViewEvent

std::vector< iItemPath >	_selectedItemPaths

std::vector< iWidgetButtonPtr >	_allInteractiveWidgets

iWidgetBoxLayoutPtr	_buttonLayout

std::unordered_map< iaString, std::vector< iaString > >	_filters

Protected Attributes inherited from igor::iWidget
bool	_selected = false

bool	_isSelectable = false

bool	_isMultiSelectionEnabled = false

std::vector< iWidgetPtr >	_children

int32	_configuredMinWidth = 0

int32	_configuredMinHeight = 0

iClickEvent	_click

iMouseOffClickEvent	_mouseOffClick

iContextMenuEvent	_contextMenu

iDoubleClickEvent	_doubleClick

iMouseOverEvent	_mouseOver

iMouseOffEvent	_mouseOff

iChangeEvent	_change

iFocusEvent	_focus

iWheelUpEvent	_wheelUp

iWheelDownEvent	_wheelDown

iSelectionChangedEvent	_selectionChanged

iaString	_tooltip

iaVector2f	_tooltipPos

iaTime	_tooltipTime = iaTime(0)

bool	_initTooltip = false

uint32	_zValue = 0

bool	_reactOnMouseWheel = true

bool	_blockedEvents = false

bool	_acceptOutOfBoundsClicks = false

bool	_acceptDrop = false

bool	_acceptDrag = false

bool	_isMouseOver = false

bool	_ignoreChildEventConsumption = false

iaVector2f	_lastMousePos

iaVector2f	_lastMousePressPos

bool	_needRefresh = true

Additional Inherited Members
Static Public Member Functions inherited from igor::iWidget
static iWidgetPtr	getKeyboardFocusWidget ()

static IGOR_INLINE float32	getScale ()

Static Public Attributes inherited from igor::iWidget
static const iWidgetID	INVALID_WIDGET_ID = 0

Detailed Description

tree view widget

Constructor & Destructor Documentation

◆ iUserControlTreeView()

igor::iUserControlTreeView::iUserControlTreeView ( const iWidgetPtr parent = nullptr )

ctor initializes member variables

Parameters

parent the optional parent

◆ ~iUserControlTreeView()

igor::iUserControlTreeView::~iUserControlTreeView ( )

virtual

clean up

Member Function Documentation

◆ clear()

void igor::iUserControlTreeView::clear ( )

overridevirtual

clears the widget back to default

Reimplemented from igor::iWidget.

◆ clearFilter()

void igor::iUserControlTreeView::clearFilter ( )

clears filter

◆ getClickEvent()

iClickTreeViewEvent & igor::iUserControlTreeView::getClickEvent ( )

Returns: the click event

◆ getContextMenuTreeViewEvent()

iContextMenuTreeViewEvent & igor::iUserControlTreeView::getContextMenuTreeViewEvent ( )

Returns: context menu event

◆ getSelectedItemPaths()

const std::vector< iItemPath > & igor::iUserControlTreeView::getSelectedItemPaths ( ) const

Returns: selected item path

◆ initUI()

void igor::iUserControlTreeView::initUI ( )

protected

initializes ui

◆ onClick()

void igor::iUserControlTreeView::onClick ( const iWidgetPtr source )

protected

handle click events from our buttons

Parameters

source the widget that was clicked

◆ onContextMenu()

void igor::iUserControlTreeView::onContextMenu ( const iWidgetPtr source )

protected

called when context menu is to be opened

Parameters

source the widget that was clicked

◆ setFilter()

void igor::iUserControlTreeView::setFilter	(	const iaString &	key,
		const iaString &	value
	)

filter for given key and value (iaString type only)

the filter is applied during setItems

Parameters

key	the key to filter for
value	the value to filter for

◆ setItems()

void igor::iUserControlTreeView::setItems ( iItemData * itemData )

sets tree items

caller keeps ownership

Parameters

itemData item data container

◆ setSelectedItemPaths()

void igor::iUserControlTreeView::setSelectedItemPaths ( const std::vector< iItemPath > & itemPaths )

sets selection from item paths

Parameters

itemPaths the item paths to select

◆ updateUI()

void igor::iUserControlTreeView::updateUI	(	iItem *	item,
		const iItemPath &	itemPath,
		int	indentation = `0`
	)

protectedvirtual

updates ui from tree items

Parameters

item	the current item to update from
itemPath	the path of the current item
indentation	indentation of given item

Member Data Documentation

◆ _allInteractiveWidgets

std::vector<iWidgetButtonPtr> igor::iUserControlTreeView::_allInteractiveWidgets

protected

hold on to all widgets

◆ _buttonLayout

iWidgetBoxLayoutPtr igor::iUserControlTreeView::_buttonLayout

protected

button layout holding all buttons

◆ _clickEvent

iClickTreeViewEvent igor::iUserControlTreeView::_clickEvent

protected

click event

◆ _contextMenuTreeViewEvent

iContextMenuTreeViewEvent igor::iUserControlTreeView::_contextMenuTreeViewEvent

protected

context menu event

◆ _filters

std::unordered_map<iaString, std::vector<iaString> > igor::iUserControlTreeView::_filters

protected

only display what matches the filter

◆ _scroll

iWidgetScrollPtr igor::iUserControlTreeView::_scroll = nullptr

protected

scroll widget

◆ _selectedItemPaths

std::vector<iItemPath> igor::iUserControlTreeView::_selectedItemPaths

protected

selected item paths

◆ _vboxLayout

iWidgetBoxLayoutPtr igor::iUserControlTreeView::_vboxLayout = nullptr

protected

box layout

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

/home/martin/dev/Igor/src/igor/igor/ui/user_controls/iUserControlTreeView.h
/home/martin/dev/Igor/src/igor/igor/ui/user_controls/iUserControlTreeView.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ iUserControlTreeView()

◆ ~iUserControlTreeView()

Member Function Documentation

◆ clear()

◆ clearFilter()

◆ getClickEvent()

◆ getContextMenuTreeViewEvent()

◆ getSelectedItemPaths()

◆ initUI()

◆ onClick()

◆ onContextMenu()

◆ setFilter()

◆ setItems()

◆ setSelectedItemPaths()

◆ updateUI()

Member Data Documentation

◆ _allInteractiveWidgets

◆ _buttonLayout

◆ _clickEvent

◆ _contextMenuTreeViewEvent

◆ _filters

◆ _scroll

◆ _selectedItemPaths

◆ _vboxLayout