#include <ui_node_abstractscrollable.h>

Inheritance diagram for uiAbstractScrollableNode:

Collaboration diagram for uiAbstractScrollableNode:

Public Member Functions
void	initNode (uiNode_t *node) override
bool	isSizeChange (uiNode_t *node)
	return true if the node size change and update the cache
bool	scrollY (uiNode_t *node, int offset)
	Scroll the Y scroll with a relative position, and call event if need.
bool	setScrollY (uiNode_t *node, int viewPos, int viewSize, int fullSize)
	Set the Y scroll to a position, and call event if need.
void	pageUp (uiNode_t *node)
void	pageDown (uiNode_t *node)
void	moveUp (uiNode_t *node)
void	moveDown (uiNode_t *node)
void	moveHome (uiNode_t *node)
void	moveEnd (uiNode_t *node)
Public Member Functions inherited from uiLocatedNode
virtual void	draw (uiNode_t *node)
virtual void	drawTooltip (const uiNode_t *node, int x, int y) const
virtual void	drawOverWindow (uiNode_t *node)
virtual void	doLayout (uiNode_t *node)
	Call to update the node layout. This common code revalidates the node tree.
virtual void	onSizeChanged (uiNode_t *node)
	Callback stub.
virtual void	onLeftClick (uiNode_t *node, int x, int y)
virtual void	onRightClick (uiNode_t *node, int x, int y)
virtual void	onMiddleClick (uiNode_t *node, int x, int y)
virtual bool	onScroll (uiNode_t *node, int deltaX, int deltaY)
virtual void	onMouseMove (uiNode_t *node, int x, int y)
virtual void	onMouseDown (uiNode_t *node, int x, int y, int button)
virtual void	onMouseUp (uiNode_t *node, int x, int y, int button)
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	onCapturedMouseMove (uiNode_t *node, int x, int y)
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)
virtual int	getCellWidth (uiNode_t *node)
virtual int	getCellHeight (uiNode_t *node)
Public Member Functions inherited from uiNode
virtual void	onLoading (uiNode_t *node)
virtual void	onLoaded (uiNode_t *node)
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 35 of file ui_node_abstractscrollable.h.

Member Function Documentation

◆ initNode()

void uiAbstractScrollableNode::initNode ( uiNode_t * node )

overridevirtual

call to initialize the node structure and extradata structure

Reimplemented from uiNode.

Definition at line 130 of file ui_node_abstractscrollable.cpp.

References EXTRADATA, and uiNode::initNode().

◆ isSizeChange()

bool uiAbstractScrollableNode::isSizeChange ( uiNode_t * node )

return true if the node size change and update the cache

Todo: remove it, use property listener

Definition at line 47 of file ui_node_abstractscrollable.cpp.

References uiNode_t::box, EXTRADATA, uiBox_t::size, UI_Node_IsScrollableContainer(), Vector2Copy, and Vector2Equal.

Referenced by uiMaterialEditorNode::draw(), uiMessageListNode::draw(), uiText2Node::drawText(), uiTextListNode::drawText(), and uiTextNode::drawText().

◆ moveDown()

void uiAbstractScrollableNode::moveDown ( uiNode_t * node )

Definition at line 173 of file ui_node_abstractscrollable.cpp.

References EXTRADATA, scrollY(), and setScrollY().

Referenced by UI_AbstractScrollableNodeMoveDown(), and uiAbstractScrollableNode_t_movedown().

◆ moveEnd()

void uiAbstractScrollableNode::moveEnd ( uiNode_t * node )

Definition at line 179 of file ui_node_abstractscrollable.cpp.

References EXTRADATA, scrollY(), and setScrollY().

Referenced by UI_AbstractScrollableNodeMoveEnd(), and uiAbstractScrollableNode_t_moveend().

◆ moveHome()

void uiAbstractScrollableNode::moveHome ( uiNode_t * node )

Definition at line 176 of file ui_node_abstractscrollable.cpp.

References setScrollY().

Referenced by UI_AbstractScrollableNodeMoveHome(), and uiAbstractScrollableNode_t_movehome().

◆ moveUp()

void uiAbstractScrollableNode::moveUp ( uiNode_t * node )

Definition at line 170 of file ui_node_abstractscrollable.cpp.

References EXTRADATA, scrollY(), and setScrollY().

Referenced by UI_AbstractScrollableNodeMoveUp(), and uiAbstractScrollableNode_t_moveup().

◆ pageDown()

void uiAbstractScrollableNode::pageDown ( uiNode_t * node )

Definition at line 167 of file ui_node_abstractscrollable.cpp.

References EXTRADATA, scrollY(), and setScrollY().

Referenced by UI_AbstractScrollableNodePageDown(), and uiAbstractScrollableNode_t_pagedown().

◆ pageUp()

void uiAbstractScrollableNode::pageUp ( uiNode_t * node )

Definition at line 163 of file ui_node_abstractscrollable.cpp.

References EXTRADATA, and setScrollY().

Referenced by UI_AbstractScrollableNodePageUp(), and uiAbstractScrollableNode_t_pageup().

◆ scrollY()

bool uiAbstractScrollableNode::scrollY	(	uiNode_t *	node,
		int	offset )

Scroll the Y scroll with a relative position, and call event if need.

Returns: true, if something have change

Definition at line 229 of file ui_node_abstractscrollable.cpp.

References EXTRADATA, scrollY(), setScrollY(), and UI_Node_IsScrollableContainer().

Referenced by uiMaterialEditorNode::draw(), uiMessageListNode::draw(), moveDown(), moveEnd(), moveUp(), uiMessageListNode::onCapturedMouseMove(), uiPanelNode::onCapturedMouseMove(), uiTextNode::onCapturedMouseMove(), uiMessageListNode::onMouseDown(), uiMaterialEditorNode::onScroll(), uiMessageListNode::onScroll(), uiTextNode::onScroll(), pageDown(), and scrollY().

◆ setScrollY()

bool uiAbstractScrollableNode::setScrollY	(	uiNode_t *	node,
		int	viewPos,
		int	viewSize,
		int	fullSize )

Set the Y scroll to a position, and call event if need.

Parameters

[in]	node	Context node
[in]	viewPos	New position to set, else -1 if no change
[in]	viewSize	New view size to set, else -1 if no change
[in]	fullSize	New full size to set, else -1 if no change