ui_node_abstractscrollable.h File Reference

base code for scrollable node More...

#include "../../../shared/mathlib.h"

Include dependency graph for ui_node_abstractscrollable.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	uiScroll_t
	Scroll representation. More...
struct	abstractScrollableExtraData_t
Functions
qboolean	UI_SetScroll (uiScroll_t *scroll, int viewPos, int viewSize, int fullSize)
	Set the scroll to a position.
qboolean	UI_AbstractScrollableNodeIsSizeChange (struct uiNode_s *node)
	return true if the node size change and update the cache
qboolean	UI_AbstractScrollableNodeScrollY (struct uiNode_s *node, int offset)
	Scroll the Y scroll with a relative position, and call event if need.
qboolean	UI_AbstractScrollableNodeSetY (struct uiNode_s *node, int viewPos, int viewSize, int fullSize)
	Set the Y scroll to a position, and call event if need.
void	UI_RegisterAbstractScrollableNode (struct uiBehaviour_s *behaviour)

---

Detailed Description

base code for scrollable node

Definition in file ui_node_abstractscrollable.h.

---

Function Documentation

qboolean UI_AbstractScrollableNodeIsSizeChange

(

struct uiNode_s *

node

)

return true if the node size change and update the cache

Definition at line 42 of file ui_node_abstractscrollable.c.

References EXTRADATA, qfalse, qtrue, uiNode_s::size, and UI_NodeInstanceOf().

Referenced by UI_MaterialEditorNodeDraw(), UI_MessageListNodeDraw(), UI_TextLineNodeDrawText(), and UI_TextNodeDrawText().

qboolean UI_AbstractScrollableNodeScrollY	(	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 163 of file ui_node_abstractscrollable.c.

References EXTRADATA, UI_AbstractScrollableNodeSetY(), and UI_NodeInstanceOf().

Referenced by UI_MaterialEditorNodeWheel(), UI_MessageListNodeMouseWheel(), UI_TextListNodeMouseWheel(), and UI_TextNodeMouseWheel().

qboolean UI_AbstractScrollableNodeSetY	(	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 115 of file ui_node_abstractscrollable.c.

References EXTRADATA, UI_ExecuteEventActions(), UI_NodeInstanceOf(), and UI_SetScroll().

Referenced by UI_AbstractScrollableNodeMoveDown(), UI_AbstractScrollableNodeMoveEnd(), UI_AbstractScrollableNodeMoveHome(), UI_AbstractScrollableNodeMoveUp(), UI_AbstractScrollableNodePageDown(), UI_AbstractScrollableNodePageUp(), UI_AbstractScrollableNodeScrollY(), UI_MaterialEditorNodeUpdateView(), UI_MessageListNodeDraw(), UI_TextLineNodeDrawText(), and UI_TextNodeDrawText().

void UI_RegisterAbstractScrollableNode

(

struct uiBehaviour_s *

behaviour

)

Definition at line 195 of file ui_node_abstractscrollable.c.

References EXTRADATA_TYPE, uiBehaviour_s::extraDataSize, uiBehaviour_s::isAbstract, uiBehaviour_s::name, uiBehaviour_s::properties, and qtrue.

qboolean UI_SetScroll	(	uiScroll_t *	scroll,
		int	viewPos,
		int	viewSize,
		int	fullSize
	)

Set the scroll to a position.

Parameters:

[in]	scroll	scroll to edit
[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 64 of file ui_node_abstractscrollable.c.

References uiScroll_t::fullSize, qfalse, qtrue, uiScroll_t::viewPos, and uiScroll_t::viewSize.

Referenced by UI_AbstractScrollableNodeSetY(), UI_ClientLayout(), UI_ColumnLayout(), UI_OptionListNodeMouseWheel(), UI_OptionListNodeUpdateScroll(), UI_OptionTreeNodeMouseWheel(), UI_OptionTreeNodeUpdateScroll(), and UI_OptionTreeSetSelectedValue().