vlc_variables.h File Reference

This file defines functions and structures for dynamic variables in vlc. More...

Include dependency graph for vlc_variables.h:

Go to the source code of this file.

Defines

#define VLC_VARIABLES_H   1
#define VLC_VAR_TYPE   0x00ff
#define VLC_VAR_CLASS   0x00f0
#define VLC_VAR_FLAGS   0xff00
#define VLC_VAR_HASCHOICE   0x0100
#define VLC_VAR_HASMIN   0x0200
#define VLC_VAR_HASMAX   0x0400
#define VLC_VAR_HASSTEP   0x0800
#define VLC_VAR_ISCOMMAND   0x2000
#define VLC_VAR_DOINHERIT   0x8000
 Creation flag.
#define VLC_VAR_SETMIN   0x0010
 Set the minimum value of this variable.
#define VLC_VAR_SETMAX   0x0011
 Set the maximum value of this variable.
#define VLC_VAR_SETSTEP   0x0012
#define VLC_VAR_SETVALUE   0x0013
 Set the value of this variable without triggering any callbacks.
#define VLC_VAR_SETTEXT   0x0014
#define VLC_VAR_GETTEXT   0x0015
#define VLC_VAR_GETMIN   0x0016
#define VLC_VAR_GETMAX   0x0017
#define VLC_VAR_GETSTEP   0x0018
#define VLC_VAR_ADDCHOICE   0x0020
#define VLC_VAR_DELCHOICE   0x0021
#define VLC_VAR_CLEARCHOICES   0x0022
#define VLC_VAR_SETDEFAULT   0x0023
#define VLC_VAR_GETCHOICES   0x0024
#define VLC_VAR_GETLIST   0x0025
#define VLC_VAR_CHOICESCOUNT   0x0026
#define VLC_VAR_INHERITVALUE   0x0030
#define VLC_VAR_SETISCOMMAND   0x0040
#define VLC_VAR_TOGGLE_BOOL   0x0010
 Toggle the value of this boolean.
#define VLC_VAR_INTEGER_INCDEC   0x0020
 Increment or decrement an integer of a given value.
#define var_Command(a, b, c, d, e)   __var_Command( VLC_OBJECT( a ), b, c, d, e )
#define var_Create(a, b, c)   __var_Create( VLC_OBJECT(a), b, c )
 __var_Create() with automatic casting.
#define var_Destroy(a, b)   __var_Destroy( VLC_OBJECT(a), b )
 __var_Destroy() with automatic casting
#define var_Change(a, b, c, d, e)   __var_Change( VLC_OBJECT(a), b, c, d, e )
 __var_Change() with automatic casting
#define var_Type(a, b)   __var_Type( VLC_OBJECT(a), b )
 __var_Type() with automatic casting
#define var_Set(a, b, c)   __var_Set( VLC_OBJECT(a), b, c )
 __var_Set() with automatic casting
#define var_Get(a, b, c)   __var_Get( VLC_OBJECT(a), b, c )
 __var_Get() with automatic casting
#define var_GetAndSet(a, b, c, d)   __var_GetAndSet(VLC_OBJECT(a), b, c, d)
 __var_GetAndSet() with automatic casting
#define var_AddCallback(a, b, c, d)   __var_AddCallback( VLC_OBJECT(a), b, c, d )
 __var_AddCallback() with automatic casting
#define var_DelCallback(a, b, c, d)   __var_DelCallback( VLC_OBJECT(a), b, c, d )
 __var_DelCallback() with automatic casting
#define var_TriggerCallback(a, b)   __var_TriggerCallback( VLC_OBJECT(a), b )
 __var_TriggerCallback() with automatic casting
#define var_SetInteger(a, b, c)   __var_SetInteger( VLC_OBJECT(a),b,c)
 __var_SetInteger() with automatic casting
#define var_SetBool(a, b, c)   __var_SetBool( VLC_OBJECT(a),b,c)
 __var_SetBool() with automatic casting
#define var_SetTime(a, b, c)   __var_SetTime( VLC_OBJECT(a),b,c)
 __var_SetTime() with automatic casting
#define var_SetFloat(a, b, c)   __var_SetFloat( VLC_OBJECT(a),b,c)
 __var_SetFloat() with automatic casting
