#include <ui_node_optiontree.h>

Inheritance diagram for uiOptionTreeNode:

Collaboration diagram for uiOptionTreeNode:

Private Member Functions
void	draw (uiNode_t *node) override
void	onLeftClick (uiNode_t *node, int x, int y) override
	Handles selectboxes clicks.
bool	onScroll (uiNode_t *node, int deltaX, int deltaY) override
	Auto scroll the list.
void	onMouseDown (uiNode_t *node, int x, int y, int button) override
	Track mouse down/up events to implement drag&drop-like scrolling, for touchscreen devices.
void	onMouseUp (uiNode_t *node, int x, int y, int button) override
void	onCapturedMouseMove (uiNode_t *node, int x, int y) override
void	onLoading (uiNode_t *node) override
	Called before loading. Used to set default attribute values.
void	onLoaded (uiNode_t *node) override
int	getCellHeight (uiNode_t *node) override
	Return size of the cell, which is the size (in virtual "pixel") which represent 1 in the scroll values. Here we guess the widget can scroll pixel per pixel.
void	doLayout (uiNode_t *node) override
	Call to update the node layout. This common code revalidates the node tree.

Additional Inherited Members
Public Member Functions inherited from uiAbstractOptionNode
void	initNode (uiNode_t *node) override
int	getCellWidth (uiNode_t *node) override
	Return size of the cell, which is the size (in virtual "pixel") which represents 1 in the scroll values. Here expect the widget can scroll pixel per pixel.
Public Member Functions inherited from uiLocatedNode
virtual void	drawTooltip (const uiNode_t *node, int x, int y) const
virtual void	drawOverWindow (uiNode_t *node)
virtual void	onSizeChanged (uiNode_t *node)
	Callback stub.
virtual void	onRightClick (uiNode_t *node, int x, int y)
virtual void	onMiddleClick (uiNode_t *node, int x, int y)
virtual void	onMouseMove (uiNode_t *node, int x, int y)
virtual bool	onMouseLongPress (uiNode_t *node, int x, int y, int button)
	Send mouse event when a pressed mouse button is dragged.
virtual void	onMouseEnter (uiNode_t *node)
virtual void	onMouseLeave (uiNode_t *node)
virtual void	onCapturedMouseLost (uiNode_t *node)
virtual bool	onStartDragging (uiNode_t *node, int startX, int startY, int currentX, int currentY, int button)
	Send mouse event when a pressed mouse button is dragged.
virtual bool	onDndEnter (uiNode_t *node)
virtual bool	onDndMove (uiNode_t *node, int x, int y)
virtual void	onDndLeave (uiNode_t *node)
virtual bool	onDndDrop (uiNode_t *node, int x, int y)
virtual bool	onDndFinished (uiNode_t *node, bool isDropped)
virtual void	onFocusGained (uiNode_t *node)
virtual void	onFocusLost (uiNode_t *node)
virtual bool	onKeyPressed (uiNode_t *node, unsigned int key, unsigned short unicode)
virtual bool	onKeyReleased (uiNode_t *node, unsigned int key, unsigned short unicode)
virtual void	getClientPosition (uiNode_t const *node, vec2_t position)
Public Member Functions inherited from uiNode
virtual void	clone (uiNode_t const source, uiNode_t clone)
virtual void	initNodeDynamic (uiNode_t *node)
virtual void	deleteNode (uiNode_t *node)
virtual void	onWindowOpened (uiNode_t node, linkedList_t params)
virtual void	onWindowClosed (uiNode_t *node)
virtual void	onWindowActivate (uiNode_t *node)
virtual void	onActivate (uiNode_t *node)
	Activate the node. Can be used without the mouse (ie. a button will execute onClick).
virtual void	onPropertyChanged (uiNode_t node, const value_t property)
virtual	~uiNode ()

Detailed Description

Definition at line 29 of file ui_node_optiontree.h.

Member Function Documentation

◆ doLayout()

void uiOptionTreeNode::doLayout ( uiNode_t * node )

overrideprivatevirtual

Call to update the node layout. This common code revalidates the node tree.

Called to update node layout

Reimplemented from uiAbstractOptionNode.

Definition at line 377 of file ui_node_optiontree.cpp.

References uiNode_t::invalidated, and UI_OptionTreeNodeUpdateCache().

◆ draw()

void uiOptionTreeNode::draw ( uiNode_t * node )

overrideprivatevirtual

How to draw a node

Reimplemented from uiLocatedNode.

Definition at line 120 of file ui_node_optiontree.cpp.

