Changeset 6cb1101a9144409fe27ffd7984c58f33b66eb78c

Timestamp:

07/29/06 17:07:42 (2 years ago)

Author:

Felix Paul Kühne <fkuehne@videolan.org>

git-committer:

Felix Paul Kühne <fkuehne@videolan.org> 1154185662 +0000

git-parent:

[87a71d24f916ba528c1ec7b545dfb6c58433567c]

git-author:

Felix Paul Kühne <fkuehne@videolan.org> 1154185662 +0000

Message:

* enhanced the interaction core with some method additions/changes
- intf_UserProgress* takes an additional argument now. use it to provide the time to go (in sec) until the process will be finished. Provide 0, if you don't have such info. The interface will hide the respective text-field.
- intf_UserProgressIsCancelled can be called by the module which triggered the interaction dialogue on a regular interval, to check if the user cancelled the dialogue or not. This is for dialogues with an optional cancel-button only (like the modal progress panel), so it doesn't replace p_dialog->i_return = DIALOG_CANCELLED which is for yes/no-style dialogues
- intf_UserOkayCancel was removed in favour of an enhanced intf_UserYesNo
- intf_UserYesNo takes 3 additional arguments now to get the custom captions of the default (~Yes), alternate(~No) and one optional button(~Cancel). This provides a better interface experience for the user and is more compliant with OSX's HIGL. The interface automatically hides the 3rd button, if NULL is given.

Files:

• extras/MacOSX/Resources/English.lproj/Interaction.nib/classes.nib (modified) (2 diffs)
• extras/MacOSX/Resources/English.lproj/Interaction.nib/info.nib (modified) (1 diff)
• extras/MacOSX/Resources/English.lproj/Interaction.nib/keyedobjects.nib (modified) (previous)
• include/vlc_interaction.h (modified) (6 diffs)
• modules/demux/avi/avi.c (modified) (1 diff)
• modules/gui/macosx/interaction.h (modified) (3 diffs)
• modules/gui/macosx/interaction.m (modified) (7 diffs)
• modules/services_discovery/shout.c (modified) (2 diffs)
• src/interface/interaction.c (modified) (8 diffs)
• src/misc/update.c (modified) (3 diffs)

extras/MacOSX/Resources/English.lproj/Interaction.nib/classes.nib

