pcl::TreeBox::Node Class Reference

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

#include <TreeBox.h>

Inheritance diagram for pcl::TreeBox::Node:

Public Member Functions
	Node ()
	Node (Node &parent, int index)
	Node (TreeBox &parent, int index=-1)
	~Node () override
void	Add (Node *node)
int	Alignment (int col) const
RGBA	BackgroundColor (int col) const
void	Check (bool=true)
Node *	Child (int idx)
const Node *	Child (int idx) const
int	ChildIndex (const Node *) const
void	Collapse (bool collapse=true)
void	Disable (bool disable=true)
void	Enable (bool=true)
void	Expand (bool expand=true)
pcl::Font	Font (int col) const
Bitmap	Icon (int col) const
void	Insert (int idx, Node *)
bool	IsCheckable () const
bool	IsChecked () const
bool	IsCollapsed () const
bool	IsEnabled () const
bool	IsExpanded () const
bool	IsSelectable () const
bool	IsSelected () const
int	NumberOfChildren () const
Node *	operator[] (int idx)
const Node *	operator[] (int idx) const
Node *	Parent ()
const Node *	Parent () const
TreeBox &	ParentTree ()
const TreeBox &	ParentTree () const
void	Remove (int idx)
void	Select (bool=true)
void	SetAlignment (int col, int align)
void	SetBackgroundColor (int col, RGBA)
void	SetCheckable (bool=true)
void	SetFont (int col, const pcl::Font &)
void	SetIcon (int col, const Bitmap &)
void	SetSelectable (bool=true)
void	SetText (int col, const String &)
void	SetTextColor (int col, RGBA)
void	SetToolTip (int col, const String &)
String	Text (int col) const
RGBA	TextColor (int col) const
String	ToolTip (int col) const
void	Uncheck (bool uncheck=true)
void	Unselect (bool unselect=true)
Public Member Functions inherited from pcl::UIObject
virtual	~UIObject () noexcept(false)
virtual void	EnsureUnique ()
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 Node	Null ()
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::Node.

Definition at line 90 of file TreeBox.h.

Constructor & Destructor Documentation

Node() [1/3]

pcl::TreeBox::Node::Node

(

)

Default constructor.

Node() [2/3]

pcl::TreeBox::Node::Node	(	Node &	parent,
		int	index
	)

Constructs a new TreeBox::Node child object of the specified parent node, inserted at the specified zero-based index.

Node() [3/3]

pcl::TreeBox::Node::Node	(	TreeBox &	parent,
		int	index = -1
	)

Constructs a new top-level TreeBox::Node child object of the specified parent tree, inserted at the specified zero-based index. If index is negative, the new node is appended to the current list of top-level child nodes of the parent tree.

~Node()

pcl::TreeBox::Node::~Node ( )

override

Destroys a TreeBox::Node object.

Member Function Documentation

Add()

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

inline

#

Definition at line 189 of file TreeBox.h.

Alignment()

int pcl::TreeBox::Node::Alignment

(

int

col

)

const

#

BackgroundColor()

RGBA pcl::TreeBox::Node::BackgroundColor

(

int

col

)

const

#

Check()

void pcl::TreeBox::Node::Check

(

bool

= true

)

#

Child() [1/2]

Node* pcl::TreeBox::Node::Child

(

int

idx

)

#

Child() [2/2]

const Node* pcl::TreeBox::Node::Child

(

int

idx

)

const

#

ChildIndex()

int pcl::TreeBox::Node::ChildIndex

(

const Node *

)

const

#

Collapse()

void pcl::TreeBox::Node::Collapse ( bool  collapse = true )

inline

#

Definition at line 230 of file TreeBox.h.

Disable()

void pcl::TreeBox::Node::Disable ( bool  disable = true )

inline

#

Definition at line 208 of file TreeBox.h.

Enable()

void pcl::TreeBox::Node::Enable

(

bool

= true

)

#

Expand()

void pcl::TreeBox::Node::Expand

(

bool

expand = true

)

#

Font()

pcl::Font pcl::TreeBox::Node::Font

(

int

col

)

const

#

Icon()

Bitmap pcl::TreeBox::Node::Icon

(

int

col

)

const

#

Insert()

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

#

IsCheckable()

bool pcl::TreeBox::Node::IsCheckable

(

)

const

#

IsChecked()

bool pcl::TreeBox::Node::IsChecked

(

)

const

#

IsCollapsed()

bool pcl::TreeBox::Node::IsCollapsed ( ) const

inline

#

Definition at line 219 of file TreeBox.h.

IsEnabled()

bool pcl::TreeBox::Node::IsEnabled

(

)

const

#

IsExpanded()

bool pcl::TreeBox::Node::IsExpanded

(

)

const

#

IsSelectable()

bool pcl::TreeBox::Node::IsSelectable

(

)

const

#

IsSelected()

bool pcl::TreeBox::Node::IsSelected

(

)

const

#

Null()

static Node pcl::TreeBox::Node::Null ( )

inlinestatic

#

Definition at line 131 of file TreeBox.h.

NumberOfChildren()

int pcl::TreeBox::Node::NumberOfChildren

(

)

const

#

operator[]() [1/2]

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

inline

#

Definition at line 174 of file TreeBox.h.

operator[]() [2/2]

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

inline

#

Definition at line 167 of file TreeBox.h.

Parent() [1/2]

Node* pcl::TreeBox::Node::Parent

(

)

#

Parent() [2/2]

const Node* pcl::TreeBox::Node::Parent

(

)

const

#

ParentTree() [1/2]

TreeBox& pcl::TreeBox::Node::ParentTree

(

)

#

ParentTree() [2/2]

const TreeBox& pcl::TreeBox::Node::ParentTree

(

)

const

#

Remove()

void pcl::TreeBox::Node::Remove

(

int

idx

)

#

Select()

void pcl::TreeBox::Node::Select

(

bool

= true

)

#

SetAlignment()

void pcl::TreeBox::Node::SetAlignment	(	int	col,
		int	align
	)

#

SetBackgroundColor()

void pcl::TreeBox::Node::SetBackgroundColor	(	int	col,
		RGBA
	)

#

SetCheckable()

void pcl::TreeBox::Node::SetCheckable

(

bool

= true

)

#

SetFont()

void pcl::TreeBox::Node::SetFont	(	int	col,
		const pcl::Font &
	)

#

SetIcon()

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

#

SetSelectable()

void pcl::TreeBox::Node::SetSelectable

(

bool

= true

)

#

SetText()

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

#

SetTextColor()

void pcl::TreeBox::Node::SetTextColor	(	int	col,
		RGBA
	)

#

SetToolTip()

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

#

Text()

String pcl::TreeBox::Node::Text

(

int

col

)

const

#

TextColor()

RGBA pcl::TreeBox::Node::TextColor

(

int

col

)

const

#

ToolTip()

String pcl::TreeBox::Node::ToolTip

(

int

col

)

const

#

Uncheck()

void pcl::TreeBox::Node::Uncheck ( bool  uncheck = true )

inline

#

Definition at line 276 of file TreeBox.h.

Unselect()

void pcl::TreeBox::Node::Unselect ( bool  unselect = true )

inline

#

Definition at line 253 of file TreeBox.h.

References pcl::Select().

---

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

• TreeBox.h