* $Id$
*
* Authors: Clément Stenac <zorglub@videolan.org>
+ * Felix Kühne <fkuehne@videolan.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* \param p_interact the interaction element
* \return VLC_SUCCESS or an error code
*/
-int __intf_Interact( vlc_object_t *p_this, interaction_dialog_t *
- p_dialog )
+int __intf_Interact( vlc_object_t *p_this, interaction_dialog_t *p_dialog )
{
interaction_t *p_interaction = intf_InteractionGet( p_this );
p_dialog->i_id = ++p_interaction->i_last_id;
}
- if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT )
- {
- return VLC_EGENERIC;
- }
+ if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT ) return VLC_EGENERIC;
+
+ if( !config_GetInt(p_this, "interact") ) return VLC_EGENERIC;
p_dialog->p_interaction = p_interaction;
p_dialog->p_parent = p_this;
// 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
if( p_dialog->i_status == HIDDEN_DIALOG )
}
-
#define INTERACT_INIT( new ) \
new = (interaction_dialog_t*)malloc( \
sizeof( interaction_dialog_t ) ); \
- new->i_widgets = 0; \
- new->pp_widgets = NULL; \
new->psz_title = NULL; \
new->psz_description = NULL; \
+ new->psz_defaultButton = NULL; \
+ new->psz_alternateButton = NULL; \
+ new->psz_otherButton = NULL; \
+ new->i_timeToGo = 0; \
+ new->b_cancelled = VLC_FALSE; \
+ new->p_private = NULL; \
new->i_id = 0; \
new->i_flags = 0; \
new->i_status = NEW_DIALOG;
if( new->psz_title ) free( new->psz_title ); \
if( new->psz_description ) free( new->psz_description );
-/** Helper function to send an error message
+/** Helper function to send an error message, both in a blocking and non-blocking way
* \param p_this Parent vlc_object
- * \param i_id A predefined ID, 0 if not applicable
+ * \param b_blocking Is this dialog blocking or not?
* \param psz_title Title for the dialog
* \param psz_format The message to display
* */
void __intf_UserFatal( vlc_object_t *p_this,
+ vlc_bool_t b_blocking,
const char *psz_title,
const char *psz_format, ... )
{
va_list args;
interaction_dialog_t *p_new = NULL;
- user_widget_t *p_widget = NULL;
- int i_id = DIALOG_ERRORS;
+
+ INTERACT_INIT( p_new );
+
+ p_new->psz_title = strdup( psz_title );
- if( i_id > 0 )
- {
- p_new = intf_InteractionGetById( p_this, i_id );
- }
- if( !p_new )
- {
- INTERACT_INIT( p_new );
- if( i_id > 0 ) p_new->i_id = i_id ;
- }
+ va_start( args, psz_format );
+ vasprintf( &p_new->psz_description, psz_format, args );
+ va_end( args );
+
+ if( b_blocking )
+ p_new->i_flags = DIALOG_BLOCKING_ERROR;
else
- {
- p_new->i_status = UPDATED_DIALOG;
- }
+ p_new->i_flags = DIALOG_NONBLOCKING_ERROR;
- p_new->i_flags |= DIALOG_REUSABLE;
+ intf_Interact( p_this, p_new );
+}
- p_new->i_type = INTERACT_DIALOG_ONEWAY;
+/** Helper function to send an warning, which is always shown non-blocking
+ * \param p_this Parent vlc_object
+ * \param psz_title Title for the dialog
+ * \param psz_format The message to display
+ * */
+void __intf_UserWarn( vlc_object_t *p_this,
+ const char *psz_title,
+ const char *psz_format, ... )
+{
+ va_list args;
+ interaction_dialog_t *p_new = NULL;
+
+ INTERACT_INIT( p_new );
+
p_new->psz_title = strdup( psz_title );
- p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) );
-
- p_widget->i_type = WIDGET_TEXT;
- p_widget->val.psz_string = NULL;
-
va_start( args, psz_format );
- vasprintf( &p_widget->psz_text, psz_format, args );
+ vasprintf( &p_new->psz_description, psz_format, args );
va_end( args );
- INSERT_ELEM ( p_new->pp_widgets,
- p_new->i_widgets,
- p_new->i_widgets,
- p_widget );
-
- p_new->i_flags |= DIALOG_CLEAR_NOSHOW;
+ p_new->i_flags = DIALOG_WARNING;
intf_Interact( p_this, p_new );
}
-/** Helper function to ask a yes-no question
+/** Helper function to ask a yes-no-cancel question
* \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,
- const char *psz_description )
+ const char *psz_description,
+ const char *psz_default,
+ const char *psz_alternate,
+ const char *psz_other )
{
int i_ret;
interaction_dialog_t *p_new = NULL;
- user_widget_t *p_widget = NULL;
INTERACT_INIT( p_new );
p_new->i_type = INTERACT_DIALOG_TWOWAY;
p_new->psz_title = strdup( psz_title );
-
- /* Text */
- p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) );
- p_widget->i_type = WIDGET_TEXT;
- p_widget->psz_text = strdup( psz_description );
- p_widget->val.psz_string = NULL;
- INSERT_ELEM ( p_new->pp_widgets, p_new->i_widgets,
- p_new->i_widgets, p_widget );
-
+ p_new->psz_description = strdup( psz_description );
p_new->i_flags = DIALOG_YES_NO_CANCEL;
+ p_new->psz_defaultButton = strdup( psz_default );
+ p_new->psz_alternateButton = strdup( psz_alternate );
+ if( psz_other )
+ p_new->psz_otherButton = strdup( psz_other );
+ else
+ p_new->psz_otherButton = NULL;
i_ret = intf_Interact( p_this, p_new );
return i_ret;
}
-/** Helper function to make a progressbar box
+/** Helper function to create a dialogue showing a progress-bar with some info
* \param p_this Parent vlc_object
* \param psz_title Title for the dialog
* \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
*/
int __intf_UserProgress( vlc_object_t *p_this,
const char *psz_title,
const char *psz_status,
- float f_pos )
+ float f_pos,
+ int i_time )
{
int i_ret;
interaction_dialog_t *p_new = NULL;
- user_widget_t *p_widget = NULL;
INTERACT_INIT( p_new );
p_new->i_type = INTERACT_DIALOG_ONEWAY;
p_new->psz_title = strdup( psz_title );
+ p_new->psz_description = strdup( psz_status );
+ p_new->val.f_float = f_pos;
+ p_new->i_timeToGo = i_time;
- /* Progress bar */
- p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) );
- p_widget->i_type = WIDGET_PROGRESS;
- p_widget->psz_text = strdup( psz_status );
- p_widget->val.f_float = f_pos;
- INSERT_ELEM ( p_new->pp_widgets, p_new->i_widgets,
- p_new->i_widgets, p_widget );
+ p_new->i_flags = DIALOG_USER_PROGRESS;
i_ret = intf_Interact( p_this, p_new );
return p_new->i_id;
}
-/** Update a progress bar
+/** Update a progress bar in a dialogue
* \param p_this Parent vlc_object
* \param i_id Identifier of the dialog
* \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,
- const char *psz_status, float f_pos )
+ const char *psz_status, float f_pos,
+ int i_time )
{
interaction_t *p_interaction = intf_InteractionGet( p_this );
interaction_dialog_t *p_dialog;
vlc_mutex_lock( &p_interaction->object_lock );
p_dialog = intf_InteractionGetById( p_this, i_id );
- if( !p_dialog || p_dialog->i_status == NEW_DIALOG )
+ if( !p_dialog )
{
vlc_mutex_unlock( &p_interaction->object_lock ) ;
return;
}
- if( p_dialog->pp_widgets[0]->psz_text )
- free( p_dialog->pp_widgets[0]->psz_text );
- p_dialog->pp_widgets[0]->psz_text = strdup( psz_status );
+ if( p_dialog->psz_description )
+ free( p_dialog->psz_description );
+ p_dialog->psz_description = strdup( psz_status );
- p_dialog->pp_widgets[0]->val.f_float = f_pos;
+ 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 make a login/password box
+/** 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;
+}
+
+/** Helper function to make a login/password dialogue
* \param p_this Parent vlc_object
* \param psz_title Title for the dialog
* \param psz_description A description
char **ppsz_login,
char **ppsz_password )
{
+
int i_ret;
interaction_dialog_t *p_new = NULL;
- user_widget_t *p_widget = NULL;
INTERACT_INIT( p_new );
p_new->i_type = INTERACT_DIALOG_TWOWAY;
p_new->psz_title = strdup( psz_title );
+ p_new->psz_description = strdup( psz_description );
- /* Text */
- p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) );
- p_widget->i_type = WIDGET_TEXT;
- p_widget->psz_text = strdup( psz_description );
- p_widget->val.psz_string = NULL;
- INSERT_ELEM ( p_new->pp_widgets, p_new->i_widgets,
- p_new->i_widgets, p_widget );
-
- /* Login */
- p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) );
- p_widget->i_type = WIDGET_INPUT_TEXT;
- p_widget->psz_text = strdup( _("Login") );
- p_widget->val.psz_string = NULL;
- INSERT_ELEM ( p_new->pp_widgets, p_new->i_widgets,
- p_new->i_widgets, p_widget );
-
- /* Password */
- p_widget = (user_widget_t* )malloc( sizeof( user_widget_t ) );
- p_widget->i_type = WIDGET_INPUT_TEXT;
- p_widget->psz_text = strdup( _("Password") );
- p_widget->val.psz_string = NULL;
- INSERT_ELEM ( p_new->pp_widgets, p_new->i_widgets,
- p_new->i_widgets, p_widget );
-
- p_new->i_flags = DIALOG_OK_CANCEL;
+ p_new->i_flags = DIALOG_LOGIN_PW_OK_CANCEL;
i_ret = intf_Interact( p_this, p_new );
if( i_ret != DIALOG_CANCELLED )
{
- *ppsz_login = strdup( p_new->pp_widgets[1]->val.psz_string );
- *ppsz_password = strdup( p_new->pp_widgets[2]->val.psz_string );
+ *ppsz_login = strdup( p_new->psz_returned[0] );
+ *ppsz_password = strdup( p_new->psz_returned[1] );
}
return i_ret;
}
+/** Helper function to make a dialogue asking the user for !password string
+ * \param p_this Parent vlc_object
+ * \param psz_title Title for the dialog
+ * \param psz_description A description
+ * \param ppsz_usersString Returned login
+ * \return Clicked button code
+ */
+int __intf_UserStringInput( vlc_object_t *p_this,
+ const char *psz_title,
+ const char *psz_description,
+ char **ppsz_usersString )
+{
+
+ int i_ret;
+ interaction_dialog_t *p_new = NULL;
+
+ INTERACT_INIT( p_new );
+
+ p_new->i_type = INTERACT_DIALOG_TWOWAY;
+ p_new->psz_title = strdup( psz_title );
+ p_new->psz_description = strdup( psz_description );
+
+ p_new->i_flags = DIALOG_PSZ_INPUT_OK_CANCEL;
+
+ i_ret = intf_Interact( p_this, p_new );
+
+ if( i_ret != DIALOG_CANCELLED )
+ {
+ *ppsz_usersString = strdup( p_new->psz_returned[0] );
+ }
+ return i_ret;
+}
+
+/** Helper function to create a progress-bar in the main interface with a
+ * single-line description
+ * \param p_this Parent vlc_object
+ * \param psz_status Current status
+ * \param f_position Current position (0.0->100.0)
+ * \return Dialog id, to give to IntfProgressUpdate
+ */
+int __intf_IntfProgress( vlc_object_t *p_this,
+ const char *psz_status,
+ float f_pos )
+{
+ int i_ret;
+ interaction_dialog_t *p_new = NULL;
+
+ INTERACT_INIT( p_new );
+
+ p_new->i_type = INTERACT_DIALOG_ONEWAY;
+ p_new->psz_description = strdup( psz_status );
+ p_new->val.f_float = f_pos;
+
+ p_new->i_flags = DIALOG_INTF_PROGRESS;
+
+ i_ret = intf_Interact( p_this, p_new );
+
+ return p_new->i_id;
+}
+
+/** Update the progress bar in the main interface
+ * \param p_this Parent vlc_object
+ * \param i_id Identifier of the dialog
+ * \param psz_status New status
+ * \param f_position New position (0.0->100.0)
+ * \return nothing
+ */
+void __intf_IntfProgressUpdate( vlc_object_t *p_this, int i_id,
+ const char *psz_status, float f_pos )
+{
+ interaction_t *p_interaction = intf_InteractionGet( p_this );
+ interaction_dialog_t *p_dialog;
+
+ if( !p_interaction ) return;
+
+ 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;
+ }
+
+ if( p_dialog->psz_description )
+ free( p_dialog->psz_description );
+ p_dialog->psz_description = strdup( psz_status );
+
+ p_dialog->val.f_float = f_pos;
+
+ p_dialog->i_status = UPDATED_DIALOG;
+ vlc_mutex_unlock( &p_interaction->object_lock) ;
+}
+
/** Hide an interaction dialog
* \param p_this the parent vlc object
* \param i_id the id of the item to hide
{
interaction_t *p_interaction;
- msg_Dbg( p_playlist, "initializing interaction system" );
-
p_interaction = vlc_object_create( VLC_OBJECT( p_playlist ),
sizeof( interaction_t ) );
if( !p_interaction )
p_list = vlc_list_find( p_interaction, VLC_OBJECT_INTF, FIND_ANYWHERE );
if( !p_list )
{
- msg_Err( p_interaction, "Unable to create module list" );
+ msg_Err( p_interaction, "unable to create module list" );
return;
}
static void intf_InteractionDialogDestroy( interaction_dialog_t *p_dialog )
{
- int i;
- for( i = p_dialog->i_widgets - 1 ; i >= 0 ; i-- )
- {
- user_widget_t *p_widget = p_dialog->pp_widgets[i];
- FREE( p_widget->psz_text );
- if( p_widget->i_type == WIDGET_INPUT_TEXT )
- {
- FREE( p_widget->val.psz_string );
- }
-
- REMOVE_ELEM( p_dialog->pp_widgets, p_dialog->i_widgets, i );
- free( p_widget );
- }
FREE( p_dialog->psz_title );
FREE( p_dialog->psz_description );
+ FREE( p_dialog->psz_defaultButton );
+ FREE( p_dialog->psz_alternateButton );
+ FREE( p_dialog->psz_otherButton );
free( p_dialog );
}
projects / vlc / blobdiff