1 /*****************************************************************************
2 * vlc_interaction.h: structures and function for user interaction
3 *****************************************************************************
4 * Copyright (C) 2005-2006 VideoLAN
7 * Authors: Clément Stenac <zorglub@videolan.org>
8 * Felix Kühne <fkuehne@videolan.org>
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.
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.
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 *****************************************************************************/
26 * This structure describes an interaction widget
27 * WIDGETS ARE OUTDATED! THIS IS ONLY A STUB TO KEEP WX COMPILING!
31 int i_type; ///< Type identifier;
32 char *psz_text; ///< Free text
38 * Possible widget types
39 * WIDGETS ARE OUTDATED! THIS IS ONLY A STUB TO KEEP WX COMPILING!
43 WIDGET_TEXT, ///< Text display
44 WIDGET_PROGRESS, ///< A progress bar
45 WIDGET_INPUT_TEXT ///< Input (backed up by a variable)
49 * This structure describes a piece of interaction with the user
51 struct interaction_dialog_t
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;
62 char *psz_returned[1]; ///< returned responses from the user
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?
68 int i_widgets; ///< Number of dialog widgets
69 user_widget_t **pp_widgets; ///< Dialog widgets
71 void * p_private; ///< Private interface data
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
78 interaction_t *p_interaction; ///< Parent interaction object
79 vlc_object_t *p_parent; ///< The vlc object that asked
84 * Possible flags . Reusable and button types
86 #define DIALOG_REUSABLE 0x01
87 #define DIALOG_YES_NO_CANCEL 0x04
88 #define DIALOG_CLEAR_NOSHOW 0x08
89 #define DIALOG_GOT_ANSWER 0x10
90 #define DIALOG_LOGIN_PW_OK_CANCEL 0x20
91 #define DIALOG_BLOCKING_ERROR 0x24
92 #define DIALOG_NONBLOCKING_ERROR 0x200
93 #define DIALOG_USER_PROGRESS 0x40
94 #define DIALOG_PSZ_INPUT_OK_CANCEL 0x80
95 #define DIALOG_INTF_PROGRESS 0x100
96 #define DIALOG_WARNING 0x400
99 * Possible return codes
114 NEW_DIALOG, ///< Just created
115 SENT_DIALOG, ///< Sent to interface
116 UPDATED_DIALOG, ///< Update to send
117 ANSWERED_DIALOG, ///< Got "answer"
118 HIDING_DIALOG, ///< Hiding requested
119 HIDDEN_DIALOG, ///< Now hidden. Requesting destruction
120 DESTROYED_DIALOG, ///< Interface has destroyed it
124 * Possible interaction types
128 INTERACT_DIALOG_ONEWAY, ///< Dialog box without feedback
129 INTERACT_DIALOG_TWOWAY, ///< Dialog box with feedback
133 * Predefined reusable dialogs
139 DIALOG_LAST_PREDEFINED,
143 * This structure contains the active interaction dialogs, and is
144 * used by the manager
150 int i_dialogs; ///< Number of dialogs
151 interaction_dialog_t **pp_dialogs; ///< Dialogs
153 intf_thread_t *p_intf; ///< Interface to use
155 int i_last_id; ///< Last attributed ID
168 /***************************************************************************
170 ***************************************************************************/
172 #define intf_Interact( a,b ) __intf_Interact( VLC_OBJECT(a), b )
173 VLC_EXPORT( int,__intf_Interact,( vlc_object_t *,interaction_dialog_t * ) );
175 #define intf_UserFatal( a, b, c, d, e... ) __intf_UserFatal( VLC_OBJECT(a),b,c,d, ## e )
176 VLC_EXPORT( void, __intf_UserFatal,( vlc_object_t*, vlc_bool_t, const char*, const char*, ...) );
177 #define intf_UserWarn( a, c, d, e... ) __intf_UserWarn( VLC_OBJECT(a),c,d, ## e )
178 VLC_EXPORT( void, __intf_UserWarn,( vlc_object_t*, const char*, const char*, ...) );
179 #define intf_UserLoginPassword( a, b, c, d, e... ) __intf_UserLoginPassword( VLC_OBJECT(a),b,c,d,e)
180 VLC_EXPORT( int, __intf_UserLoginPassword,( vlc_object_t*, const char*, const char*, char **, char **) );
181 #define intf_UserYesNo( a, b, c, d, e, f ) __intf_UserYesNo( VLC_OBJECT(a),b,c, d, e, f )
182 VLC_EXPORT( int, __intf_UserYesNo,( vlc_object_t*, const char*, const char*, const char*, const char*, const char*) );
184 #define intf_UserProgress( a, b, c, d, e ) __intf_UserProgress( VLC_OBJECT(a),b,c,d,e )
185 VLC_EXPORT( int, __intf_UserProgress,( vlc_object_t*, const char*, const char*, float, int) );
186 #define intf_UserProgressUpdate( a, b, c, d, e ) __intf_UserProgressUpdate( VLC_OBJECT(a),b,c,d,e )
187 VLC_EXPORT( void, __intf_UserProgressUpdate,( vlc_object_t*, int, const char*, float, int) );
188 #define intf_UserProgressIsCancelled( a, b ) __intf_UserProgressIsCancelled( VLC_OBJECT(a),b )
189 VLC_EXPORT( vlc_bool_t, __intf_UserProgressIsCancelled,( vlc_object_t*, int ) );
191 #define intf_UserStringInput( a, b, c, d ) __intf_UserStringInput( VLC_OBJECT(a),b,c,d )
192 VLC_EXPORT( int, __intf_UserStringInput,(vlc_object_t*, const char*, const char*, char **) );
194 #define intf_IntfProgress( a, b, c ) __intf_IntfProgress( VLC_OBJECT(a),b,c )
195 VLC_EXPORT( int, __intf_IntfProgress,( vlc_object_t*, const char*, float) );
196 #define intf_IntfProgressUpdate( a, b, c, d ) __intf_IntfProgressUpdate( VLC_OBJECT(a),b,c,d )
197 VLC_EXPORT( void, __intf_IntfProgressUpdate,( vlc_object_t*, int, const char*, float) );
199 #define intf_UserHide( a, b ) __intf_UserHide( VLC_OBJECT(a), b )
200 VLC_EXPORT( void, __intf_UserHide,( vlc_object_t *, int ));
202 VLC_EXPORT( void, intf_InteractionManage,( playlist_t *) );
203 VLC_EXPORT( void, intf_InteractionDestroy,( interaction_t *) );