]> git.sesse.net Git - vlc/blob - include/vlc_interaction.h
Fix a bunch of warning.
[vlc] / include / vlc_interaction.h
1 /*****************************************************************************
2  * vlc_interaction.h: structures and function for user interaction
3  *****************************************************************************
4  * Copyright (C) 2005-2006 VideoLAN
5  * $Id$
6  *
7  * Authors: Clément Stenac <zorglub@videolan.org>
8  *          Felix Kühne <fkuehne@videolan.org>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 /**
26  * This structure describes an interaction widget
27  * WIDGETS ARE OUTDATED! THIS IS ONLY A STUB TO KEEP WX COMPILING!
28  */
29 struct user_widget_t
30 {
31     int             i_type;             ///< Type identifier;
32     char           *psz_text;           ///< Free text
33
34     vlc_value_t     val;
35 };
36
37 /**
38  * Possible widget types
39  * WIDGETS ARE OUTDATED! THIS IS ONLY A STUB TO KEEP WX COMPILING!
40  */
41 enum
42 {
43     WIDGET_TEXT,                        ///< Text display
44     WIDGET_PROGRESS,                    ///< A progress bar
45     WIDGET_INPUT_TEXT                   ///< Input (backed up by a variable)
46 };
47
48 /**
49  * This structure describes a piece of interaction with the user
50  */
51 struct interaction_dialog_t
52 {
53     int             i_id;               ///< Unique ID
54     int             i_type;             ///< Type identifier
55     char           *psz_title;          ///< Title
56     char           *psz_description;    ///< Descriptor string
57     char           *psz_default_button;  ///< default button title (~OK)
58     char           *psz_alternate_button;///< alternate button title (~NO)
59     /// other button title (optional,~Cancel)
60     char           *psz_other_button;
61
62     char           *psz_returned[1];    ///< returned responses from the user
63
64     vlc_value_t     val;                ///< a value coming from core for dialogue
65     int             i_timeToGo;         ///< time (in sec) until shown progress is finished
66     vlc_bool_t      b_cancelled;        ///< was the dialogue cancelled by the user?
67
68     int             i_widgets;          ///< Number of dialog widgets
69     user_widget_t **pp_widgets;         ///< Dialog widgets
70
71     void *          p_private;          ///< Private interface data
72
73     int             i_status;           ///< Dialog status;
74     int             i_action;           ///< Action to perform;
75     int             i_flags;            ///< Misc flags
76     int             i_return;           ///< Return status
77
78     interaction_t  *p_interaction;      ///< Parent interaction object
79     vlc_object_t   *p_parent;           ///< The vlc object that asked
80                                         //for interaction
81 };
82
83 /**
84  * Possible flags . Dialog types
85  */
86 #define DIALOG_GOT_ANSWER           0x01
87 #define DIALOG_YES_NO_CANCEL        0x02
88 #define DIALOG_LOGIN_PW_OK_CANCEL   0x04
89 #define DIALOG_PSZ_INPUT_OK_CANCEL  0x08
90 #define DIALOG_BLOCKING_ERROR       0x10
91 #define DIALOG_NONBLOCKING_ERROR    0x20
92 #define DIALOG_WARNING              0x40
93 #define DIALOG_USER_PROGRESS        0x80
94 #define DIALOG_INTF_PROGRESS        0x100
95
96 /**
97  * Possible return codes
98  */
99 enum
100 {
101     DIALOG_DEFAULT,
102     DIALOG_OK_YES,
103     DIALOG_NO,
104     DIALOG_CANCELLED
105 };
106
107 /**
108  * Possible status
109  */
110 enum
111 {
112     NEW_DIALOG,                 ///< Just created
113     SENT_DIALOG,                ///< Sent to interface
114     UPDATED_DIALOG,             ///< Update to send
115     ANSWERED_DIALOG,            ///< Got "answer"
116     HIDING_DIALOG,              ///< Hiding requested
117     HIDDEN_DIALOG,              ///< Now hidden. Requesting destruction
118     DESTROYED_DIALOG,           ///< Interface has destroyed it
119 };
120
121 /**
122  * Possible interaction types
123  */
124 enum
125 {
126     INTERACT_DIALOG_ONEWAY,     ///< Dialog box without feedback
127     INTERACT_DIALOG_TWOWAY,     ///< Dialog box with feedback
128 };
129
130 /**
131  * Predefined reusable dialogs
132  */
133 enum
134 {
135     DIALOG_FIRST,
136
137     DIALOG_LAST_PREDEFINED,
138 };
139
140 /**
141  * This structure contains the active interaction dialogs, and is
142  * used by the manager
143  */
144 struct interaction_t
145 {
146     VLC_COMMON_MEMBERS
147
148     int                         i_dialogs;      ///< Number of dialogs
149     interaction_dialog_t      **pp_dialogs;     ///< Dialogs
150
151     intf_thread_t              *p_intf;         ///< Interface to use
152
153     int                         i_last_id;      ///< Last attributed ID
154 };
155 /**
156  * Possible actions
157  */
158 enum
159 {
160     INTERACT_NEW,
161     INTERACT_UPDATE,
162     INTERACT_HIDE,
163     INTERACT_DESTROY
164 };
165
166 /***************************************************************************
167  * Exported symbols
168  ***************************************************************************/
169
170 #define intf_UserFatal( a, b, c, d, e... ) __intf_UserFatal( VLC_OBJECT(a),b,c,d, ## e )
171 VLC_EXPORT( int, __intf_UserFatal,( vlc_object_t*, vlc_bool_t, const char*, const char*, ...) );
172 #define intf_UserWarn( a, c, d, e... ) __intf_UserWarn( VLC_OBJECT(a),c,d, ## e )
173 VLC_EXPORT( int, __intf_UserWarn,( vlc_object_t*, const char*, const char*, ...) );
174 #define intf_UserLoginPassword( a, b, c, d, e... ) __intf_UserLoginPassword( VLC_OBJECT(a),b,c,d,e)
175 VLC_EXPORT( int, __intf_UserLoginPassword,( vlc_object_t*, const char*, const char*, char **, char **) );
176 #define intf_UserYesNo( a, b, c, d, e, f ) __intf_UserYesNo( VLC_OBJECT(a),b,c, d, e, f )
177 VLC_EXPORT( int, __intf_UserYesNo,( vlc_object_t*, const char*, const char*, const char*, const char*, const char*) );
178 #define intf_UserStringInput( a, b, c, d ) __intf_UserStringInput( VLC_OBJECT(a),b,c,d )
179 VLC_EXPORT( int, __intf_UserStringInput,(vlc_object_t*, const char*, const char*, char **) );
180
181 #define intf_IntfProgress( a, b, c ) __intf_Progress( VLC_OBJECT(a), NULL, b,c, -1 )
182 #define intf_UserProgress( a, b, c, d, e ) __intf_Progress( VLC_OBJECT(a),b,c,d,e )
183 VLC_EXPORT( int, __intf_Progress,( vlc_object_t*, const char*, const char*, float, int) );
184 #define intf_ProgressUpdate( a, b, c, d, e ) __intf_ProgressUpdate( VLC_OBJECT(a),b,c,d,e )
185 VLC_EXPORT( void, __intf_ProgressUpdate,( vlc_object_t*, int, const char*, float, int) );
186 #define intf_ProgressIsCancelled( a, b ) __intf_UserProgressIsCancelled( VLC_OBJECT(a),b )
187 VLC_EXPORT( vlc_bool_t, __intf_UserProgressIsCancelled,( vlc_object_t*, int ) );
188
189 #define intf_UserHide( a, b ) __intf_UserHide( VLC_OBJECT(a), b )
190 VLC_EXPORT( void, __intf_UserHide,( vlc_object_t *, int ));
191
192 VLC_EXPORT( void, intf_InteractionManage,( playlist_t *) );
193 VLC_EXPORT( void, intf_InteractionDestroy,( interaction_t *) );