1 /*****************************************************************************
2 * variables.h: object variables typedefs
3 *****************************************************************************
4 * Copyright (C) 2002-2006 the VideoLAN team
5 * $Id: variables.c 22331 2007-09-30 16:58:33Z courmisch $
7 * Authors: Samuel Hocevar <sam@zoy.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
25 typedef struct callback_entry_t callback_entry_t;
28 * The structure describing a variable.
29 * \note vlc_value_t is the common union for variable values
33 /** The variable's exported value */
36 char * psz_name; /**< The variable unique name */
37 uint32_t i_hash; /**< (almost) unique hashed value */
38 int i_type; /**< The type of the variable */
40 /** The variable display name, mainly for use by the interfaces */
43 /** A pointer to a comparison function */
44 int ( * pf_cmp ) ( vlc_value_t, vlc_value_t );
45 /** A pointer to a duplication function */
46 void ( * pf_dup ) ( vlc_value_t * );
47 /** A pointer to a deallocation function */
48 void ( * pf_free ) ( vlc_value_t * );
50 /** Creation count: we only destroy the variable if it reaches 0 */
53 /** If the variable has min/max/step values */
54 vlc_value_t min, max, step;
56 /** Index of the default choice, if the variable is to be chosen in
59 /** List of choices */
61 /** List of friendly names for the choices */
62 vlc_list_t choices_text;
64 /** Set to TRUE if the variable is in a callback */
65 vlc_bool_t b_incallback;
67 /** Number of registered callbacks */
69 /** Array of registered callbacks */
70 callback_entry_t * p_entries;