#include <ui_node_abstractscrollable.h>

Inherited by uiMaterialEditorNode, uiMessageListNode, uiPanelNode, and uiTextNode.

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 More...

bool	scrollY (uiNode_t *node, int offset)
	Scroll the Y scroll with a relative position, and call event if need. More...

bool	setScrollY (uiNode_t *node, int viewPos, int viewSize, int fullSize)
	Set the Y scroll to a position, and call event if need. More...

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. More...

virtual void	onSizeChanged (uiNode_t *node)
	Callback stub. More...

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. More...

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. More...

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) More...

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

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().

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(), uiTextListNode::drawText(), uiText2Node::drawText(), and uiTextNode::drawText().

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().

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().

void uiAbstractScrollableNode::moveHome ( uiNode_t * node )

Definition at line 176 of file ui_node_abstractscrollable.cpp.

References setScrollY().

Referenced by UI_AbstractScrollableNodeMoveHome().

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().

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().

void uiAbstractScrollableNode::pageUp ( uiNode_t * node )

Definition at line 163 of file ui_node_abstractscrollable.cpp.

References EXTRADATA, and setScrollY().

Referenced by UI_AbstractScrollableNodePageUp().

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, setScrollY(), and UI_Node_IsScrollableContainer().

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

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

Returns: True, if something have change

Definition at line 143 of file ui_node_abstractscrollable.cpp.

References EXTRADATA, UI_ExecuteEventActions(), UI_ExecuteLuaEventScript(), and UI_Node_IsScrollableContainer().

Referenced by uiMessageListNode::draw(), uiTextListNode::drawText(), uiText2Node::drawText(), uiTextNode::drawText(), moveDown(), moveEnd(), moveHome(), moveUp(), pageDown(), pageUp(), scrollY(), and uiMaterialEditorNode::updateView().

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

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

Public Member Functions

Detailed Description

Member Function Documentation