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) 1999-2004 VideoLAN
   5  * $Id: vlc_interaction.h 7954 2004-06-07 22:19:12Z fenrir $
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.org>
   8  *
   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.
  13  *
  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.
  18  *
  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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 /**
  25  * This structure describes an interaction widget
  26  */
  27 struct user_widget_t
  28 {
  29     int             i_type;             //< Type identifier;
  30     char           *psz_text;           //< Free text
  31
  32     vlc_value_t     val;
  33 };
  34
  35 /**
  36  * Possible widget types
  37  */
  38 enum
  39 {
  40     WIDGET_TEXT,                        //< Text display
  41     WIDGET_PROGRESS,                    //< A progress bar
  42     WIDGET_INPUT_TEXT                   //< Input (backed up by a variable)
  43 };
  44
  45 /**
  46  * This structure describes a piece of interaction with the user
  47  */
  48 struct interaction_dialog_t
  49 {
  50     int             i_id;               //< Unique ID
  51     int             i_type;             //< Type identifier
  52     char           *psz_title;          //< Title
  53     char           *psz_description;    //< Descriptor string
  54
  55     int             i_widgets;          //< Nu,ber of dialog widgets
  56     user_widget_t **pp_widgets;         //< Dialog widgets
  57
  58     void *          p_private;          //< Private interface data
  59
  60     int             i_status;           //< Dialog status;
  61     int             i_action;           //< Action to perform;
  62     int             i_flags;            //< Misc flags
  63     int             i_return;           //< Return status
  64
  65     interaction_t  *p_interaction;      //< Parent interaction object
  66     vlc_object_t   *p_parent;           //< The vlc object that asked
  67                                         //for interaction
  68 };
  69
  70 /**
  71  * Possible flags . Reusable and button types
  72  */
  73 #define DIALOG_REUSABLE      0x01
  74 #define DIALOG_OK_CANCEL     0x02
  75 #define DIALOG_YES_NO        0x04
  76 #define DIALOG_YES_NO_CANCEL 0x04
  77 #define DIALOG_GOT_ANSWER    0x08
  78
  79 /**
  80  * Possible return codes
  81  */
  82 enum
  83 {
  84     DIALOG_DEFAULT,
  85     DIALOG_OK_YES,
  86     DIALOG_NO,
  87     DIALOG_CANCELLED
  88 };
  89
  90 /**
  91  * Possible status
  92  */
  93 enum
  94 {
  95     NEW_DIALOG,                 //< Just created
  96     SENT_DIALOG,                //< Sent to interface
  97     UPDATED_DIALOG,             //< Update to send
  98     ANSWERED_DIALOG,            //< Got "answer"
  99     HIDING_DIALOG,              //< Hiding requested
 100     HIDDEN_DIALOG,              //< Now hidden. Requesting destruction
 101     DESTROYED_DIALOG,           //< Interface has destroyed it
 102 };
 103
 104 /**
 105  * Possible interaction types
 106  */
 107 enum
 108 {
 109     INTERACT_PROGRESS,          //< Progress bar (in the main interface ?)
 110     INTERACT_DIALOG_ONEWAY,     //< Dialog box without feedback
 111     INTERACT_DIALOG_TWOWAY,     //< Dialog box with feedback
 112 };
 113
 114 /**
 115  * Predefined reusable dialogs
 116  */
 117 enum
 118 {
 119     DIALOG_FIRST,
 120     DIALOG_ERRORS,
 121
 122     DIALOG_LAST_PREDEFINED,
 123 };
 124
 125 /**
 126  * This structure contains the active interaction dialogs, and is
 127  * used by teh manager
 128  */
 129 struct interaction_t
 130 {
 131     VLC_COMMON_MEMBERS
 132
 133     int                         i_dialogs;      //< Number of dialogs
 134     interaction_dialog_t      **pp_dialogs;     //< Dialogs
 135
 136     intf_thread_t              *p_intf;         //< Interface to use
 137
 138     int                         i_last_id;      //< Last attributed ID
 139 };
 140 /**
 141  * Possible actions
 142  */
 143 enum
 144 {
 145     INTERACT_NEW,
 146     INTERACT_UPDATE,
 147     INTERACT_HIDE,
 148     INTERACT_DESTROY
 149 };
 150
 151 /***************************************************************************
 152  * Exported symbols
 153  ***************************************************************************/
 154
 155 #define intf_Interact( a,b ) __intf_Interact( VLC_OBJECT(a), b )
 156 VLC_EXPORT( int,__intf_Interact,( vlc_object_t *,interaction_dialog_t * ) );
 157
 158 #define intf_UserFatal( a, c, d, e... ) __intf_UserFatal( a,c,d, ## e )
 159 VLC_EXPORT( void, __intf_UserFatal,( vlc_object_t*, const char*, const char*, ...) );
 160 #define intf_UserLoginPassword( a, b, c, d, e... ) __intf_UserLoginPassword( a,b,c,d,e)
 161 VLC_EXPORT( int, __intf_UserLoginPassword,( vlc_object_t*, const char*, const char*, char **, char **) );
 162
 163 VLC_EXPORT( void, intf_InteractionManage,( playlist_t *) );
 164 VLC_EXPORT( void, intf_InteractionDestroy,( interaction_t *) );