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

Macros
#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,...)   dialog_Question(VLC_OBJECT(o), t, m, y, n, __VA_ARGS__)
#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))

Typedefs
typedef struct dialog_fatal_t	dialog_fatal_t
	A fatal error dialog.
typedef struct dialog_login_t	dialog_login_t
	A login dialog.
typedef struct dialog_question_t	dialog_question_t
	A question dialog.
typedef struct dialog_progress_bar_t	dialog_progress_bar_t

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 *,...)
int	dialog_Question (vlc_object_t *, const char *, const char *, const char *, const char *, const char *,...)
dialog_progress_bar_t *	dialog_ProgressCreate (vlc_object_t *, const char *, const char *, const char *)
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 *)
int	dialog_Unregister (vlc_object_t *)

Detailed Description

User interaction dialog APIs.

Macro Definition Documentation

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

Referenced by aout_FiltersPipelineCreate(), decoder_New(), DecoderUnsupportedCodec(), input_DecoderSetCcState(), and InputSourceInit().

#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_ProgressCreate	(		o,
			t,
			m,
			c
	)		dialog_ProgressCreate(VLC_OBJECT(o), t, m, c)

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

#define dialog_Register

(

o

)

dialog_Register(VLC_OBJECT(o))

#define dialog_Unregister

(

o

)

dialog_Unregister(VLC_OBJECT(o))

Typedef Documentation

typedef struct dialog_fatal_t dialog_fatal_t

A fatal error dialog.

No response expected from the user.

typedef struct dialog_login_t dialog_login_t

A login dialog.

typedef struct dialog_progress_bar_t dialog_progress_bar_t

typedef struct dialog_question_t dialog_question_t

A question dialog.

Function Documentation

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

inlinestatic

References dialog_VFatal().

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

inlinestatic

References dialog_VFatal().

void dialog_Login	(	vlc_object_t *	,
		char **	,
		char **	,
		const char *	,
		const char *	,
			...
	)

bool dialog_ProgressCancelled

(

dialog_progress_bar_t *

)

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

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

void dialog_ProgressDestroy

(

dialog_progress_bar_t *

)

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

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

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

int dialog_Question	(	vlc_object_t *	,
		const char *	,
		const char *	,
		const char *	,
		const char *	,
		const char *	,
			...
	)

int dialog_Register

(

vlc_object_t *

)

int dialog_Unregister

(

vlc_object_t *

)

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().