vlc_dialog.h 4.3 KB
Newer Older
1 2 3 4 5
/*****************************************************************************
 * vlc_dialog.h: user interaction dialogs
 *****************************************************************************
 * Copyright (C) 2009 Rémi Denis-Courmont
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
6 7 8
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
9 10 11 12
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
13 14
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
15
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
16 17 18
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
19 20 21 22
 *****************************************************************************/

#ifndef VLC_DIALOG_H_
#define VLC_DIALOG_H_
23
# include <stdarg.h>
24 25

/**
26 27
 * \ingroup interaction
 * @{
28 29 30 31 32 33 34 35 36 37 38 39 40 41
 * \file vlc_dialog.h
 * User interaction dialog APIs
 */

/**
 * A fatal error dialog.
 * No response expected from the user.
 */
typedef struct dialog_fatal_t
{
    const char *title;
    const char *message;
} dialog_fatal_t;

42
VLC_API void dialog_VFatal(vlc_object_t *, bool, const char *, const char *, va_list);
43

44
static inline VLC_FORMAT(3, 4)
45 46 47 48 49 50 51 52
void dialog_Fatal (vlc_object_t *obj, const char *title, const char *fmt, ...)
{
     va_list ap;

     va_start (ap, fmt);
     dialog_VFatal(obj, false, title, fmt, ap);
     va_end (ap);
}
53 54 55
#define dialog_Fatal(o, t, ...) \
        dialog_Fatal(VLC_OBJECT(o), t, __VA_ARGS__)

56
static inline VLC_FORMAT(3, 4)
57 58 59 60 61 62 63 64 65 66 67
void dialog_FatalWait (vlc_object_t *obj, const char *title,
                       const char *fmt, ...){
     va_list ap;

     va_start (ap, fmt);
     dialog_VFatal(obj, true, title, fmt, ap);
     va_end (ap);
}
#define dialog_FatalWait(o, t, ...) \
        dialog_FatalWait(VLC_OBJECT(o), t, __VA_ARGS__)

68 69 70 71 72 73 74
/**
 * A login dialog.
 */
typedef struct dialog_login_t
{
    const char *title;
    const char *message;
75
    const char *default_username;
76 77
    char **username;
    char **password;
78 79
    /* if store is NULL, password can't be stored (there is no keystore) */
    bool *store;
80 81
} dialog_login_t;

82
VLC_API void dialog_Login(vlc_object_t *, const char *, char **, char **, bool *, const char *, const char *, ...) VLC_FORMAT (7, 8);
83 84
#define dialog_Login(o, u, p, s, t, v, w, ...) \
        dialog_Login(VLC_OBJECT(o), u, p, s, t, v, w, __VA_ARGS__)
85

86 87 88 89 90
VLC_API void dialog_vaLogin(vlc_object_t *, const char *, char **, char **, bool *, const char *, const char *, va_list args);
#define dialog_vaLogin(o, u, p, s, t, v, w, x) \
        dialog_vaLogin(VLC_OBJECT(o), u, p, s, t, v, w, x)


91 92 93 94 95 96 97 98 99 100 101 102 103
/**
 * A question dialog.
 */
typedef struct dialog_question_t
{
    const char *title;
    const char *message;
    const char *yes;
    const char *no;
    const char *cancel;
    int answer;
} dialog_question_t;

104 105 106 107 108
VLC_API int dialog_Question(vlc_object_t *, const char *, const char *,
                            const char *, const char *, const char *, ...)
VLC_FORMAT(3, 7);
#define dialog_Question(o, t, m, y, n, ...) \
        dialog_Question(VLC_OBJECT(o), t, m, y, n, __VA_ARGS__)
109

110 111 112 113 114 115
typedef struct dialog_progress_bar_t
{   /* Request-time parameters */
    const char *title;
    const char *message;
    const char *cancel;
    /* Permanent parameters */
116
    void (*pf_update) (void *, const char *, float);
117 118 119 120 121
    bool (*pf_check) (void *);
    void (*pf_destroy) (void *);
    void *p_sys;
} dialog_progress_bar_t;

122
VLC_API dialog_progress_bar_t * dialog_ProgressCreate(vlc_object_t *, const char *, const char *, const char *) VLC_USED;
123 124
#define dialog_ProgressCreate(o, t, m, c) \
        dialog_ProgressCreate(VLC_OBJECT(o), t, m, c)
125 126 127
VLC_API void dialog_ProgressDestroy(dialog_progress_bar_t *);
VLC_API void dialog_ProgressSet(dialog_progress_bar_t *, const char *, float);
VLC_API bool dialog_ProgressCancelled(dialog_progress_bar_t *);
128

129 130
VLC_API int dialog_Register(vlc_object_t *);
VLC_API int dialog_Unregister(vlc_object_t *);
131 132 133
#define dialog_Register(o) dialog_Register(VLC_OBJECT(o))
#define dialog_Unregister(o) dialog_Unregister(VLC_OBJECT(o))

134 135
/** @} */

136
#endif