1 /*****************************************************************************
2 * vlc_dialog.h: user interaction dialogs
3 *****************************************************************************
4 * Copyright (C) 2009 RĂ©mi Denis-Courmont
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU Lesser General Public License as published by
8 * the Free Software Foundation; either version 2.1 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
19 *****************************************************************************/
27 * User interaction dialog APIs
31 * A fatal error dialog.
32 * No response expected from the user.
34 typedef struct dialog_fatal_t
40 VLC_API void dialog_VFatal(vlc_object_t *, bool, const char *, const char *, va_list);
42 static inline VLC_FORMAT(3, 4)
43 void dialog_Fatal (vlc_object_t *obj, const char *title, const char *fmt, ...)
48 dialog_VFatal(obj, false, title, fmt, ap);
51 #define dialog_Fatal(o, t, ...) \
52 dialog_Fatal(VLC_OBJECT(o), t, __VA_ARGS__)
54 static inline VLC_FORMAT(3, 4)
55 void dialog_FatalWait (vlc_object_t *obj, const char *title,
56 const char *fmt, ...){
60 dialog_VFatal(obj, true, title, fmt, ap);
63 #define dialog_FatalWait(o, t, ...) \
64 dialog_FatalWait(VLC_OBJECT(o), t, __VA_ARGS__)
69 typedef struct dialog_login_t
77 VLC_API void dialog_Login(vlc_object_t *, char **, char **, const char *, const char *, ...) VLC_FORMAT (5, 6);
78 #define dialog_Login(o, u, p, t, ...) \
79 dialog_Login(VLC_OBJECT(o), u, p, t, __VA_ARGS__)
84 typedef struct dialog_question_t
94 VLC_API int dialog_Question(vlc_object_t *, const char *, const char *,
95 const char *, const char *, const char *, ...)
97 #define dialog_Question(o, t, m, y, n, ...) \
98 dialog_Question(VLC_OBJECT(o), t, m, y, n, __VA_ARGS__)
100 typedef struct dialog_progress_bar_t
101 { /* Request-time parameters */
105 /* Permanent parameters */
106 void (*pf_update) (void *, const char *, float);
107 bool (*pf_check) (void *);
108 void (*pf_destroy) (void *);
110 } dialog_progress_bar_t;
112 VLC_API dialog_progress_bar_t * dialog_ProgressCreate(vlc_object_t *, const char *, const char *, const char *) VLC_USED;
113 #define dialog_ProgressCreate(o, t, m, c) \
114 dialog_ProgressCreate(VLC_OBJECT(o), t, m, c)
115 VLC_API void dialog_ProgressDestroy(dialog_progress_bar_t *);
116 VLC_API void dialog_ProgressSet(dialog_progress_bar_t *, const char *, float);
117 VLC_API bool dialog_ProgressCancelled(dialog_progress_bar_t *);
119 VLC_API int dialog_Register(vlc_object_t *);
120 VLC_API int dialog_Unregister(vlc_object_t *);
121 #define dialog_Register(o) dialog_Register(VLC_OBJECT(o))
122 #define dialog_Unregister(o) dialog_Unregister(VLC_OBJECT(o))