Client-side interface to a PixInsight TreeBox control. More...

#include <TreeBox.h>

Inheritance diagram for pcl::TreeBox:

Classes
class	Node
	Client-side interface to a PixInsight TreeBox node. More...

Public Types
using	node_event_handler = void(Control::*)(TreeBox &, TreeBox::Node &, int)

using	node_expand_event_handler = void(Control::*)(TreeBox &, TreeBox::Node &)

using	node_navigation_event_handler = void(Control::*)(TreeBox &, TreeBox::Node &, TreeBox::Node &)

using	tree_event_handler = void(Control::*)(TreeBox &)

Public Types inherited from pcl::ScrollBox
using	pos_event_handler = void(Control::*)(ScrollBox &sender, int pos)

using	range_event_handler = void(Control::*)(ScrollBox &sender, int minValue, int maxValue)

Public Types inherited from pcl::Frame
using	style = FrameStyle::value_type

Public Types inherited from pcl::Control
using	child_event_handler = void(Control::*)(Control &sender, Control &child)

using	close_event_handler = void(Control::*)(Control &sender, bool &allowClose)

using	event_handler = void(Control::*)(Control &sender)

using	file_drag_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, const StringList &files, unsigned modifiers, bool &wantsFiles)

using	file_drop_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, const StringList &files, unsigned modifiers)

using	keyboard_event_handler = void(Control::*)(Control &sender, int key, unsigned modifiers, bool &wantsKey)

using	mouse_button_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, int button, unsigned buttons, unsigned modifiers)

using	mouse_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, unsigned buttons, unsigned modifiers)

using	mouse_wheel_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, int delta, unsigned buttons, unsigned modifiers)

using	move_event_handler = void(Control::*)(Control &sender, const pcl::Point &newPos, const pcl::Point &oldPos)

using	paint_event_handler = void(Control::*)(Control &sender, const pcl::Rect &updateRect)

using	resize_event_handler = void(Control::*)(Control &sender, int newWidth, int newHeight, int oldWidth, int oldHeight)

using	view_drag_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, const View &view, unsigned modifiers, bool &wantsView)

using	view_drop_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, const View &view, unsigned modifiers)

Public Member Functions
	TreeBox (Control &parent=Control::Null())

	~TreeBox () override

void	Add (Node *n)

void	AdjustColumnWidthToContents (int col)

bool	AreMultipleSelectionsDisabled () const

bool	AreMultipleSelectionsEnabled () const

Node *	Child (int idx)

const Node *	Child (int idx) const

int	ChildIndex (const Node *) const

void	Clear ()

int	ColumnWidth (int col) const

Node *	CurrentNode ()

const Node *	CurrentNode () const

void	DisableAlternateRowColor (bool disable=true)

void	DisableHeaderSorting (bool disable=true)

void	DisableMultipleSelections (bool disable=true)

void	DisableNodeDragging (bool disable=true)

void	DisableNodeExpansion (bool disable=true)

void	DisableRootDecoration (bool disable=true)

void	DisableUniformRowHeight (bool disable=true)

void	EnableAlternateRowColor (bool=true)

void	EnableHeaderSorting (bool=true)

void	EnableMultipleSelections (bool enable=true)

void	EnableNodeDragging (bool=true)

void	EnableNodeExpansion (bool=true)

void	EnableRootDecoration (bool=true)

void	EnableUniformRowHeight (bool=true)

void	GetIconSize (int &width, int &height) const

void	GetScaledIconSize (int &width, int &height) const

bool	HasSelectedTopLevelNodes () const

int	HeaderAlignment (int col) const

Bitmap	HeaderIcon (int col) const

String	HeaderText (int col) const

void	HideColumn (int col, bool hide=true)

void	HideHeader (bool hide=true)

int	IconHeight () const

int	IconWidth () const

int	IndentSize () const

void	Insert (int idx, Node *)

bool	IsAlternateRowColorEnabled () const

bool	IsColumnVisible (int col) const

bool	IsHeaderSortingEnabled () const

bool	IsHeaderVisible () const

bool	IsNodeDraggingEnabled () const

bool	IsNodeExpansionEnabled () const

bool	IsRootDecorationEnabled () const

bool	IsUniformRowHeightEnabled () const

Node *	NodeByPosition (const pcl::Point &p)

