git.sesse.net Git - vlc/blob - 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  */
  28 struct user_widget_t
  29 {
  30     int             i_type;             ///< Type identifier;
  31     char           *psz_text;           ///< Free text
  32
  33     vlc_value_t     val;
  34 };
  35
  36 /**
  37  * Possible widget types
  38  */
  39 enum
  40 {
  41     WIDGET_TEXT,                        ///< Text display
  42     WIDGET_PROGRESS,                    ///< A progress bar
  43     WIDGET_INPUT_TEXT                   ///< Input (backed up by a variable)
  44 };
  45
  46 /**
  47  * This structure describes a piece of interaction with the user
  48  */
  49 struct interaction_dialog_t
  50 {
  51     int             i_id;               ///< Unique ID
  52     int             i_type;             ///< Type identifier
  53     char           *psz_title;          ///< Title
  54     char           *psz_description;    ///< Descriptor string
  55
  56     char           *psz_returned[1];    ///< returned responses from the user
  57
  58     int             i_widgets;          ///< Number of dialog widgets
  59     user_widget_t **pp_widgets;         ///< Dialog widgets
  60
  61     void *          p_private;          ///< Private interface data
  62
  63     int             i_status;           ///< Dialog status;
  64     int             i_action;           ///< Action to perform;
  65     int             i_flags;            ///< Misc flags
  66     int             i_return;           ///< Return status
  67
  68     interaction_t  *p_interaction;      ///< Parent interaction object
  69     vlc_object_t   *p_parent;           ///< The vlc object that asked
  70                                         //for interaction
  71 };
  72
  73 /**
  74  * Possible flags . Reusable and button types
  75  */
  76 #define DIALOG_REUSABLE             0x01
  77 #define DIALOG_OK_CANCEL            0x02
  78 #define DIALOG_YES_NO               0x04
  79 #define DIALOG_YES_NO_CANCEL        0x04
  80 #define DIALOG_CLEAR_NOSHOW         0x08
  81 #define DIALOG_GOT_ANSWER           0x10
  82 #define DIALOG_LOGIN_PW_OK_CANCEL   0x20
  83
  84 /**
  85  * Possible return codes
  86  */
  87 enum
  88 {
  89     DIALOG_DEFAULT,
  90     DIALOG_OK_YES,
  91     DIALOG_NO,
  92     DIALOG_CANCELLED
  93 };
  94
  95 /**
  96  * Possible status
  97  */
  98 enum
  99 {
 100     NEW_DIALOG,                 ///< Just created
 101     SENT_DIALOG,                ///< Sent to interface
 102     UPDATED_DIALOG,             ///< Update to send
 103     ANSWERED_DIALOG,            ///< Got "answer"
 104     HIDING_DIALOG,              ///< Hiding requested
 105     HIDDEN_DIALOG,              ///< Now hidden. Requesting destruction
 106     DESTROYED_DIALOG,           ///< Interface has destroyed it
 107 };
 108
 109 /**
 110  * Possible interaction types
 111  */
 112 enum
 113 {
 114     INTERACT_PROGRESS,          ///< Progress bar (in the main interface ?)
 115     INTERACT_DIALOG_ONEWAY,     ///< Dialog box without feedback
 116     INTERACT_DIALOG_TWOWAY,     ///< Dialog box with feedback
 117 };
 118
 119 /**
 120  * Predefined reusable dialogs
 121  */
 122 enum
 123 {
 124     DIALOG_FIRST,
 125     DIALOG_ERRORS,
 126
 127     DIALOG_LAST_PREDEFINED,
 128 };
 129
 130 /**
 131  * This structure contains the active interaction dialogs, and is
 132  * used by teh manager
 133  */
 134 struct interaction_t
 135 {
 136     VLC_COMMON_MEMBERS
 137
 138     int                         i_dialogs;      ///< Number of dialogs
 139     interaction_dialog_t      **pp_dialogs;     ///< Dialogs
 140
 141     intf_thread_t              *p_intf;         ///< Interface to use
 142
 143     int                         i_last_id;      ///< Last attributed ID
 144 };
 145 /**
 146  * Possible actions
 147  */
 148 enum
 149 {
 150     INTERACT_NEW,
 151     INTERACT_UPDATE,
 152     INTERACT_HIDE,
 153     INTERACT_DESTROY
 154 };
 155
 156 /***************************************************************************
 157  * Exported symbols
 158  ***************************************************************************/
 159
 160 #define intf_Interact( a,b ) __intf_Interact( VLC_OBJECT(a), b )
 161 VLC_EXPORT( int,__intf_Interact,( vlc_object_t *,interaction_dialog_t * ) );
 162
 163 #define intf_UserFatal( a, c, d, e... ) __intf_UserFatal( VLC_OBJECT(a),c,d, ## e )
 164 VLC_EXPORT( void, __intf_UserFatal,( vlc_object_t*, const char*, const char*, ...) );
 165 #define intf_UserLoginPassword( a, b, c, d, e... ) __intf_UserLoginPassword( VLC_OBJECT(a),b,c,d,e)
 166 VLC_EXPORT( int, __intf_UserLoginPassword,( vlc_object_t*, const char*, const char*, char **, char **) );
 167 #define intf_UserYesNo( a, b, c ) __intf_UserYesNo( VLC_OBJECT(a),b,c )
 168 VLC_EXPORT( int, __intf_UserYesNo,( vlc_object_t*, const char*, const char*) );
 169
 170 #define intf_UserProgress( a, b, c, d ) __intf_UserProgress( VLC_OBJECT(a),b,c, d )
 171 VLC_EXPORT( int, __intf_UserProgress,( vlc_object_t*, const char*, const char*, float) );
 172
 173 #define intf_UserProgressUpdate( a, b, c, d ) __intf_UserProgressUpdate( VLC_OBJECT(a),b,c, d )
 174 VLC_EXPORT( void, __intf_UserProgressUpdate,( vlc_object_t*, int, const char*, float) );
 175
 176 #define intf_UserHide( a, b ) __intf_UserHide( VLC_OBJECT(a), b )
 177 VLC_EXPORT( void, __intf_UserHide,( vlc_object_t *, int ));
 178
 179 VLC_EXPORT( void, intf_InteractionManage,( playlist_t *) );
 180 VLC_EXPORT( void, intf_InteractionDestroy,( interaction_t *) );