#define var_SetString(a, b, c)   __var_SetString( VLC_OBJECT(a),b,c)
 __var_SetString() with automatic casting
#define var_SetAddress(o, n, p)   __var_SetAddress(VLC_OBJECT(o), n, p)
 __var_SetAddress() with automatic casting
#define var_GetInteger(a, b)   __var_GetInteger( VLC_OBJECT(a),b)
 __var_GetInteger() with automatic casting
#define var_GetBool(a, b)   __var_GetBool( VLC_OBJECT(a),b)
 __var_GetBool() with automatic casting
#define var_GetTime(a, b)   __var_GetTime( VLC_OBJECT(a),b)
 __var_GetTime() with automatic casting
#define var_GetFloat(a, b)   __var_GetFloat( VLC_OBJECT(a),b)
 __var_GetFloat() with automatic casting
#define var_GetString(a, b)   __var_GetString( VLC_OBJECT(a),b)
 __var_GetString() with automatic casting
#define var_GetNonEmptyString(a, b)   __var_GetNonEmptyString( VLC_OBJECT(a),b)
#define var_GetAddress(a, b)   __var_GetAddress( VLC_OBJECT(a),b)
 __var_GetAddress() with automatic casting
#define var_IncInteger(a, b)   __var_IncInteger( VLC_OBJECT(a), b )
#define var_DecInteger(a, b)   __var_DecInteger( VLC_OBJECT(a), b )
#define var_CreateGetInteger(a, b)   __var_CreateGetInteger( VLC_OBJECT(a),b)
 __var_CreateGetInteger() with automatic casting
#define var_CreateGetBool(a, b)   __var_CreateGetBool( VLC_OBJECT(a),b)
 __var_CreateGetBool() with automatic casting
#define var_CreateGetTime(a, b)   __var_CreateGetTime( VLC_OBJECT(a),b)
 __var_CreateGetTime() with automatic casting
#define var_CreateGetFloat(a, b)   __var_CreateGetFloat( VLC_OBJECT(a),b)
 __var_CreateGetFloat() with automatic casting
#define var_CreateGetString(a, b)   __var_CreateGetString( VLC_OBJECT(a),b)
 __var_CreateGetString() with automatic casting
#define var_CreateGetNonEmptyString(a, b)   __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
#define var_CreateGetAddress(a, b)   __var_CreateGetAddress( VLC_OBJECT(a),b)
 __var_CreateGetString() with automatic casting
#define var_CreateGetIntegerCommand(a, b)   __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
 __var_CreateGetInteger() with automatic casting
#define var_CreateGetBoolCommand(a, b)   __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
 __var_CreateGetBoolCommand() with automatic casting
#define var_CreateGetTimeCommand(a, b)   __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
 __var_CreateGetTimeCommand() with automatic casting
#define var_CreateGetFloatCommand(a, b)   __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
 __var_CreateGetFloat() with automatic casting
#define var_CreateGetStringCommand(a, b)   __var_CreateGetStringCommand( VLC_OBJECT(a),b)
 __var_CreateGetStringCommand() with automatic casting
#define var_CreateGetNonEmptyStringCommand(a, b)   __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
#define var_CountChoices(a, b)   __var_CountChoices( VLC_OBJECT(a),b)
 __var_CountChoices() with automatic casting
#define var_ToggleBool(a, b)   __var_ToggleBool( VLC_OBJECT(a),b )
 __var_ToggleBool() with automatic casting

Functions

int __var_Create (vlc_object_t *, const char *, int)
 Initialize a vlc variable.
int __var_Destroy (vlc_object_t *, const char *)
 Destroy a vlc variable.
int __var_Change (vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t *)
 Perform an action on a variable.
int __var_Type (vlc_object_t *, const char *)
 Request a variable's type.
int __var_Set (vlc_object_t *, const char *, vlc_value_t)
 Set a variable's value.
int __var_Get (vlc_object_t *, const char *, vlc_value_t *)
 Get a variable's value.
int var_SetChecked (vlc_object_t *, const char *, int, vlc_value_t)
int var_GetChecked (vlc_object_t *, const char *, int, vlc_value_t *)
int __var_GetAndSet (vlc_object_t *, const char *, int, vlc_value_t)
 Perform a Get and Set on a variable.
