summaryrefslogtreecommitdiff
path: root/libebackend/e-user-prompter.h
blob: 4826f6fce8d325aeae84646d47ffacbd3861af8c (plain)
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
/*
 * e-user-prompter.h
 *
 * This library 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.
 *
 * This library 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 this library. If not, see <http://www.gnu.org/licenses/>.
 *
 */

#if !defined (__LIBEBACKEND_H_INSIDE__) && !defined (LIBEBACKEND_COMPILATION)
#error "Only <libebackend/libebackend.h> should be included directly."
#endif

#ifndef E_USER_PROMPTER_H
#define E_USER_PROMPTER_H

#include <glib.h>
#include <libebackend/libebackend.h>
#include <libedataserver/libedataserver.h>

/* Standard GObject macros */
#define E_TYPE_USER_PROMPTER \
	(e_user_prompter_get_type ())
#define E_USER_PROMPTER(obj) \
	(G_TYPE_CHECK_INSTANCE_CAST \
	((obj), E_TYPE_USER_PROMPTER, EUserPrompter))
#define E_USER_PROMPTER_CLASS(cls) \
	(G_TYPE_CHECK_CLASS_CAST \
	((cls), E_TYPE_USER_PROMPTER, EUserPrompterClass))
#define E_IS_USER_PROMPTER(obj) \
	(G_TYPE_CHECK_INSTANCE_TYPE \
	((obj), E_TYPE_USER_PROMPTER))
#define E_IS_USER_PROMPTER_CLASS(cls) \
	(G_TYPE_CHECK_CLASS_TYPE \
	((cls), E_TYPE_USER_PROMPTER))
#define E_USER_PROMPTER_GET_CLASS(obj) \
	(G_TYPE_INSTANCE_GET_CLASS \
	((obj), E_TYPE_USER_PROMPTER, EUserPrompterClass))

G_BEGIN_DECLS

typedef struct _EUserPrompter EUserPrompter;
typedef struct _EUserPrompterClass EUserPrompterClass;
typedef struct _EUserPrompterPrivate EUserPrompterPrivate;

/**
 * EUserPrompter:
 *
 * Since: 3.8
 **/
struct _EUserPrompter {
	GObject parent;
	EUserPrompterPrivate *priv;
};

struct _EUserPrompterClass {
	GObjectClass parent;
};

GType		e_user_prompter_get_type	(void) G_GNUC_CONST;
EUserPrompter *	e_user_prompter_new		(void);
void		e_user_prompter_prompt		(EUserPrompter *prompter,
						 const gchar *type,
						 const gchar *title,
						 const gchar *primary_text,
						 const gchar *secondary_text,
						 gboolean use_markup,
						 GList *button_captions,
						 GCancellable *cancellable,
						 GAsyncReadyCallback callback,
						 gpointer user_data);
gint		e_user_prompter_prompt_finish	(EUserPrompter *prompter,
						 GAsyncResult *result,
						 GError **error);
gint		e_user_prompter_prompt_sync	(EUserPrompter *prompter,
						 const gchar *type,
						 const gchar *title,
						 const gchar *primary_text,
						 const gchar *secondary_text,
						 gboolean use_markup,
						 GList *button_captions,
						 GCancellable *cancellable,
						 GError **error);
void		e_user_prompter_extension_prompt
						(EUserPrompter *prompter,
						 const gchar *dialog_name,
						 const ENamedParameters *in_parameters,
						 GCancellable *cancellable,
						 GAsyncReadyCallback callback,
						 gpointer user_data);
gint		e_user_prompter_extension_prompt_finish
						(EUserPrompter *prompter,
						 GAsyncResult *result,
						 ENamedParameters *out_values,
						 GError **error);
gint		e_user_prompter_extension_prompt_sync
						(EUserPrompter *prompter,
						 const gchar *dialog_name,
						 const ENamedParameters *in_parameters,
						 ENamedParameters *out_values,
						 GCancellable *cancellable,
						 GError **error);

G_END_DECLS

#endif /* E_USER_PROMPTER_H */