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
30 int i_type; ///< Type identifier;
31 char *psz_text; ///< Free text
37 * Possible widget types
41 WIDGET_TEXT, ///< Text display
42 WIDGET_PROGRESS, ///< A progress bar
43 WIDGET_INPUT_TEXT ///< Input (backed up by a variable)
47 * This structure describes a piece of interaction with the user
49 struct interaction_dialog_t
51 int i_id; ///< Unique ID
52 int i_type; ///< Type identifier
53 char *psz_title; ///< Title
54 char *psz_description; ///< Descriptor string
56 char *psz_returned[1]; ///< returned responses from the user
58 vlc_value_t val; ///< a value coming from core for dialogue
60 int i_widgets; ///< Number of dialog widgets
61 user_widget_t **pp_widgets; ///< Dialog widgets
63 void * p_private; ///< Private interface data
65 int i_status; ///< Dialog status;
66 int i_action; ///< Action to perform;
67 int i_flags; ///< Misc flags
68 int i_return; ///< Return status
70 interaction_t *p_interaction; ///< Parent interaction object
71 vlc_object_t *p_parent; ///< The vlc object that asked
76 * Possible flags . Reusable and button types
78 #define DIALOG_REUSABLE 0x01
79 #define DIALOG_OK_CANCEL 0x02
80 #define DIALOG_YES_NO 0x04
81 #define DIALOG_YES_NO_CANCEL 0x04
82 #define DIALOG_CLEAR_NOSHOW 0x08
83 #define DIALOG_GOT_ANSWER 0x10
84 #define DIALOG_LOGIN_PW_OK_CANCEL 0x20
85 #define DIALOG_USER_PROGRESS 0x40
86 #define DIALOG_PSZ_INPUT_OK_CANCEL 0x80
87 #define DIALOG_INTF_PROGRESS 0x100
90 * Possible return codes
105 NEW_DIALOG, ///< Just created
106 SENT_DIALOG, ///< Sent to interface
107 UPDATED_DIALOG, ///< Update to send
108 ANSWERED_DIALOG, ///< Got "answer"
109 HIDING_DIALOG, ///< Hiding requested
110 HIDDEN_DIALOG, ///< Now hidden. Requesting destruction
111 DESTROYED_DIALOG, ///< Interface has destroyed it
115 * Possible interaction types
119 INTERACT_PROGRESS, ///< Progress bar (in the main interface ?)
120 INTERACT_DIALOG_ONEWAY, ///< Dialog box without feedback
121 INTERACT_DIALOG_TWOWAY, ///< Dialog box with feedback
125 * Predefined reusable dialogs
132 DIALOG_LAST_PREDEFINED,
136 * This structure contains the active interaction dialogs, and is
137 * used by teh manager
143 int i_dialogs; ///< Number of dialogs
144 interaction_dialog_t **pp_dialogs; ///< Dialogs
146 intf_thread_t *p_intf; ///< Interface to use
148 int i_last_id; ///< Last attributed ID
161 /***************************************************************************
163 ***************************************************************************/
165 #define intf_Interact( a,b ) __intf_Interact( VLC_OBJECT(a), b )
166 VLC_EXPORT( int,__intf_Interact,( vlc_object_t *,interaction_dialog_t * ) );
168 #define intf_UserFatal( a, c, d, e... ) __intf_UserFatal( VLC_OBJECT(a),c,d, ## e )
169 VLC_EXPORT( void, __intf_UserFatal,( vlc_object_t*, const char*, const char*, ...) );
170 #define intf_UserLoginPassword( a, b, c, d, e... ) __intf_UserLoginPassword( VLC_OBJECT(a),b,c,d,e)
171 VLC_EXPORT( int, __intf_UserLoginPassword,( vlc_object_t*, const char*, const char*, char **, char **) );
172 #define intf_UserYesNo( a, b, c ) __intf_UserYesNo( VLC_OBJECT(a),b,c )
173 VLC_EXPORT( int, __intf_UserYesNo,( vlc_object_t*, const char*, const char*) );
174 #define intf_UserOkayCancel( a, b, c ) __intf_UserOkayCancel( VLC_OBJECT(a),b,c )
175 VLC_EXPORT( int, __intf_UserOkayCancel,( vlc_object_t*, const char*, const char*) );
177 #define intf_UserProgress( a, b, c, d ) __intf_UserProgress( VLC_OBJECT(a),b,c, d )
178 VLC_EXPORT( int, __intf_UserProgress,( vlc_object_t*, const char*, const char*, float) );
179 #define intf_UserProgressUpdate( a, b, c, d ) __intf_UserProgressUpdate( VLC_OBJECT(a),b,c, d )
180 VLC_EXPORT( void, __intf_UserProgressUpdate,( vlc_object_t*, int, const char*, float) );
182 #define intf_UserStringInput( a, b, c, d ) __intf_UserStringInput( VLC_OBJECT(a),b,c,d )
183 VLC_EXPORT( int, __intf_UserStringInput,(vlc_object_t*, const char*, const char*, char **) );
185 #define intf_IntfProgress( a, b, c, d ) __intf_IntfProgress( VLC_OBJECT(a),b,c, d )
186 VLC_EXPORT( int, __intf_IntfProgress,( vlc_object_t*, const char*, float) );
187 #define intf_IntfProgressUpdate( a, b, c, d ) __intf_IntfProgressUpdate( VLC_OBJECT(a),b,c, d )
188 VLC_EXPORT( void, __intf_IntfProgressUpdate,( vlc_object_t*, int, const char*, float) );
190 #define intf_UserHide( a, b ) __intf_UserHide( VLC_OBJECT(a), b )
191 VLC_EXPORT( void, __intf_UserHide,( vlc_object_t *, int ));
193 VLC_EXPORT( void, intf_InteractionManage,( playlist_t *) );
194 VLC_EXPORT( void, intf_InteractionDestroy,( interaction_t *) );