summaryrefslogtreecommitdiff
path: root/gcr/gcr-prompt.h
blob: 56b93390ae5df2eb6cc815f19d973b50c2d59ea3 (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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/*
 * gnome-keyring
 *
 * Copyright (C) 2011 Stefan Walter
 *
 * 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 (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
 * 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 program; if not, see <http://www.gnu.org/licenses/>.
 *
 * Author: Stef Walter <stef@thewalter.net>
 */

#if !defined (__GCR_INSIDE_HEADER__) && !defined (GCR_COMPILATION)
#error "Only <gcr/gcr.h> or <gcr/gcr-base.h> can be included directly."
#endif

#ifndef __GCR_PROMPT_H__
#define __GCR_PROMPT_H__

#include "gcr-types.h"

#include <glib-object.h>

G_BEGIN_DECLS

typedef enum {
	GCR_PROMPT_REPLY_CANCEL = 0,
	GCR_PROMPT_REPLY_CONTINUE = 1,
} GcrPromptReply;

#define GCR_TYPE_PROMPT                 (gcr_prompt_get_type ())
#define GCR_PROMPT(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GCR_TYPE_PROMPT, GcrPrompt))
#define GCR_IS_PROMPT(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GCR_TYPE_PROMPT))
#define GCR_PROMPT_GET_INTERFACE(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GCR_TYPE_PROMPT, GcrPromptIface))

typedef struct _GcrPrompt GcrPrompt;
typedef struct _GcrPromptIface GcrPromptIface;

struct _GcrPromptIface {
	GTypeInterface parent_iface;

	void               (* prompt_password_async)    (GcrPrompt *prompt,
	                                                 GCancellable *cancellable,
	                                                 GAsyncReadyCallback callback,
	                                                 gpointer user_data);

	const gchar *      (* prompt_password_finish)   (GcrPrompt *prompt,
	                                                 GAsyncResult *result,
	                                                 GError **error);

	void               (* prompt_confirm_async)     (GcrPrompt *prompt,
	                                                 GCancellable *cancellable,
	                                                 GAsyncReadyCallback callback,
	                                                 gpointer user_data);

	GcrPromptReply     (* prompt_confirm_finish)    (GcrPrompt *prompt,
	                                                 GAsyncResult *result,
	                                                 GError **error);

	void               (* prompt_close)             (GcrPrompt *prompt);
};

GType                gcr_prompt_get_type                  (void);

void                 gcr_prompt_reset                     (GcrPrompt *prompt);

gchar *              gcr_prompt_get_title                 (GcrPrompt *prompt);

void                 gcr_prompt_set_title                 (GcrPrompt *prompt,
                                                           const gchar *title);

gchar *              gcr_prompt_get_message               (GcrPrompt *prompt);

void                 gcr_prompt_set_message               (GcrPrompt *prompt,
                                                           const gchar *message);

gchar *              gcr_prompt_get_description           (GcrPrompt *prompt);

void                 gcr_prompt_set_description           (GcrPrompt *prompt,
                                                           const gchar *description);

gchar *              gcr_prompt_get_warning               (GcrPrompt *prompt);

void                 gcr_prompt_set_warning               (GcrPrompt *prompt,
                                                           const gchar *warning);

gchar *              gcr_prompt_get_choice_label          (GcrPrompt *prompt);

void                 gcr_prompt_set_choice_label          (GcrPrompt *prompt,
                                                           const gchar *choice_label);

gboolean             gcr_prompt_get_choice_chosen         (GcrPrompt *prompt);

void                 gcr_prompt_set_choice_chosen         (GcrPrompt *prompt,
                                                           gboolean chosen);

gboolean             gcr_prompt_get_password_new          (GcrPrompt *prompt);

void                 gcr_prompt_set_password_new          (GcrPrompt *prompt,
                                                           gboolean new_password);

gint                 gcr_prompt_get_password_strength     (GcrPrompt *prompt);

gchar *              gcr_prompt_get_caller_window         (GcrPrompt *prompt);

void                 gcr_prompt_set_caller_window         (GcrPrompt *prompt,
                                                           const gchar *window_id);

gchar *              gcr_prompt_get_continue_label        (GcrPrompt *prompt);

void                 gcr_prompt_set_continue_label        (GcrPrompt *prompt,
                                                           const gchar *continue_label);

gchar *              gcr_prompt_get_cancel_label          (GcrPrompt *prompt);

void                 gcr_prompt_set_cancel_label          (GcrPrompt *prompt,
                                                           const gchar *cancel_label);

void                 gcr_prompt_password_async            (GcrPrompt *prompt,
                                                           GCancellable *cancellable,
                                                           GAsyncReadyCallback callback,
                                                           gpointer user_data);

const gchar *        gcr_prompt_password_finish           (GcrPrompt *prompt,
                                                           GAsyncResult *result,
                                                           GError **error);

const gchar *        gcr_prompt_password                  (GcrPrompt *prompt,
                                                           GCancellable *cancellable,
                                                           GError **error);

const gchar *        gcr_prompt_password_run              (GcrPrompt *prompt,
                                                           GCancellable *cancellable,
                                                           GError **error);

void                 gcr_prompt_confirm_async             (GcrPrompt *prompt,
                                                           GCancellable *cancellable,
                                                           GAsyncReadyCallback callback,
                                                           gpointer user_data);

GcrPromptReply       gcr_prompt_confirm_finish            (GcrPrompt *prompt,
                                                           GAsyncResult *result,
                                                           GError **error);

GcrPromptReply       gcr_prompt_confirm                   (GcrPrompt *prompt,
                                                           GCancellable *cancellable,
                                                           GError **error);

GcrPromptReply       gcr_prompt_confirm_run               (GcrPrompt *prompt,
                                                           GCancellable *cancellable,
                                                           GError **error);

void                 gcr_prompt_close                     (GcrPrompt *prompt);

G_END_DECLS

#endif /* __GCR_PROMPT_H__ */