ui_node_spinner.cpp File Reference

The spinner node is a vertical widget used to change a value. More...

#include "../ui_nodes.h"
#include "../ui_parse.h"
#include "../ui_behaviour.h"
#include "../ui_main.h"
#include "../ui_input.h"
#include "../ui_timer.h"
#include "../ui_actions.h"
#include "../ui_render.h"
#include "../ui_sprite.h"
#include "ui_node_spinner.h"
#include "ui_node_abstractnode.h"
#include "../../input/cl_input.h"
#include "../../input/cl_keys.h"
#include "../../../common/scripts_lua.h"

Include dependency graph for ui_node_spinner.cpp:

Go to the source code of this file.

Macros
#define	EXTRADATA_TYPE   spinnerExtraData_t
#define	EXTRADATA(node)
#define	EXTRADATACONST(node)

Functions
static void	UI_SpinnerNodeRepeat (uiNode_t *node, uiTimer_t *timer)
void	UI_Spinner_SetBackgroundByName (uiNode_t *node, const char *name)
void	UI_Spinner_SetBottomIconByName (uiNode_t *node, const char *name)
void	UI_Spinner_SetTopIconByName (uiNode_t *node, const char *name)
void	UI_RegisterSpinnerNode (uiBehaviour_t *behaviour)

Variables
static bool	capturedDownButton
static uiTimer_t *	capturedTimer = nullptr

Detailed Description

The spinner node is a vertical widget used to change a value.

Definition in file ui_node_spinner.cpp.

Macro Definition Documentation

EXTRADATA

#define EXTRADATA

(

node

)

Value:

UI_EXTRADATA(node, EXTRADATA_TYPE)

Definition at line 44 of file ui_node_spinner.cpp.

EXTRADATA_TYPE

#define EXTRADATA_TYPE   spinnerExtraData_t

Definition at line 43 of file ui_node_spinner.cpp.

EXTRADATACONST

#define EXTRADATACONST

(

node

)

Value:

UI_EXTRADATACONST(node, EXTRADATA_TYPE)

Definition at line 45 of file ui_node_spinner.cpp.

Function Documentation

UI_RegisterSpinnerNode()

void UI_RegisterSpinnerNode

(

uiBehaviour_t *

behaviour

)

Background used to display the spinner. It is displayed in the center of the node.

Top icon used to decorate the top button of the spinner. It is displayed in the center of the node.

Sprite used to decorate the bottom button of the spinner. It is displayed in the center of the node.

Spinner mode allow to change the input action of the spinner. SPINNER_NORMAL is the default mode. With SPINNER_ONLY_INC anywhere it click on the node it will increase the value. With SPINNER_ONLY_DEC anywhere it click on the node it will decrease the value.

Draw images in horizontal orientation, also change active touch area for images.

Invert spinner directions, so that down/left will increase value, up/right will decrease it.

Definition at line 240 of file ui_node_spinner.cpp.

References Com_RegisterConstInt(), uiBehaviour_t::extends, EXTRADATA_TYPE, uiBehaviour_t::extraDataSize, uiBehaviour_t::lua_SWIG_typeinfo, uiBehaviour_t::manager, uiBehaviour_t::name, SPINNER_NORMAL, SPINNER_ONLY_DECREASE, SPINNER_ONLY_INCREASE, UI_RegisterExtradataNodeProperty, UI_SWIG_TypeQuery(), V_BOOL, V_INT, and V_UI_SPRITEREF.

UI_Spinner_SetBackgroundByName()

void UI_Spinner_SetBackgroundByName	(	uiNode_t *	node,
		const char *	name )

Definition at line 224 of file ui_node_spinner.cpp.

References name, UI_EXTRADATA, and UI_GetSpriteByName().

Referenced by uiSpinnerNode_t_set_background().

UI_Spinner_SetBottomIconByName()

void UI_Spinner_SetBottomIconByName	(	uiNode_t *	node,
		const char *	name )

Definition at line 229 of file ui_node_spinner.cpp.

References name, UI_EXTRADATA, and UI_GetSpriteByName().

Referenced by uiSpinnerNode_t_set_bottomicon().

UI_Spinner_SetTopIconByName()

void UI_Spinner_SetTopIconByName	(	uiNode_t *	node,
		const char *	name )

Definition at line 234 of file ui_node_spinner.cpp.

References name, UI_EXTRADATA, and UI_GetSpriteByName().

Referenced by uiSpinnerNode_t_set_topicon().

UI_SpinnerNodeRepeat()

void UI_SpinnerNodeRepeat ( uiNode_t * node, uiTimer_t * timer )

static

Definition at line 72 of file ui_node_spinner.cpp.

References uiNode_t::behaviour, SharedPtr< T >::get(), uiBehaviour_t::manager, and uiSpinnerNode::repeat().

Referenced by uiSpinnerNode::onMouseDown().

Variable Documentation

capturedDownButton

bool capturedDownButton

static

Definition at line 47 of file ui_node_spinner.cpp.

Referenced by uiSpinnerNode::onMouseDown(), and uiSpinnerNode::repeat().

capturedTimer

uiTimer_t* capturedTimer = nullptr

static

Definition at line 48 of file ui_node_spinner.cpp.

Referenced by uiSpinnerNode::onCapturedMouseLost(), uiVScrollbarNode::onCapturedMouseLost(), uiZoneNode::onCapturedMouseLost(), uiSpinnerNode::onMouseDown(), uiZoneNode::onMouseDown(), and UI_VScrollbarNodeAction().