const Node *	NodeByPosition (const pcl::Point &p) const

Node *	NodeByPosition (int x, int y)

const Node *	NodeByPosition (int x, int y) const

pcl::Rect	NodeRect (const Node *) const

int	NumberOfChildren () const

int	NumberOfColumns () const

void	OnCurrentNodeUpdated (node_navigation_event_handler, Control &)

void	OnNodeActivated (node_event_handler, Control &)

void	OnNodeClicked (node_event_handler, Control &)

void	OnNodeCollapsed (node_expand_event_handler, Control &)

void	OnNodeDoubleClicked (node_event_handler, Control &)

void	OnNodeEntered (node_event_handler, Control &)

void	OnNodeExpanded (node_expand_event_handler, Control &)

void	OnNodeSelectionUpdated (tree_event_handler, Control &)

void	OnNodeUpdated (node_event_handler, Control &)

Node *	operator[] (int idx)

const Node *	operator[] (int idx) const

void	Remove (int idx)

int	ScaledColumnWidth (int col) const

int	ScaledIconHeight () const

int	ScaledIconWidth () const

int	ScaledIndentSize () const

void	SelectAllNodes ()

IndirectArray< Node >	SelectedNodes () const

void	SetColumnWidth (int col, int width)

void	SetCurrentNode (Node *)

void	SetHeaderAlignment (int col, int align)

void	SetHeaderIcon (int col, const Bitmap &)

void	SetHeaderText (int col, const String &)

void	SetIconSize (int size)

void	SetIconSize (int width, int height)

void	SetIndentSize (int)

void	SetNodeIntoView (Node *)

void	SetNumberOfColumns (int nCols)

void	SetScaledColumnWidth (int col, int width)

void	SetScaledIconSize (int size)

void	SetScaledIconSize (int width, int height)

void	SetScaledIndentSize (int size)

void	ShowColumn (int col, bool show=true)

void	ShowHeader (bool show=true)

void	Sort (int col=0, bool ascending=true)

Public Member Functions inherited from pcl::ScrollBox
	ScrollBox (Control &parent=Control::Null())

	~ScrollBox () override

void	DisableAutoScroll (bool disableHorz=true, bool disableVert=true)

void	DisableHorizontalTracking (bool disableHorz=true)

void	DisableTracking (bool disableHorz=true, bool disableVert=true)

void	DisableVerticalTracking (bool disableVert=true)

void	EnableAutoScroll (bool enableHorz=true, bool enableVert=true)

void	EnableHorizontalTracking (bool enableHorz=true)

void	EnableTracking (bool enableHorz=true, bool enableVert=true)

void	EnableVerticalTracking (bool enableVert=true)

void	GetHorizontalScrollRange (int &minPos, int &maxPos) const

void	GetVerticalScrollRange (int &minPos, int &maxPos) const

void	HideHorizontalScrollBar (bool hide=true)

void	HideScrollBars (bool hideHorz=true, bool hideVert=true)

void	HideVerticalScrollBar (bool hide=true)

int	HorizontalScrollPosition () const

bool	IsHorizontalAutoScrollEnabled () const

bool	IsHorizontalScrollBarVisible () const

bool	IsHorizontalTrackingEnabled () const

bool	IsVerticalAutoScrollEnabled () const

bool	IsVerticalScrollBarVisible () const

bool	IsVerticalTrackingEnabled () const

int	LineHeight () const

int	LineWidth () const

int	MaxHorizontalScrollPosition () const

int	MaxVerticalScrollPosition () const

int	MinHorizontalScrollPosition () const

int	MinVerticalScrollPosition () const

void	OnHorizontalScrollPosUpdated (pos_event_handler handler, Control &receiver)

void	OnHorizontalScrollRangeUpdated (range_event_handler handler, Control &receiver)

void	OnVerticalScrollPosUpdated (pos_event_handler handler, Control &receiver)

void	OnVerticalScrollRangeUpdated (range_event_handler handler, Control &receiver)

int	PageHeight () const

int	PageWidth () const

pcl::Point	ScrollPosition () const

void	SetHorizontalScrollPosition (int horzPos)

void	SetHorizontalScrollRange (int minPos, int maxPos)

void	SetLineHeight (int height)

void	SetLineSize (int width, int height)

void	SetLineWidth (int width)

