variable_t Struct Reference

The structure describing a variable. More...

Collaboration diagram for variable_t:

Data Fields
char *	psz_name
	The variable unique name (must be first) More...
vlc_value_t	val
	The variable's exported value. More...
char *	psz_text
	The variable display name, mainly for use by the interfaces. More...
const variable_ops_t *	ops
int	i_type
	The type of the variable. More...
unsigned	i_usage
	Reference count. More...
vlc_value_t	min
	If the variable has min/max/step values. More...
vlc_value_t	max
vlc_value_t	step
vlc_value_t *	choices
	List of choices. More...
char **	choices_text
	List of friendly names for the choices. More...
size_t	choices_count
bool	b_incallback
	Set to TRUE if the variable is in a callback. More...
callback_entry_t *	value_callbacks
	Registered value callbacks. More...
callback_entry_t *	list_callbacks
	Registered list callbacks. More...

Detailed Description

The structure describing a variable.

Note

vlc_value_t is the common union for variable values

Field Documentation

b_incallback

bool variable_t::b_incallback

Set to TRUE if the variable is in a callback.

Referenced by TriggerCallback(), TriggerListCallback(), var_Create(), var_Destroy(), and WaitUnused().

choices

vlc_value_t* variable_t::choices

List of choices.

Referenced by Destroy(), var_Change(), and var_Create().

choices_count

size_t variable_t::choices_count

Referenced by Destroy(), var_Change(), var_Create(), and var_Type().

choices_text

char** variable_t::choices_text

List of friendly names for the choices.

Referenced by Destroy(), var_Change(), and var_Create().

i_type

int variable_t::i_type

The type of the variable.

Referenced by CheckValue(), var_Change(), var_Create(), var_GetAndSet(), var_GetChecked(), var_SetChecked(), and var_Type().

i_usage

unsigned variable_t::i_usage

Reference count.

Referenced by var_Create(), and var_Destroy().

list_callbacks

callback_entry_t* variable_t::list_callbacks

Registered list callbacks.

Referenced by AddCallback(), DelCallback(), Destroy(), and TriggerListCallback().

max

vlc_value_t variable_t::max

Referenced by CheckValue(), var_Change(), and var_Create().

min

vlc_value_t variable_t::min

If the variable has min/max/step values.

Referenced by CheckValue(), var_Change(), and var_Create().

ops

const variable_ops_t* variable_t::ops

Referenced by Destroy(), var_Change(), var_Create(), var_GetChecked(), and var_SetChecked().

psz_name

char* variable_t::psz_name

The variable unique name (must be first)

Referenced by Destroy(), TwalkGetNames(), var_Create(), and varcmp().

psz_text

char* variable_t::psz_text

The variable display name, mainly for use by the interfaces.

Referenced by Destroy(), var_Change(), and var_Create().

step

vlc_value_t variable_t::step

Referenced by CheckValue(), and var_Change().

val

vlc_value_t variable_t::val

The variable's exported value.

Referenced by Destroy(), TriggerCallback(), var_Change(), var_Create(), var_GetAndSet(), var_GetChecked(), var_SetChecked(), and var_TriggerCallback().

value_callbacks

callback_entry_t* variable_t::value_callbacks

Registered value callbacks.

Referenced by AddCallback(), DelCallback(), Destroy(), TriggerCallback(), and var_Create().

---

The documentation for this struct was generated from the following file:

• src/misc/variables.c