ui_node_radiobutton.cpp File Reference

The radiobutton is a clickable widget. Commonly, with use it in a group of radiobuttons; the user is allowed to choose only one button from this set. The current implementation share the value of the group with a cvar, and each button use is own value. When the cvar equals to a button value, this button is selected. More...

#include "../ui_main.h"
#include "../ui_actions.h"
#include "../ui_sprite.h"
#include "../ui_parse.h"
#include "../ui_behaviour.h"
#include "../ui_input.h"
#include "../ui_render.h"
#include "../ui_lua.h"
#include "ui_node_radiobutton.h"
#include "ui_node_abstractnode.h"
#include "../../../common/scripts_lua.h"

Include dependency graph for ui_node_radiobutton.cpp:

Go to the source code of this file.

Macros
#define	EXTRADATA_TYPE   radioButtonExtraData_t
#define	EXTRADATA(node)
#define	EXTRADATACONST(node)
#define	EPSILON   0.001f
#define	UI_4STATUS_TEX_HEIGHT   64

Functions
static bool	UI_RadioButtonNodeIsSelected (uiNode_t *node)
const char *	UI_RadioButton_GetCvar (uiNode_t *node)
void	UI_RadioButton_SetCvar (uiNode_t *node, const char *name)
void	UI_RadioButton_SetValue (uiNode_t *node, const char *value)
void	UI_RadioButton_SetValue (uiNode_t *node, float value)
void	UI_RadioButton_SetBackgroundByName (uiNode_t *node, const char *name)
void	UI_RadioButton_SetIconByName (uiNode_t *node, const char *name)
void	UI_RegisterRadioButtonNode (uiBehaviour_t *behaviour)

Detailed Description

The radiobutton is a clickable widget. Commonly, with use it in a group of radiobuttons; the user is allowed to choose only one button from this set. The current implementation share the value of the group with a cvar, and each button use is own value. When the cvar equals to a button value, this button is selected.

radiobutton foo {
  cvar "*cvar:foobar"
  value 4
  icon boo
}

Definition in file ui_node_radiobutton.cpp.

Macro Definition Documentation

EPSILON

#define EPSILON   0.001f

Definition at line 55 of file ui_node_radiobutton.cpp.

Referenced by UI_RadioButtonNodeIsSelected().

EXTRADATA

#define EXTRADATA

(

node

)

Value:

UI_EXTRADATA(node, EXTRADATA_TYPE)

Definition at line 52 of file ui_node_radiobutton.cpp.

Referenced by UI_RadioButton_GetCvar(), UI_RadioButton_SetBackgroundByName(), UI_RadioButton_SetCvar(), UI_RadioButton_SetIconByName(), UI_RadioButton_SetValue(), UI_RadioButton_SetValue(), and UI_RadioButtonNodeIsSelected().

EXTRADATA_TYPE

#define EXTRADATA_TYPE   radioButtonExtraData_t

Definition at line 51 of file ui_node_radiobutton.cpp.

EXTRADATACONST

#define EXTRADATACONST

(

node

)

Value:

UI_EXTRADATACONST(node, EXTRADATA_TYPE)

Definition at line 53 of file ui_node_radiobutton.cpp.

UI_4STATUS_TEX_HEIGHT

#define UI_4STATUS_TEX_HEIGHT   64

Height of a status in a 4 status 256*256 texture

Definition at line 58 of file ui_node_radiobutton.cpp.

Referenced by uiRadioButtonNode::draw().

Function Documentation

UI_RadioButton_GetCvar()

const char * UI_RadioButton_GetCvar

(

uiNode_t *

node

)

Definition at line 166 of file ui_node_radiobutton.cpp.

References EXTRADATA.

Referenced by uiRadioButtonNode_t_cvar().

UI_RadioButton_SetBackgroundByName()

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

Definition at line 193 of file ui_node_radiobutton.cpp.

References EXTRADATA, name, and UI_GetSpriteByName().

Referenced by uiRadioButtonNode_t_set_background().

UI_RadioButton_SetCvar()

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

Definition at line 170 of file ui_node_radiobutton.cpp.

References Cvar_Get(), EXTRADATA, cvar_t::name, and name.

Referenced by uiRadioButtonNode_t_set_cvar().

UI_RadioButton_SetIconByName()

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

Definition at line 198 of file ui_node_radiobutton.cpp.

References EXTRADATA, name, and UI_GetSpriteByName().

Referenced by uiRadioButtonNode_t_set_icon().

UI_RadioButton_SetValue() [1/2]

void UI_RadioButton_SetValue	(	uiNode_t *	node,
		const char *	value )

Definition at line 175 of file ui_node_radiobutton.cpp.

References uiNode_t::behaviour, EXTRADATA, SharedPtr< T >::get(), uiBehaviour_t::manager, Mem_Free, Mem_StrDup, and uiRadioButtonNode::onActivate().

Referenced by uiRadioButtonNode_t_set_value__SWIG_0(), and uiRadioButtonNode_t_set_value__SWIG_1().

UI_RadioButton_SetValue() [2/2]

void UI_RadioButton_SetValue	(	uiNode_t *	node,
		float	value )

Definition at line 187 of file ui_node_radiobutton.cpp.

References uiNode_t::behaviour, EXTRADATA, SharedPtr< T >::get(), uiBehaviour_t::manager, and uiRadioButtonNode::onActivate().

UI_RadioButtonNodeIsSelected()

bool UI_RadioButtonNodeIsSelected ( uiNode_t * node )

static

Definition at line 60 of file ui_node_radiobutton.cpp.

References EPSILON, EXTRADATA, Q_streq, UI_GetReferenceFloat(), and UI_GetReferenceString().

Referenced by uiRadioButtonNode::draw(), and uiRadioButtonNode::onActivate().

UI_RegisterRadioButtonNode()

void UI_RegisterRadioButtonNode

(

uiBehaviour_t *

behaviour

)

Definition at line 202 of file ui_node_radiobutton.cpp.

References EXTRADATA_TYPE, uiBehaviour_t::extraDataSize, uiBehaviour_t::lua_SWIG_typeinfo, uiBehaviour_t::manager, uiBehaviour_t::name, UI_RegisterExtradataNodeProperty, UI_SWIG_TypeQuery(), V_BOOL, V_CVAR_OR_STRING, V_FLOAT, V_UI_CVAR, and V_UI_SPRITEREF.