aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-alert.h
blob: f9f0fc855982c667e4d67c2caaa75375819a42a9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
/*
 * 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 of the License, or (at your option) version 3.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with the program; if not, see <http://www.gnu.org/licenses/>
 *
 *
 * Authors:
 *   Michael Zucchi <notzed@ximian.com>
 *   Jonathon Jongsma <jonathon.jongsma@collabora.co.uk>
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 * Copyright (C) 2009 Intel Corporation
 *
 */

#ifndef E_ALERT_H
#define E_ALERT_H

#include <stdarg.h>
#include <gtk/gtk.h>

/* Standard GObject macros */
#define E_TYPE_ALERT \
    (e_alert_get_type ())
#define E_ALERT(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), E_TYPE_ALERT, EAlert))
#define E_ALERT_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), E_TYPE_ALERT, EAlertClass))
#define E_IS_ALERT(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), E_TYPE_ALERT))
#define E_IS_ALERT_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), E_TYPE_ALERT))
#define E_ALERT_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), E_TYPE_ALERT, EAlertClass))

/* takes filename, returns OK if yes */
#define E_ALERT_ASK_FILE_EXISTS_OVERWRITE \
    "system:ask-save-file-exists-overwrite"
/* takes filename, reason */
#define E_ALERT_NO_SAVE_FILE "system:no-save-file"
/* takes filename, reason */
#define E_ALERT_NO_LOAD_FILE "system:no-save-file"

G_BEGIN_DECLS

typedef struct _EAlert EAlert;
typedef struct _EAlertClass EAlertClass;
typedef struct _EAlertPrivate EAlertPrivate;

struct _EAlert {
    GObject parent;
    EAlertPrivate *priv;
};

struct _EAlertClass {
    GObjectClass parent_class;

    /* Signals */
    void        (*response)     (EAlert *alert,
                         gint response_id);
};

GType       e_alert_get_type        (void);
EAlert *    e_alert_new         (const gchar *tag,
                         ...) G_GNUC_NULL_TERMINATED;
EAlert *    e_alert_new_valist      (const gchar *tag,
                         va_list va);
EAlert *    e_alert_new_array       (const gchar *tag,
                         GPtrArray *args);
gint        e_alert_get_default_response    (EAlert *alert);
void        e_alert_set_default_response    (EAlert *alert,
                         gint response_id);
GtkMessageType  e_alert_get_message_type    (EAlert *alert);
void        e_alert_set_message_type    (EAlert *alert,
                         GtkMessageType message_type);
const gchar *   e_alert_get_primary_text    (EAlert *alert);
void        e_alert_set_primary_text    (EAlert *alert,
                         const gchar *primary_text);
const gchar *   e_alert_get_secondary_text  (EAlert *alert);
void        e_alert_set_secondary_text  (EAlert *alert,
                         const gchar *secondary_text);
const gchar *   e_alert_get_stock_id        (EAlert *alert);
void        e_alert_add_action      (EAlert *alert,
                         GtkAction *action,
                         gint response_id);
GList *     e_alert_peek_actions        (EAlert *alert);
GtkWidget * e_alert_create_image        (EAlert *alert,
                         GtkIconSize size);
void        e_alert_response        (EAlert *alert,
                         gint response_id);

void        e_alert_submit          (GtkWidget *widget,
                         const gchar *tag,
                         ...) G_GNUC_NULL_TERMINATED;
void        e_alert_submit_valist       (GtkWidget *widget,
                         const gchar *tag,
                         va_list va);

G_END_DECLS

#endif /* E_ALERT_H */