CtrlTree Class Reference

Class for control tree. More...

Inheritance diagram for CtrlTree:

[legend]

Collaboration diagram for CtrlTree:

[legend]

Public Member Functions
	CtrlTree (intf_thread_t *pIntf, VarTree &rTree, const GenericFont &rFont, const GenericBitmap *pBgBitmap, const GenericBitmap *pItemBitmap, const GenericBitmap *pOpenBitmap, const GenericBitmap *pClosedBitmap, uint32_t fgColor, uint32_t playColor, uint32_t bgColor1, uint32_t bgColor2, uint32_t selColor, const UString &rHelp, VarBool *pVisible, VarBool *pFlat)
virtual	~CtrlTree ()
virtual void	handleEvent (EvtGeneric &rEvent)
	Handle an event on the control.
virtual bool	mouseOver (int x, int y) const
	Check whether coordinates are inside the control.
virtual void	draw (OSGraphics &rImage, int xDest, int yDest)
	Draw the control on the given graphics.
virtual void	onResize ()
	Called when the layout is resized.
virtual bool	isFocusable () const
	Return true if the control can gain the focus.
virtual string	getType () const
	Get the type of control (custom RTTI).
bool	ensureVisible (VarTree::Iterator item)
	Make sure an item is visible.
bool	ensureVisible (int itemIndex)
	Make sure an item is visible.

---

Detailed Description

Class for control tree.

---

Constructor & Destructor Documentation

CtrlTree::CtrlTree	(	intf_thread_t *	pIntf,
		VarTree &	rTree,
		const GenericFont &	rFont,
		const GenericBitmap *	pBgBitmap,
		const GenericBitmap *	pItemBitmap,
		const GenericBitmap *	pOpenBitmap,
		const GenericBitmap *	pClosedBitmap,
		uint32_t	fgColor,
		uint32_t	playColor,
		uint32_t	bgColor1,
		uint32_t	bgColor2,
		uint32_t	selColor,
		const UString &	rHelp,
		VarBool *	pVisible,
		VarBool *	pFlat
	)

References Subject< S, ARG >::addObserver(), VarTree::begin(), VarTree::firstLeaf(), VarBool::get(), and VarTree::getPositionVar().

CtrlTree::~CtrlTree

(

)

[virtual]

References Subject< S, ARG >::delObserver(), and VarTree::getPositionVar().

---

Member Function Documentation

void CtrlTree::handleEvent

(

EvtGeneric &

rEvent

)

[virtual]

Handle an event on the control.

Reimplemented from CtrlGeneric.

References VarTree::action(), VarTree::begin(), VarTree::countLeafs(), VarTree::delSelected(), VarTree::end(), ensureVisible(), VarTree::firstLeaf(), VarPercent::get(), EvtGeneric::getAsString(), SkinObject::getIntf(), Position::getLeft(), EvtKey::getModKey(), VarTree::getNextLeaf(), VarTree::getNextVisibleItem(), CtrlGeneric::getPosition(), VarTree::getPositionVar(), VarTree::getPrevLeaf(), VarTree::getPrevVisibleItem(), Position::getTop(), EvtMouse::getXPos(), EvtMouse::getYPos(), i, KEY_DELETE, KEY_DOWN, KEY_ENTER, KEY_LEFT, KEY_PAGEDOWN, KEY_PAGEUP, KEY_RIGHT, KEY_UP, EvtScroll::kUp, VarTree::m_selected, next(), CtrlGeneric::notifyLayout(), VarTree::parent(), VarPercent::set(), var_SetInteger, and VarTree::visibleItems().

bool CtrlTree::mouseOver	(	int	x,
		int	y
	)			const [virtual]

Check whether coordinates are inside the control.

Reimplemented from CtrlGeneric.

References Position::getHeight(), CtrlGeneric::getPosition(), and Position::getWidth().

void CtrlTree::draw	(	OSGraphics &	rImage,
		int	xDest,
		int	yDest
	)			[virtual]

Draw the control on the given graphics.

Reimplemented from CtrlGeneric.

References OSGraphics::drawGraphics().

void CtrlTree::onResize

(

)

[virtual]

Called when the layout is resized.

Reimplemented from CtrlGeneric.

References VarTree::begin(), VarTree::countLeafs(), VarTree::firstLeaf(), VarPercent::get(), VarTree::getLeaf(), VarTree::getPositionVar(), VarTree::getVisibleItem(), and VarTree::visibleItems().

virtual bool CtrlTree::isFocusable

(

)

const [inline, virtual]

Return true if the control can gain the focus.

Reimplemented from CtrlGeneric.

virtual string CtrlTree::getType

(

)

const [inline, virtual]

Get the type of control (custom RTTI).

Reimplemented from CtrlGeneric.

bool CtrlTree::ensureVisible

(

VarTree::Iterator

item

)

Make sure an item is visible.

Parameters:

item

an iterator to a tree item

Returns:

true if it changed the position

References VarTree::begin(), VarTree::end(), VarTree::ensureExpanded(), VarTree::firstLeaf(), VarTree::getNextLeaf(), and VarTree::getNextVisibleItem().

Referenced by handleEvent().

bool CtrlTree::ensureVisible

(

int

itemIndex

)

Make sure an item is visible.

Parameters:

itemIndex

the absolute index in the tree

Returns:

true if it changed the position

References VarTree::begin(), VarTree::countLeafs(), VarTree::end(), VarTree::firstLeaf(), VarTree::getNextLeaf(), VarTree::getNextVisibleItem(), VarTree::getPositionVar(), VarPercent::set(), and VarTree::visibleItems().

---

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

• modules/gui/skins2/controls/ctrl_tree.hpp
• modules/gui/skins2/controls/ctrl_tree.cpp