void	SetPageHeight (int height)

void	SetPageSize (int width, int height)

void	SetPageWidth (int width)

void	SetScrollPosition (const pcl::Point &pos)

void	SetScrollPosition (int horzPos, int vertPos)

void	SetVerticalScrollPosition (int vertPos)

void	SetVerticalScrollRange (int minPos, int maxPos)

void	ShowHorizontalScrollBar (bool show=true)

void	ShowScrollBars (bool showHorz=true, bool showVert=true)

void	ShowVerticalScrollBar (bool show=true)

int	VerticalScrollPosition () const

Control &	Viewport ()

const Control &	Viewport () const

Public Member Functions inherited from pcl::Frame
	Frame (Control &parent=Control::Null())

	~Frame () override

int	BorderWidth () const

int	LineWidth () const

int	ScaledBorderWidth () const

int	ScaledLineWidth () const

void	SetLineWidth (int)

void	SetScaledLineWidth (int width)

void	SetStyle (style)

style	Style () const

Public Member Functions inherited from pcl::Control
	Control (const Control &)=delete

	Control (Control &&)=delete

	Control (Control &parent=Null(), uint32=0)

	~Control () override

void	ActivateRealTimePreview ()

void	ActivateTrackView ()

void	ActivateWindow ()

void	AdjustToContents ()

RGBA	AlternateCanvasColor () const

RGBA	BackgroundColor () const

pcl::Rect	BoundsRect () const

void	BringToFront ()

RGBA	ButtonColor () const

RGBA	ButtonTextColor () const

bool	CanUpdate () const

RGBA	CanvasColor ()

Control &	ChildByPos (const pcl::Point &p) const

Control &	ChildByPos (int x, int y) const

pcl::Rect	ChildrenRect () const

Control &	ChildToFocus () const

void	ClearInfoText ()

int	ClientHeight () const

pcl::Rect	ClientRect () const

int	ClientWidth () const

void	ControlToLocal (const Control &, int &x, int &y) const

pcl::Point	ControlToLocal (const Control &w, const pcl::Point &p) const

pcl::Cursor	Cursor () const

void	DeactivateRealTimePreview ()

void	DeactivateTrackView ()

void	Disable (bool disabled=true)

void	DisableExpansion (bool horzDisable=true, bool vertDisable=true)

void	DisableMouseTracking (bool disable=true)

void	DisableUpdates (bool disable=true)

double	DisplayPixelRatio () const

virtual void	Enable (bool enabled=true)

void	EnableExpansion (bool horzEnable=true, bool vertEnable=true)

void	EnableMouseTracking (bool=true)

void	EnableUpdates (bool enable=true)

void	EnsureLayoutUpdated ()

void	EnsureUnique () override

void	Focus (bool focus=true)

Control &	FocusedChild () const

FocusStyles	FocusStyle () const

pcl::Font	Font () const

RGBA	ForegroundColor () const

int	FrameHeight () const

pcl::Rect	FrameRect () const

int	FrameWidth () const

pcl::Cursor	GetCursor () const

pcl::Font	GetFont () const

void	GetMaxSize (int &w, int &h) const

void	GetMinSize (int &w, int &h) const

void	GetScaledMaxSize (int &w, int &h) const

void	GetScaledMinSize (int &w, int &h) const

pcl::Sizer	GetSizer () const

pcl::Point	GlobalToLocal (const pcl::Point &p) const

void	GlobalToLocal (int &x, int &y) const

int	Height () const

void	Hide ()

RGBA	HighlightColor () const

RGBA	HighlightedTextColor () const

String	InfoText () const

bool	IsActiveWindow () const

bool	IsAncestorOf (const Control &) const

virtual bool	IsEnabled () const

bool	IsFixedHeight () const

bool	IsFixedWidth () const

bool	IsFocused () const

bool	IsHidden () const

bool	IsHorizontalExpansionEnabled () const

bool	IsMaximized () const

bool	IsMinimized () const

bool	IsModal () const

bool	IsMouseTrackingEnabled () const

bool	IsRealTimePreviewActive () const

bool	IsTrackViewActive () const

bool	IsUnderMouse () const

bool	IsVerticalExpansionEnabled () const

bool	IsVisible () const

bool	IsWindow () const

void	LocalToControl (const Control &, int &x, int &y) const

