vlc_dialog.h File Reference

User interaction dialog APIs. More...

Include dependency graph for vlc_dialog.h:

Go to the source code of this file.

Data Structures
struct	dialog_fatal_t
	A fatal error dialog. More...
struct	dialog_login_t
	A login dialog. More...
struct	dialog_question_t
	A question dialog. More...
struct	dialog_progress_bar_t
Defines
#define	dialog_Fatal(o, t,...)   dialog_Fatal(VLC_OBJECT(o), t, __VA_ARGS__)
#define	dialog_FatalWait(o, t,...)   dialog_FatalWait(VLC_OBJECT(o), t, __VA_ARGS__)
#define	dialog_Login(o, u, p, t,...)   dialog_Login(VLC_OBJECT(o), u, p, t, __VA_ARGS__)
#define	dialog_Question(o, t, m, y, n, c)   dialog_Question(VLC_OBJECT(o), t, m, y, n, c)
#define	dialog_ProgressCreate(o, t, m, c)   dialog_ProgressCreate(VLC_OBJECT(o), t, m, c)
#define	dialog_Register(o)   dialog_Register(VLC_OBJECT(o))
#define	dialog_Unregister(o)   dialog_Unregister(VLC_OBJECT(o))
Functions
void	dialog_VFatal (vlc_object_t *, bool, const char *, const char *, va_list)
	Sends an error message through the user interface (if any).
static void	dialog_Fatal (vlc_object_t *obj, const char *title, const char *fmt,...)
static void	dialog_FatalWait (vlc_object_t *obj, const char *title, const char *fmt,...)
void	dialog_Login (vlc_object_t *, char **, char **, const char *, const char *,...)
	Requests a username and password through the user interface.
int	dialog_Question (vlc_object_t *, const char *, const char *, const char *, const char *, const char *)
	Asks a total (Yes/No/Cancel) question through the user interface.
dialog_progress_bar_t *	dialog_ProgressCreate (vlc_object_t *, const char *, const char *, const char *)
	Creates a progress bar dialog.
void	dialog_ProgressDestroy (dialog_progress_bar_t *)
void	dialog_ProgressSet (dialog_progress_bar_t *, const char *, float)
bool	dialog_ProgressCancelled (dialog_progress_bar_t *)
int	dialog_Register (vlc_object_t *)
	Registers an object as the dialog provider.
int	dialog_Unregister (vlc_object_t *)
	Unregisters the dialog provider.

---

Detailed Description

User interaction dialog APIs.

---

Define Documentation

#define dialog_Fatal	(	o,
		t,
		...		)	dialog_Fatal(VLC_OBJECT(o), t, __VA_ARGS__)

Referenced by Add(), aout_FiltersCreatePipeline(), Block(), CDDAReadBlocks(), CommonOpen(), DecoderUnsupportedCodec(), Demux(), Handshake(), Init(), input_DecoderNew(), input_DecoderSetCcState(), InputSourceInit(), Login(), Manage(), Open(), open_file(), OpenAnalog(), OpenDevice(), ParseMRL(), Read(), RtspConnect(), Run(), and VLCSimplePrefs::saveChangedSettings.

#define dialog_FatalWait	(	o,
		t,
		...		)	dialog_FatalWait(VLC_OBJECT(o), t, __VA_ARGS__)

Referenced by Open(), and ParseMRL().

#define dialog_Login	(	o,
		u,
		p,
		t,
		...		)	dialog_Login(VLC_OBJECT(o), u, p, t, __VA_ARGS__)

Referenced by Connect(), Open(), and OpenWithCookies().

#define dialog_ProgressCreate	(	o,
		t,
		m,
		c		)	dialog_ProgressCreate(VLC_OBJECT(o), t, m, c)

Referenced by AssHandleHold(), AVI_IndexCreate(), Create(), and scan_Next().

#define dialog_Question	(	o,
		t,
		m,
		y,
		n,
		c		)	dialog_Question(VLC_OBJECT(o), t, m, y, n, c)

#define dialog_Register

(

o

)

dialog_Register(VLC_OBJECT(o))

Referenced by DialogHandler::DialogHandler().

#define dialog_Unregister

(

o

)

dialog_Unregister(VLC_OBJECT(o))

Referenced by VLCMain::applicationWillTerminate:, and DialogHandler::~DialogHandler().

---

Function Documentation

static void dialog_Fatal	(	vlc_object_t *	obj,
		const char *	title,
		const char *	fmt,
			...
	)			[inline, static]

References dialog_VFatal().

static void dialog_FatalWait	(	vlc_object_t *	obj,
		const char *	title,
		const char *	fmt,
			...
	)			[inline, static]