int __var_Command (vlc_object_t *, const char *, const char *, const char *, char **)
void var_FreeList (vlc_value_t *, vlc_value_t *)
 Free a list and the associated strings.
int __var_AddCallback (vlc_object_t *, const char *, vlc_callback_t, void *)
 Register a callback in a variable.
int __var_DelCallback (vlc_object_t *, const char *, vlc_callback_t, void *)
 Remove a callback from a variable.
int __var_TriggerCallback (vlc_object_t *, const char *)
 Trigger callback on a variable.
static int __var_SetInteger (vlc_object_t *p_obj, const char *psz_name, int i)
 Set the value of an integer variable.
static int __var_SetBool (vlc_object_t *p_obj, const char *psz_name, bool b)
 Set the value of an boolean variable.
static int __var_SetTime (vlc_object_t *p_obj, const char *psz_name, int64_t i)
 Set the value of a time variable.
static int __var_SetFloat (vlc_object_t *p_obj, const char *psz_name, float f)
 Set the value of a float variable.
static int __var_SetString (vlc_object_t *p_obj, const char *psz_name, const char *psz_string)
 Set the value of a string variable.
static int __var_SetAddress (vlc_object_t *p_obj, const char *psz_name, void *ptr)
 Set the value of a pointer variable.
static int __var_GetInteger (vlc_object_t *p_obj, const char *psz_name)
 Get an integer value.
static bool __var_GetBool (vlc_object_t *p_obj, const char *psz_name)
 Get a boolean value.
static int64_t __var_GetTime (vlc_object_t *p_obj, const char *psz_name)
 Get a time value.
static float __var_GetFloat (vlc_object_t *p_obj, const char *psz_name)
 Get a float value.
static char * __var_GetString (vlc_object_t *p_obj, const char *psz_name)
 Get a string value.
static char * __var_GetNonEmptyString (vlc_object_t *p_obj, const char *psz_name)
static void * __var_GetAddress (vlc_object_t *p_obj, const char *psz_name)
static void __var_IncInteger (vlc_object_t *p_obj, const char *psz_name)
 Increment an integer variable.
static void __var_DecInteger (vlc_object_t *p_obj, const char *psz_name)
 Decrement an integer variable.
static int __var_CreateGetInteger (vlc_object_t *p_obj, const char *psz_name)
 Create a integer variable with inherit and get its value.
static bool __var_CreateGetBool (vlc_object_t *p_obj, const char *psz_name)
 Create a boolean variable with inherit and get its value.
static int64_t __var_CreateGetTime (vlc_object_t *p_obj, const char *psz_name)
 Create a time variable with inherit and get its value.
static float __var_CreateGetFloat (vlc_object_t *p_obj, const char *psz_name)
 Create a float variable with inherit and get its value.
static char * __var_CreateGetString (vlc_object_t *p_obj, const char *psz_name)
 Create a string variable with inherit and get its value.
static char * __var_CreateGetNonEmptyString (vlc_object_t *p_obj, const char *psz_name)
static void * __var_CreateGetAddress (vlc_object_t *p_obj, const char *psz_name)
 Create an address variable with inherit and get its value.
static int __var_CreateGetIntegerCommand (vlc_object_t *p_obj, const char *psz_name)
 Create a integer command variable with inherit and get its value.
static bool __var_CreateGetBoolCommand (vlc_object_t *p_obj, const char *psz_name)
 Create a boolean command variable with inherit and get its value.
static int64_t __var_CreateGetTimeCommand (vlc_object_t *p_obj, const char *psz_name)
 Create a time command variable with inherit and get its value.
static float __var_CreateGetFloatCommand (vlc_object_t *p_obj, const char *psz_name)
 Create a float command variable with inherit and get its value.
static char * __var_CreateGetStringCommand (vlc_object_t *p_obj, const char *psz_name)
 Create a string command variable with inherit and get its value.
static char * __var_CreateGetNonEmptyStringCommand (vlc_object_t *p_obj, const char *psz_name)
static int __var_CountChoices (vlc_object_t *p_obj, const char *psz_name)
static int __var_ToggleBool (vlc_object_t *p_obj, const char *psz_name)


Detailed Description

This file defines functions and structures for dynamic variables in vlc.


Define Documentation

#define VLC_VARIABLES_H   1


Generated on Sat Nov 21 08:05:27 2009 for VLC by  doxygen 1.5.6