pcl::Point	LocalToControl (const Control &w, const pcl::Point &p) const

pcl::Point	LocalToGlobal (const pcl::Point &p) const

void	LocalToGlobal (int &x, int &y) const

pcl::Point	LocalToParent (const pcl::Point &p) const

void	LocalToParent (int &x, int &y) const

int	LogicalPixelsToPhysical (int size) const

int	LogicalPixelsToResource (int size) const

int	MaxHeight () const

int	MaxWidth () const

int	MinHeight () const

int	MinWidth () const

void	Move (const pcl::Point &p)

void	Move (int x, int y)

Control &	NextSiblingToFocus () const

void	OnChildCreate (child_event_handler, Control &)

void	OnChildDestroy (child_event_handler, Control &)

void	OnClose (close_event_handler, Control &)

void	OnDestroy (event_handler, Control &)

void	OnEnter (event_handler, Control &)

void	OnFileDrag (file_drag_event_handler, Control &)

void	OnFileDrop (file_drop_event_handler, Control &)

void	OnGetFocus (event_handler, Control &)

void	OnHide (event_handler, Control &)

void	OnKeyPress (keyboard_event_handler, Control &)

void	OnKeyRelease (keyboard_event_handler, Control &)

void	OnLeave (event_handler, Control &)

void	OnLoseFocus (event_handler, Control &)

void	OnMouseDoubleClick (mouse_event_handler, Control &)

void	OnMouseMove (mouse_event_handler, Control &)

void	OnMousePress (mouse_button_event_handler, Control &)

void	OnMouseRelease (mouse_button_event_handler, Control &)

void	OnMouseWheel (mouse_wheel_event_handler, Control &)

void	OnMove (move_event_handler, Control &)

void	OnPaint (paint_event_handler, Control &)

void	OnResize (resize_event_handler, Control &)

void	OnShow (event_handler, Control &)

void	OnViewDrag (view_drag_event_handler, Control &)

void	OnViewDrop (view_drop_event_handler, Control &)

Control &	operator= (const Control &)=delete

Control &	operator= (Control &&)=delete

Control &	Parent () const

pcl::Point	ParentToLocal (const pcl::Point &p) const

void	ParentToLocal (int &x, int &y) const

int	PhysicalPixelsToLogical (int size) const

pcl::Point	Position () const

void	Repaint ()

void	Repaint (const pcl::Rect &r)

void	Repaint (int x0, int y0, int x1, int y1)

void	Resize (int w, int h)

double	ResourcePixelRatio () const

int	ResourcePixelsToLogical (int size) const

void	Restyle ()

Point	ScaledCursorHotSpot (const Point &hotSpot) const

Point	ScaledCursorHotSpot (int xHot, int yHot) const

int	ScaledMaxHeight () const

int	ScaledMaxWidth () const

int	ScaledMinHeight () const

int	ScaledMinWidth () const

template<class R >
String	ScaledResource (R resource) const

template<class S >
String	ScaledStyleSheet (S cssCode, int fontDPI=0) const

void	Scroll (const pcl::Point &d)

void	Scroll (const pcl::Point &d, const pcl::Rect &r)

void	Scroll (int dx, int dy)

void	Scroll (int dx, int dy, int x0, int y0, int x1, int y1)

void	SendToBack ()

void	SetAlternateCanvasColor (RGBA)

void	SetBackgroundColor (RGBA)

void	SetButtonColor (RGBA)

void	SetButtonTextColor (RGBA)

void	SetCanvasColor (RGBA)

void	SetChildToFocus (Control &)

void	SetClientRect (const pcl::Rect &r)

void	SetClientRect (int x0, int y0, int x1, int y1)

void	SetCursor (const pcl::Cursor &)

void	SetCursorToParent ()

void	SetFixedHeight ()

void	SetFixedHeight (int h)

void	SetFixedSize ()

void	SetFixedSize (int w, int h)

void	SetFixedWidth ()

void	SetFixedWidth (int w)

void	SetFocusStyle (FocusStyles)

void	SetFont (const pcl::Font &)

void	SetForegroundColor (RGBA)

void	SetHighlightColor (RGBA)

void	SetHighlightedTextColor (RGBA)

void	SetInfoText (const String &)

void	SetMaxHeight ()

void	SetMaxHeight (int h)