References dialog_VFatal().

void dialog_Login	(	vlc_object_t *	obj,
		char **	username,
		char **	password,
		const char *	title,
		const char *	fmt,
			...
	)

Requests a username and password through the user interface.

Parameters:

	obj	the VLC object requesting credential informations
	username	a pointer to the specified username [OUT]
	password	a pointer to the specified password [OUT]
	title	title for the dialog
	text	format string for the message in the dialog

Returns:

Nothing. If a user name resp. a password was specified, it will be returned as a heap-allocated character array into the username resp password pointer. Those must be freed with free(). Otherwise *username resp *password will be NULL.

References dialog_GetProvider(), vlc_object_t::i_flags, OBJECT_FLAGS_NOINTERACT, text, var_SetAddress, vasprintf(), and vlc_object_release.

bool dialog_ProgressCancelled

(

dialog_progress_bar_t *

)

References dialog_progress_bar_t::p_sys, and dialog_progress_bar_t::pf_check.

Referenced by AVI_IndexCreate(), and scan_IsCancelled().

dialog_progress_bar_t* dialog_ProgressCreate	(	vlc_object_t *	,
		const char *	,
		const char *	,
		const char *
	)

Creates a progress bar dialog.

References dialog_progress_bar_t::cancel, dialog_GetProvider(), vlc_object_t::i_flags, dialog_progress_bar_t::message, OBJECT_FLAGS_NOINTERACT, dialog_progress_bar_t::pf_check, dialog_progress_bar_t::pf_destroy, dialog_progress_bar_t::pf_update, dialog_progress_bar_t::title, var_SetAddress, and vlc_object_release.

void dialog_ProgressDestroy

(

dialog_progress_bar_t *

)

References dialog_progress_bar_t::p_sys, and dialog_progress_bar_t::pf_destroy.

Referenced by AssHandleHold(), AVI_IndexCreate(), Create(), and scan_Clean().

void dialog_ProgressSet	(	dialog_progress_bar_t *	,
		const char *	,
		float
	)

References dialog_progress_bar_t::p_sys, and dialog_progress_bar_t::pf_update.

Referenced by AssHandleHold(), AVI_IndexCreate(), Create(), and scan_Next().

int dialog_Question	(	vlc_object_t *	obj,
		const char *	title,
		const char *	text,
		const char *	yes,
		const char *	no,
		const char *	cancel
	)

Asks a total (Yes/No/Cancel) question through the user interface.

Parameters:

	obj	VLC object emitting the question
	title	dialog box title
	text	dialog box text
	yes	first choice/button text
	no	second choice/button text
	cancel	third answer/button text, or NULL if no third option

Returns:

0 if the user could not answer the question (e.g. there is no UI), 1, 2 resp. 3 if the user pressed the first, second resp. third button.

References dialog_question_t::answer, dialog_GetProvider(), vlc_object_t::i_flags, OBJECT_FLAGS_NOINTERACT, var_SetAddress, and vlc_object_release.

int dialog_Register

(

vlc_object_t *

obj

)

Registers an object as the dialog provider.

It is assumed that the appropriate variable callbacks are already registered.

References libvlc_priv(), libvlc_priv_t::p_dialog_provider, vlc_object_t::p_libvlc, provider_lock, VLC_EGENERIC, vlc_mutex_lock(), vlc_mutex_unlock(), and VLC_SUCCESS.

int dialog_Unregister

(

vlc_object_t *

obj

)

Unregisters the dialog provider.

Note that unless you have unregistered the callbacks already, the provider might still be in use by other threads. Also, you need to cancel all pending dialogs yourself.

References libvlc_priv(), libvlc_priv_t::p_dialog_provider, vlc_object_t::p_libvlc, provider_lock, VLC_EGENERIC, vlc_mutex_lock(), vlc_mutex_unlock(), and VLC_SUCCESS.

void dialog_VFatal	(	vlc_object_t *	obj,
		bool	modal,
		const char *	title,
		const char *	fmt,
		va_list	ap
	)

Sends an error message through the user interface (if any).

Parameters:

	obj	the VLC object emitting the error
	modal	whether to wait for user to acknowledge the error before returning control to the caller
	title	title of the error dialog
	fmt	format string for the error message
	ap	parameters list for the formatted error message

References dialog_GetProvider(), vlc_object_t::i_flags, msg_Err, msg_GenericVa, OBJECT_FLAGS_NOINTERACT, text, var_SetAddress, vasprintf(), VLC_MSG_ERR, and vlc_object_release.

Referenced by dialog_Fatal(), and dialog_FatalWait().