References ALIGN_UL, uiNode_t::box, CL_Translate(), COLLAPSEBUTTON_WIDTH, uiNode_t::color, count, DEPTH_WIDTH, uiOptionIterator_t::depthPos, uiNode_t::disabled, uiNode_t::disabledColor, EXTRADATA, uiNode_t::firstChild, LONGLINES_PRETTYCHOP, OPTIONEXTRADATA, uiNode_t::padding, Q_streq, R_Color(), uiNode_t::selectedColor, uiBox_t::size, uiSprite_t::size, SPRITE_STATUS_DISABLED, SPRITE_STATUS_NORMAL, systemCollapse, systemExpand, UI_AbstractOption_GetCurrentValue(), UI_DrawFill(), UI_DrawSpriteInBox(), UI_DrawString(), UI_FontGetHeight(), UI_GetFontFromNode(), UI_GetNodeAbsPos(), UI_GetSpriteByName(), UI_InitOptionIteratorAtIndex(), UI_OptionIteratorNextOption(), UI_OptionTreeNodeGetFirstOption(), and UI_OptionTreeNodeUpdateScroll().

◆ getCellHeight()

int uiOptionTreeNode::getCellHeight ( uiNode_t * node )

overrideprivatevirtual

Return size of the cell, which is the size (in virtual "pixel") which represent 1 in the scroll values. Here we guess the widget can scroll pixel per pixel.

Returns: Size in pixel.

Reimplemented from uiAbstractOptionNode.

Definition at line 431 of file ui_node_optiontree.cpp.

References EXTRADATA, UI_FontGetHeight(), and UI_GetFontFromNode().

Referenced by onCapturedMouseMove().

◆ onCapturedMouseMove()

void uiOptionTreeNode::onCapturedMouseMove	(	uiNode_t *	node,
		int	x,
		int	y )

overrideprivatevirtual

Mouse move event in the node when captured

Reimplemented from uiLocatedNode.

Definition at line 403 of file ui_node_optiontree.cpp.

References EXTRADATA, getCellHeight(), mouseScrollX, mouseScrollY, uiLocatedNode::onMouseMove(), UI_ExecuteEventActions(), and UI_ExecuteLuaEventScript().

◆ onLeftClick()

void uiOptionTreeNode::onLeftClick	(	uiNode_t *	node,
		int	x,
		int	y )

overrideprivatevirtual

Handles selectboxes clicks.

Reimplemented from uiLocatedNode.

Definition at line 247 of file ui_node_optiontree.cpp.

References COLLAPSEBUTTON_WIDTH, DEPTH_WIDTH, uiNode_t::firstChild, OPTIONEXTRADATA, UI_AbstractOption_GetCurrentValue(), UI_AbstractOption_SetCurrentValue(), UI_NodeAbsoluteToRelativePos(), UI_OptionTreeNodeGetOptionAtPosition(), and UI_OptionTreeNodeUpdateCache().

◆ onLoaded()

void uiOptionTreeNode::onLoaded ( uiNode_t * node )

overrideprivatevirtual

only called one time, when node parsing was finished

Reimplemented from uiNode.

Definition at line 320 of file ui_node_optiontree.cpp.

◆ onLoading()

void uiOptionTreeNode::onLoading ( uiNode_t * node )

overrideprivatevirtual

Called before loading. Used to set default attribute values.

Reimplemented from uiNode.

Definition at line 312 of file ui_node_optiontree.cpp.

References uiNode_t::color, uiNode_t::disabledColor, EXTRADATA, uiNode_t::padding, and Vector4Set.

◆ onMouseDown()

void uiOptionTreeNode::onMouseDown	(	uiNode_t *	node,
		int	x,
		int	y,
		int	button )

overrideprivatevirtual

Track mouse down/up events to implement drag&drop-like scrolling, for touchscreen devices.

See also: UI_OptionTreeNodeMouseUp, UI_OptionTreeNodeCapturedMouseMove

Reimplemented from uiLocatedNode.

Definition at line 387 of file ui_node_optiontree.cpp.

References EXTRADATA, K_MOUSE1, mouseScrollX, mouseScrollY, UI_GetMouseCapture(), and UI_SetMouseCapture().

◆ onMouseUp()

void uiOptionTreeNode::onMouseUp	(	uiNode_t *	node,
		int	x,
		int	y,
		int	button )

overrideprivatevirtual

Mouse button up event in the node

Reimplemented from uiLocatedNode.

Definition at line 397 of file ui_node_optiontree.cpp.

References UI_GetMouseCapture(), and UI_MouseRelease().

◆ onScroll()

bool uiOptionTreeNode::onScroll	(	uiNode_t *	node,
		int	deltaX,
		int	deltaY )

overrideprivatevirtual

Auto scroll the list.

Reimplemented from uiLocatedNode.

Definition at line 278 of file ui_node_optiontree.cpp.

References down, EXTRADATA, uiNode_t::onWheel, uiNode_t::onWheelDown, uiNode_t::onWheelUp, UI_ExecuteEventActions(), and UI_ExecuteLuaEventScript().

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

src/client/ui/node/ui_node_optiontree.h
src/client/ui/node/ui_node_optiontree.cpp

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ doLayout()

◆ draw()

◆ getCellHeight()

◆ onCapturedMouseMove()

◆ onLeftClick()

◆ onLoaded()

◆ onLoading()

◆ onMouseDown()

◆ onMouseUp()

◆ onScroll()