void	SetMaxSize ()

void	SetMaxSize (int w, int h)

void	SetMaxWidth ()

void	SetMaxWidth (int w)

void	SetMinHeight ()

void	SetMinHeight (int h)

void	SetMinSize ()

void	SetMinSize (int w, int h)

void	SetMinWidth ()

void	SetMinWidth (int w)

void	SetNextSiblingToFocus (Control &)

void	SetParent (Control &)

void	SetRealTimePreviewActive (bool=true)

void	SetScaledFixedHeight (int h)

void	SetScaledFixedSize (int w, int h)

void	SetScaledFixedWidth (int w)

void	SetScaledMaxHeight (int h)

void	SetScaledMaxSize (int w, int h)

void	SetScaledMaxWidth (int w)

void	SetScaledMinHeight (int h)

void	SetScaledMinSize (int w, int h)

void	SetScaledMinWidth (int w)

void	SetSizer (pcl::Sizer &)

void	SetStyleSheet (const String &css)

void	SetTextColor (RGBA)

void	SetToolTip (const String &)

void	SetTrackViewActive (bool=true)

void	SetVariableHeight ()

void	SetVariableSize ()

void	SetVariableWidth ()

void	SetVisible (bool visible)

void	SetWindowOpacity (double)

void	SetWindowTitle (const String &)

void	Show ()

pcl::Sizer	Sizer () const

void	StackUnder (Control &)

String	StyleSheet () const

RGBA	TextColor () const

String	ToolTip () const

void	Unfocus ()

void	Update ()

void	Update (const pcl::Rect &r)

void	Update (int x0, int y0, int x1, int y1)

pcl::Rect	VisibleRect () const

int	Width () const

Control &	Window () const

double	WindowOpacity () const

String	WindowTitle () const

int	X () const

int	Y () const

Public Member Functions inherited from pcl::UIObject
virtual	~UIObject () noexcept(false)

bool	IsAlias () const

bool	IsGarbage () const

bool	IsNull () const

bool	IsSameObject (const UIObject &o) const

bool	IsUnique () const

String	ObjectId () const

IsoString	ObjectType () const

bool	operator< (const UIObject &o) const

bool	operator== (const UIObject &o) const

size_type	RefCount () const

void	SetObjectId (const String &id)

Static Public Member Functions
static TreeBox &	NullTree ()

Static Public Member Functions inherited from pcl::Control
static void	HideToolTip ()

static Control &	Null ()

static void	ShowToolTip (const Point &pos, const String &text, const Control &control=Control::Null(), const Rect &rect=Rect(0))

static void	ShowToolTip (int x, int y, const String &text, const Control &control=Control::Null(), const Rect &rect=Rect(0))

static String	ToolTipText ()

Static Public Member Functions inherited from pcl::UIObject
static UIObject &	Null ()

Additional Inherited Members
Protected Member Functions inherited from pcl::UIObject
	UIObject ()=default

	UIObject (const UIObject &x)

	UIObject (UIObject &&x)

UIObject &	operator= (const UIObject &x)

UIObject &	operator= (UIObject &&x)

Detailed Description

TODO: Write a detailed description for TreeBox.

Definition at line 80 of file TreeBox.h.

Constructor & Destructor Documentation

◆ TreeBox()

pcl::TreeBox::TreeBox ( Control & parent = Control::Null() )

Constructs a TreeBox as a child control of parent.

◆ ~TreeBox()

pcl::TreeBox::~TreeBox ( )

override

Destroys a TreeBox control.

Member Function Documentation

◆ Add()

void pcl::TreeBox::Add ( Node * n )

inline

#

Definition at line 423 of file TreeBox.h.

◆ AdjustColumnWidthToContents()

void pcl::TreeBox::AdjustColumnWidthToContents ( int col )

#

◆ AreMultipleSelectionsDisabled()

bool pcl::TreeBox::AreMultipleSelectionsDisabled ( ) const

inline

#

Definition at line 458 of file TreeBox.h.

◆ AreMultipleSelectionsEnabled()

bool pcl::TreeBox::AreMultipleSelectionsEnabled ( ) const

#

◆ Child() [1/2]

Node* pcl::TreeBox::Child ( int idx )

#

◆ Child() [2/2]

const Node* pcl::TreeBox::Child ( int idx ) const