@@ -3 +3 @@
-        {CLASS = FirstResponder; LANGUAGE = ObjC; SUPERCLASS = NSObject; }, 
-        {
-
+cancelDialog = id; 
-            CLASS = VLCInteraction; 
-            LANGUAGE = ObjC; 
@@ -25 +25 @@
-                "o_prog_cancel_btn" = id; 
-                "o_prog_description" = id; 
+                "o_prog_timeToGo" = id; 
-                "o_prog_title" = id; 
-                "o_prog_win" = id; 

extras/MacOSX/Resources/English.lproj/Interaction.nib/info.nib

@@ -9 +9 @@
-    <key>IBOpenObjects</key>
-    <array>
-        <integer>5</integer>
-        <integer>55</integer>
-        <integer>79</integer>
+        <integer>5</integer>
-    </array>
-    <key>IBSystem Version</key>

include/vlc_interaction.h

@@ -25 +25 @@
-/**
- * This structure describes an interaction widget
+ * WIDGETS ARE OUTDATED! THIS IS ONLY A STUB TO KEEP WX COMPILING!
- */
-struct user_widget_t
@@ -36 +37 @@
-/**
- * Possible widget types
+ * WIDGETS ARE OUTDATED! THIS IS ONLY A STUB TO KEEP WX COMPILING!
- */
-enum
@@ -53 +55 @@
-    char           *psz_title;          ///< Title
-    char           *psz_description;    ///< Descriptor string
+    char           *psz_defaultButton;  ///< default button title (~OK)
+    char           *psz_alternateButton;///< alternate button title (~NO)
+    char           *psz_otherButton;    ///< other button title (optional,~Cancel)
-
-    char           *psz_returned[1];    ///< returned responses from the user
-
-    vlc_value_t     val;                ///< a value coming from core for dialogue
+    int             i_timeToGo;         ///< time (in sec) until shown progress is finished
+    vlc_bool_t      b_cancelled;        ///< was the dialogue cancelled by the user?
-
-    int             i_widgets;          ///< Number of dialog widgets
@@ -77 +84 @@
- */
-#define DIALOG_REUSABLE             0x01
-#define DIALOG_OK_CANCEL            0x02
-#define DIALOG_YES_NO               0x04
-#define DIALOG_YES_NO_CANCEL        0x04
-#define DIALOG_CLEAR_NOSHOW         0x08
@@ -170 +175 @@
-#define intf_UserLoginPassword( a, b, c, d, e... ) __intf_UserLoginPassword( VLC_OBJECT(a),b,c,d,e)
-VLC_EXPORT( int, __intf_UserLoginPassword,( vlc_object_t*, const char*, const char*, char **, char **) );
-
-
-
-
+
+
-
-
-
-
-
+
+
+
+
+
+
-
-#define intf_UserStringInput( a, b, c, d ) __intf_UserStringInput( VLC_OBJECT(a),b,c,d )
@@ -185 +190 @@
-#define intf_IntfProgress( a, b, c ) __intf_IntfProgress( VLC_OBJECT(a),b,c )
-VLC_EXPORT( int, __intf_IntfProgress,( vlc_object_t*, const char*, float) );
- 
+
-VLC_EXPORT( void, __intf_IntfProgressUpdate,( vlc_object_t*, int, const char*, float) );
-

modules/demux/avi/avi.c

@@ -559 +559 @@
-                        _( "This AVI file is broken. Seeking will not "
-                        "work correctly.\nDo you want to "
-
+
+
-            if( i_create == DIALOG_OK_YES )
-            {

modules/gui/macosx/interaction.h

@@ -32 +32 @@
-@interface VLCInteraction : NSObject
-{
-widget
+dialogue
-    IBOutlet id o_prog_bar;
-    IBOutlet id o_prog_cancel_btn;
@@ -38 +38 @@
-    IBOutlet id o_prog_title;
-    IBOutlet id o_prog_win;
+    IBOutlet id o_prog_timeToGo;
-
-    /* authentication dialogue */
@@ -66 +67 @@
-- (IBAction)cancelAndClose:(id)sender;
-- (IBAction)okayAndClose:(id)sender;
+- (IBAction)cancelDialog:(id)sender;
-
--(id)initDialog: (interaction_dialog_t *)_p_dialog;

modules/gui/macosx/interaction.m

@@ -131 +131 @@
-    NSString *o_title = [NSString stringWithUTF8String:p_dialog->psz_title ? p_dialog->psz_title : "title"];
-    NSString *o_description = [NSString stringWithUTF8String:p_dialog->psz_description ? p_dialog->psz_description : ""];
-
+
+
+
+
-    vout_thread_t *p_vout = vlc_object_find( VLCIntf, VLC_OBJECT_VOUT, FIND_ANYWHERE );
-    if( p_vout != NULL )
@@ -170 +173 @@
-    else
-    {
-
-
-
-
-
-
-
-
-
+
-        {
-            msg_Dbg( p_intf, "yes-no-cancel-dialog requested" );
-_NS("Yes"), _NS("No"),
-_NS("Cancel")
+o_defaultButton, 
+o_alternateButton, o_otherButton
-                @selector(sheetDidEnd: returnCode: contextInfo:), NULL, nil, 
-                o_description );
@@ -203 +198 @@
-            [o_prog_description setStringValue: o_description];
-            [o_prog_bar setDoubleValue: (double)p_dialog->val.f_float];
+            if( p_dialog->i_timeToGo < 1 )
+                [o_prog_timeToGo setStringValue: @""];
+            else
+                [o_prog_timeToGo setStringValue: [NSString stringWithFormat:
+                    _NS("Remaining time: %i seconds"), p_dialog->i_timeToGo]];
-            [NSApp beginSheet: o_prog_win modalForWindow: o_window
-                modalDelegate: self didEndSelector: nil contextInfo: nil];
@@ -240 +240 @@
-        p_dialog->i_return = DIALOG_OK_YES;
-    }
-    else if( i_return == NSAlertAlternateReturn && ( p_dialog->i_flags & DIALOG_OK_CANCEL ) )
-    {
-        p_dialog->i_return = DIALOG_CANCELLED;
-    }
-    else if( i_return == NSAlertAlternateReturn )
-    {
@@ -269 +265 @@
-            [self hideDialog];
-        }
+
+        if( p_dialog->i_timeToGo < 1 )
+            [o_prog_timeToGo setStringValue: @""];
+        else
+            [o_prog_timeToGo setStringValue: [NSString stringWithFormat:
+                    _NS("Remaining time: %i seconds"), p_dialog->i_timeToGo]];
+
-        return;
-    }
@@ -322 +325 @@
-- (IBAction)cancelAndClose:(id)sender
-{
-
+in a yes/no-style dialogue 
-    vlc_mutex_lock( &p_dialog->p_interaction->object_lock );
-    p_dialog->i_return = DIALOG_CANCELLED;
@@ -328 +331 @@
-    vlc_mutex_unlock( &p_dialog->p_interaction->object_lock );
-    msg_Dbg( p_intf, "dialog cancelled" );
+}
+
+- (IBAction)cancelDialog:(id)sender
+{
+    /* tell core that the user wishes to cancel the dialogue
+     * Use this function if cancelling is optionally like in the progress-dialogue */
+    vlc_mutex_lock( &p_dialog->p_interaction->object_lock );
+    p_dialog->b_cancelled = VLC_TRUE;
+    vlc_mutex_unlock( &p_dialog->p_interaction->object_lock );
+    msg_Dbg( p_intf, "cancelling dialog, will close it later on" );
-}
-

modules/services_discovery/shout.c

@@ -197 +197 @@
-    int i_dialog_id;
-
-
+, 0
-
-    p_sys->b_dialog = VLC_TRUE;
@@ -216 +216 @@
-                              260 /* gruiiik FIXME */;
-                intf_UserProgressUpdate( p_sd, i_dialog_id, "Downloading",
-
+, 0
-            }
-            vlc_object_release( p_input );

src/interface/interaction.c

@@ -144 +144 @@
-            // Give default answer
-            p_dialog->i_return = DIALOG_DEFAULT;
-            if( p_dialog->i_flags & DIALOG_OK_CANCEL )
-                p_dialog->i_return = DIALOG_CANCELLED;
-
-            // Pretend we have hidden and destroyed it
@@ -276 +274 @@
-}
-
-
+-cancel
- *  \param p_this           Parent vlc_object
- *  \param psz_title        Title for the dialog
- *  \param psz_description  A description
+ *  \param psz_default      caption for the default button
+ *  \param psz_alternate    caption for the alternate button
+ *  \param psz_other        caption for the optional 3rd button (== cancel)
- *  \return                 Clicked button code
- */
-int __intf_UserYesNo( vlc_object_t *p_this,
-                      const char *psz_title,
-
+
+
+
+
-{
-    int i_ret;
@@ -295 +299 @@
-    p_new->psz_description = strdup( psz_description );
-    p_new->i_flags = DIALOG_YES_NO_CANCEL;
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-
-    i_ret = intf_Interact( p_this, p_new );
@@ -331 +316 @@
- *  \param psz_status       Current status
- *  \param f_position       Current position (0.0->100.0)
+ *  \param i_timeToGo       Time (in sec) to go until process is finished
- *  \return                 Dialog id, to give to UserProgressUpdate
- */
@@ -336 +322 @@
-                         const char *psz_title,
-                         const char *psz_status,
-
+
+
-{
-    int i_ret;
@@ -347 +334 @@
-    p_new->psz_description = strdup( psz_status );
-    p_new->val.f_float = f_pos;
+    p_new->i_timeToGo = i_time;
-
-    p_new->i_flags = DIALOG_USER_PROGRESS;
@@ -360 +348 @@
- *  \param psz_status       New status
- *  \param f_position       New position (0.0->100.0)
+ *  \param i_timeToGo       Time (in sec) to go until process is finished
- *  \return                 nothing
- */
-void __intf_UserProgressUpdate( vlc_object_t *p_this, int i_id,
-
+
+
-{
-    interaction_t *p_interaction = intf_InteractionGet( p_this );
@@ -384 +374 @@
-
-    p_dialog->val.f_float = f_pos;
+    p_dialog->i_timeToGo = i_time;
-
-    p_dialog->i_status = UPDATED_DIALOG;
-    vlc_mutex_unlock( &p_interaction->object_lock) ;
+}
+
+/** Helper function to communicate dialogue cancellations between the intf-module and caller
+ *  \param p_this           Parent vlc_object
+ *  \param i_id             Identifier of the dialogue
+ *  \return                 Either true or false
+ */
+vlc_bool_t __intf_UserProgressIsCancelled( vlc_object_t *p_this, int i_id )
+{
+    interaction_t *p_interaction = intf_InteractionGet( p_this );
+    interaction_dialog_t *p_dialog;
+
+    if( !p_interaction ) return VLC_TRUE;
+
+    vlc_mutex_lock( &p_interaction->object_lock );
+    p_dialog  =  intf_InteractionGetById( p_this, i_id );
+
+    if( !p_dialog )
+    {
+        vlc_mutex_unlock( &p_interaction->object_lock ) ;
+        return VLC_TRUE;
+    }
+
+    vlc_mutex_unlock( &p_interaction->object_lock) ;
+    return p_dialog->b_cancelled;
-}
-

src/misc/update.c

@@ -1265 +1265 @@
-              p_this->psz_status, 0.0 );
-    i_progress = intf_UserProgress( p_vlc, "Downloading...",
-
+, 0
-
-    p_stream = stream_UrlNew( p_vlc, psz_src );
@@ -1310 +1310 @@
-
-                intf_UserProgressUpdate( p_vlc, i_progress,
-
+, 0
-            }
-
@@ -1322 +1322 @@
-                       p_this->psz_status, psz_s2 );
-            free( psz_s2 );
-
+, 0
-            free( psz_status );
-        }