#

◆ ChildIndex()

int pcl::TreeBox::ChildIndex ( const Node * ) const

#

◆ Clear()

void pcl::TreeBox::Clear ( )

#

◆ ColumnWidth()

int pcl::TreeBox::ColumnWidth ( int col ) const

#

◆ CurrentNode() [1/2]

Node* pcl::TreeBox::CurrentNode ( )

#

◆ CurrentNode() [2/2]

const Node* pcl::TreeBox::CurrentNode ( ) const

#

◆ DisableAlternateRowColor()

void pcl::TreeBox::DisableAlternateRowColor ( bool disable = true )

inline

#

Definition at line 698 of file TreeBox.h.

◆ DisableHeaderSorting()

void pcl::TreeBox::DisableHeaderSorting ( bool disable = true )

inline

#

Definition at line 799 of file TreeBox.h.

◆ DisableMultipleSelections()

void pcl::TreeBox::DisableMultipleSelections ( bool disable = true )

inline

#

Definition at line 469 of file TreeBox.h.

◆ DisableNodeDragging()

void pcl::TreeBox::DisableNodeDragging ( bool disable = true )

inline

#

Definition at line 820 of file TreeBox.h.

◆ DisableNodeExpansion()

void pcl::TreeBox::DisableNodeExpansion ( bool disable = true )

inline

#

Definition at line 662 of file TreeBox.h.

◆ DisableRootDecoration()

void pcl::TreeBox::DisableRootDecoration ( bool disable = true )

inline

#

Definition at line 679 of file TreeBox.h.

◆ DisableUniformRowHeight()

void pcl::TreeBox::DisableUniformRowHeight ( bool disable = true )

inline

#

Definition at line 715 of file TreeBox.h.

◆ EnableAlternateRowColor()

void pcl::TreeBox::EnableAlternateRowColor ( bool = true )

#

◆ EnableHeaderSorting()

void pcl::TreeBox::EnableHeaderSorting ( bool = true )

#

◆ EnableMultipleSelections()

void pcl::TreeBox::EnableMultipleSelections ( bool enable = true )

#

◆ EnableNodeDragging()

void pcl::TreeBox::EnableNodeDragging ( bool = true )

#

◆ EnableNodeExpansion()

void pcl::TreeBox::EnableNodeExpansion ( bool = true )

#

◆ EnableRootDecoration()

void pcl::TreeBox::EnableRootDecoration ( bool = true )

#

◆ EnableUniformRowHeight()

void pcl::TreeBox::EnableUniformRowHeight ( bool = true )

#

◆ GetIconSize()

void pcl::TreeBox::GetIconSize	(	int &	width,
		int &	height
	)		const

#

◆ GetScaledIconSize()

void pcl::TreeBox::GetScaledIconSize	(	int &	width,
		int &	height
	)		const

inline

#

Definition at line 753 of file TreeBox.h.

◆ HasSelectedTopLevelNodes()

bool pcl::TreeBox::HasSelectedTopLevelNodes ( ) const

Returns true if this TreeBox object has one or more selected toplevel nodes; false if no toplevel nodes are selected.

◆ HeaderAlignment()

int pcl::TreeBox::HeaderAlignment ( int col ) const

#

◆ HeaderIcon()

Bitmap pcl::TreeBox::HeaderIcon ( int col ) const

#

◆ HeaderText()

String pcl::TreeBox::HeaderText ( int col ) const

#

◆ HideColumn()

void pcl::TreeBox::HideColumn	(	int	col,
		bool	hide = `true`
	)

inline

#

Definition at line 548 of file TreeBox.h.

◆ HideHeader()

void pcl::TreeBox::HideHeader ( bool hide = true )

inline

#

Definition at line 621 of file TreeBox.h.

◆ IconHeight()

int pcl::TreeBox::IconHeight ( ) const

inline

#

Definition at line 735 of file TreeBox.h.

◆ IconWidth()

int pcl::TreeBox::IconWidth ( ) const

inline

#

Definition at line 728 of file TreeBox.h.

◆ IndentSize()

int pcl::TreeBox::IndentSize ( ) const

#

◆ Insert()

void pcl::TreeBox::Insert	(	int	idx,
		Node *
	)

#

◆ IsAlternateRowColorEnabled()

bool pcl::TreeBox::IsAlternateRowColorEnabled ( ) const

#

◆ IsColumnVisible()

bool pcl::TreeBox::IsColumnVisible ( int col ) const

#

◆ IsHeaderSortingEnabled()

bool pcl::TreeBox::IsHeaderSortingEnabled ( ) const

#

◆ IsHeaderVisible()

bool pcl::TreeBox::IsHeaderVisible ( ) const

#

◆ IsNodeDraggingEnabled()

bool pcl::TreeBox::IsNodeDraggingEnabled ( ) const

#

◆ IsNodeExpansionEnabled()

bool pcl::TreeBox::IsNodeExpansionEnabled ( ) const

#

◆ IsRootDecorationEnabled()

bool pcl::TreeBox::IsRootDecorationEnabled ( ) const

#

◆ IsUniformRowHeightEnabled()

bool pcl::TreeBox::IsUniformRowHeightEnabled ( ) const

#

◆ NodeByPosition() [1/4]

Node* pcl::TreeBox::NodeByPosition ( const pcl::Point & p )

inline

#

Definition at line 505 of file TreeBox.h.

References pcl::GenericPoint< T >::x, and pcl::GenericPoint< T >::y.

◆ NodeByPosition() [2/4]

const Node* pcl::TreeBox::NodeByPosition ( const pcl::Point & p ) const

inline

#

Definition at line 498 of file TreeBox.h.

References pcl::GenericPoint< T >::x, and pcl::GenericPoint< T >::y.

◆ NodeByPosition() [3/4]

Node* pcl::TreeBox::NodeByPosition	(	int	x,
		int	y
	)

#

◆ NodeByPosition() [4/4]

const Node* pcl::TreeBox::NodeByPosition	(	int	x,
		int	y
	)		const

#

◆ NodeRect()

pcl::Rect pcl::TreeBox::NodeRect ( const Node * ) const

#

◆ NullTree()

static TreeBox& pcl::TreeBox::NullTree ( )

static

#

◆ NumberOfChildren()

int pcl::TreeBox::NumberOfChildren ( ) const

#

◆ NumberOfColumns()

int pcl::TreeBox::NumberOfColumns ( ) const

#

◆ operator[]() [1/2]

Node* pcl::TreeBox::operator[] ( int idx )

inline

#

Definition at line 408 of file TreeBox.h.

◆ operator[]() [2/2]

const Node* pcl::TreeBox::operator[] ( int idx ) const

inline

#

Definition at line 401 of file TreeBox.h.

◆ Remove()

void pcl::TreeBox::Remove ( int idx )

#

◆ ScaledColumnWidth()

int pcl::TreeBox::ScaledColumnWidth ( int col ) const

inline

#

Definition at line 565 of file TreeBox.h.

◆ ScaledIconHeight()

int pcl::TreeBox::ScaledIconHeight ( ) const

inline

#

Definition at line 767 of file TreeBox.h.

◆ ScaledIconWidth()

int pcl::TreeBox::ScaledIconWidth ( ) const

inline

#

Definition at line 760 of file TreeBox.h.

◆ ScaledIndentSize()

int pcl::TreeBox::ScaledIndentSize ( ) const

inline

#

Definition at line 638 of file TreeBox.h.

◆ SelectAllNodes()

void pcl::TreeBox::SelectAllNodes ( )

Selects all nodes in this tree, that is the entire TreeBox contents.

◆ SelectedNodes()

IndirectArray<Node> pcl::TreeBox::SelectedNodes ( ) const

Returns a dynamic array of pointers to all selected nodes in this tree. If this tree has no selected nodes, an empty array is returned.

The returned object is an instantiation of IndirectArray for the TreeBox::Node class: IndirectArray<TreeBox::Node>.

◆ SetColumnWidth()

void pcl::TreeBox::SetColumnWidth	(	int	col,
		int	width
	)

#

◆ SetCurrentNode()

void pcl::TreeBox::SetCurrentNode ( Node * )

#

◆ SetHeaderAlignment()

void pcl::TreeBox::SetHeaderAlignment	(	int	col,
		int	align
	)

#

◆ SetHeaderIcon()

void pcl::TreeBox::SetHeaderIcon	(	int	col,
		const Bitmap &
	)

#

◆ SetHeaderText()

void pcl::TreeBox::SetHeaderText	(	int	col,
		const String &
	)

#

◆ SetIconSize() [1/2]

void pcl::TreeBox::SetIconSize ( int size )

inline

#

Definition at line 746 of file TreeBox.h.

◆ SetIconSize() [2/2]

void pcl::TreeBox::SetIconSize	(	int	width,
		int	height
	)

#

◆ SetIndentSize()

void pcl::TreeBox::SetIndentSize ( int )

#

◆ SetNodeIntoView()

void pcl::TreeBox::SetNodeIntoView ( Node * )

#

◆ SetNumberOfColumns()

void pcl::TreeBox::SetNumberOfColumns ( int nCols )

#

◆ SetScaledColumnWidth()

void pcl::TreeBox::SetScaledColumnWidth	(	int	col,
		int	width
	)

inline

#

Definition at line 572 of file TreeBox.h.

◆ SetScaledIconSize() [1/2]

void pcl::TreeBox::SetScaledIconSize ( int size )

inline

#

Definition at line 781 of file TreeBox.h.

◆ SetScaledIconSize() [2/2]

void pcl::TreeBox::SetScaledIconSize	(	int	width,
		int	height
	)

inline

#

Definition at line 774 of file TreeBox.h.

◆ SetScaledIndentSize()

void pcl::TreeBox::SetScaledIndentSize ( int size )

inline

#

Definition at line 645 of file TreeBox.h.

◆ ShowColumn()

void pcl::TreeBox::ShowColumn	(	int	col,
		bool	show = `true`
	)

#

◆ ShowHeader()

void pcl::TreeBox::ShowHeader ( bool show = true )

#

◆ Sort()

void pcl::TreeBox::Sort	(	int	col = `0`,
		bool	ascending = `true`
	)

#

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

TreeBox.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

TODO: Write a detailed description for TreeBox.

Constructor & Destructor Documentation

◆ TreeBox()

◆ ~TreeBox()

Member Function Documentation

◆ Add()

◆ AdjustColumnWidthToContents()

◆ AreMultipleSelectionsDisabled()

◆ AreMultipleSelectionsEnabled()

◆ Child() [1/2]

◆ Child() [2/2]

◆ ChildIndex()

◆ Clear()

◆ ColumnWidth()

◆ CurrentNode() [1/2]

◆ CurrentNode() [2/2]

◆ DisableAlternateRowColor()

◆ DisableHeaderSorting()

◆ DisableMultipleSelections()

◆ DisableNodeDragging()

◆ DisableNodeExpansion()

◆ DisableRootDecoration()

◆ DisableUniformRowHeight()

◆ EnableAlternateRowColor()

◆ EnableHeaderSorting()

◆ EnableMultipleSelections()

◆ EnableNodeDragging()

◆ EnableNodeExpansion()

◆ EnableRootDecoration()

◆ EnableUniformRowHeight()

◆ GetIconSize()

◆ GetScaledIconSize()

◆ HasSelectedTopLevelNodes()

◆ HeaderAlignment()

◆ HeaderIcon()

◆ HeaderText()

◆ HideColumn()

◆ HideHeader()

◆ IconHeight()

◆ IconWidth()

◆ IndentSize()

◆ Insert()

◆ IsAlternateRowColorEnabled()

◆ IsColumnVisible()

◆ IsHeaderSortingEnabled()

◆ IsHeaderVisible()

◆ IsNodeDraggingEnabled()

◆ IsNodeExpansionEnabled()

◆ IsRootDecorationEnabled()

◆ IsUniformRowHeightEnabled()

◆ NodeByPosition() [1/4]

◆ NodeByPosition() [2/4]

◆ NodeByPosition() [3/4]

◆ NodeByPosition() [4/4]

◆ NodeRect()

◆ NullTree()

◆ NumberOfChildren()

◆ NumberOfColumns()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ Remove()

◆ ScaledColumnWidth()

◆ ScaledIconHeight()

◆ ScaledIconWidth()

◆ ScaledIndentSize()

◆ SelectAllNodes()

◆ SelectedNodes()

◆ SetColumnWidth()

◆ SetCurrentNode()

◆ SetHeaderAlignment()

◆ SetHeaderIcon()

◆ SetHeaderText()

◆ SetIconSize() [1/2]

◆ SetIconSize() [2/2]