diff options
author | Stef Walter <stefw@collabora.co.uk> | 2011-10-28 12:06:03 +0200 |
---|---|---|
committer | Stef Walter <stefw@collabora.co.uk> | 2011-12-13 21:45:09 +0100 |
commit | 316bb56cadbdd56ee0e897dcc571dec7ea8ac77a (patch) | |
tree | 83916f468d2c13b0d6e3e5e842d53b91ccb2e608 /gcr/gcr-system-prompt.h | |
parent | 19f5cd44bbcb5771c1519a0f7d55b46043c5d858 (diff) | |
download | gcr-316bb56cadbdd56ee0e897dcc571dec7ea8ac77a.tar.gz |
gcr: Add system prompt and prompter
* GcrSystemPrompt is a class used on the client.
* GcrSystemPrompter is a base class for implementing the actual prompter
* GcrMockPrompter is a mock prompter, which returns predefined values
useful in tests
Diffstat (limited to 'gcr/gcr-system-prompt.h')
-rw-r--r-- | gcr/gcr-system-prompt.h | 174 |
1 files changed, 174 insertions, 0 deletions
diff --git a/gcr/gcr-system-prompt.h b/gcr/gcr-system-prompt.h new file mode 100644 index 0000000..19ffa1d --- /dev/null +++ b/gcr/gcr-system-prompt.h @@ -0,0 +1,174 @@ +/* + * 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, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA + * 02111-1307, USA. + * + * 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_SYSTEM_PROMPT_H__ +#define __GCR_SYSTEM_PROMPT_H__ + +#include "gcr-types.h" +#include "gcr-secret-exchange.h" + +#include <glib-object.h> + +G_BEGIN_DECLS + + +typedef enum { + GCR_SYSTEM_PROMPT_IN_PROGRESS = 1, + GCR_SYSTEM_PROMPT_NOT_HAPPENING, + GCR_SYSTEM_PROMPT_FAILED +} GcrSystemPromptError; + +#define GCR_SYSTEM_PROMPT_ERROR (gcr_system_prompt_error_get_domain ()) + +GQuark gcr_system_prompt_error_get_domain (void) G_GNUC_CONST; + +#define GCR_TYPE_SYSTEM_PROMPT (gcr_system_prompt_get_type ()) +#define GCR_SYSTEM_PROMPT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GCR_TYPE_SYSTEM_PROMPT, GcrSystemPrompt)) +#define GCR_SYSTEM_PROMPT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GCR_TYPE_SYSTEM_PROMPT, GcrSystemPromptClass)) +#define GCR_IS_SYSTEM_PROMPT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GCR_TYPE_SYSTEM_PROMPT)) +#define GCR_IS_SYSTEM_PROMPT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GCR_TYPE_SYSTEM_PROMPT)) +#define GCR_SYSTEM_PROMPT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GCR_TYPE_SYSTEM_PROMPT, GcrSystemPromptClass)) + +typedef struct _GcrSystemPrompt GcrSystemPrompt; +typedef struct _GcrSystemPromptClass GcrSystemPromptClass; +typedef struct _GcrSystemPromptPrivate GcrSystemPromptPrivate; + +struct _GcrSystemPrompt { + GObject parent; + GcrSystemPromptPrivate *pv; +}; + +struct _GcrSystemPromptClass { + GObjectClass parent_class; + + void (*prompt_ready) (); +}; + +GType gcr_system_prompt_get_type (void); + +GcrSecretExchange * gcr_system_prompt_get_secret_exchange (GcrSystemPrompt *self); + +void gcr_system_prompt_set_secret_exchange (GcrSystemPrompt *self, + GcrSecretExchange *exchange); + +const gchar * gcr_system_prompt_get_title (GcrSystemPrompt *self); + +void gcr_system_prompt_set_title (GcrSystemPrompt *self, + const gchar *title); + +const gchar * gcr_system_prompt_get_message (GcrSystemPrompt *self); + +void gcr_system_prompt_set_message (GcrSystemPrompt *self, + const gchar *message); + +const gchar * gcr_system_prompt_get_description (GcrSystemPrompt *self); + +void gcr_system_prompt_set_description (GcrSystemPrompt *self, + const gchar *description); + +const gchar * gcr_system_prompt_get_warning (GcrSystemPrompt *self); + +void gcr_system_prompt_set_warning (GcrSystemPrompt *self, + const gchar *warning); + +const gchar * gcr_system_prompt_get_choice_label (GcrSystemPrompt *self); + +void gcr_system_prompt_set_choice_label (GcrSystemPrompt *self, + const gchar *warning); + +gboolean gcr_system_prompt_get_choice_chosen (GcrSystemPrompt *self); + +void gcr_system_prompt_set_choice_chosen (GcrSystemPrompt *self, + gboolean chosen); + +gboolean gcr_system_prompt_get_password_new (GcrSystemPrompt *self); + +void gcr_system_prompt_set_password_new (GcrSystemPrompt *self, + gboolean new_password); + +gint gcr_system_prompt_get_password_strength (GcrSystemPrompt *self); + +const gchar * gcr_system_prompt_get_caller_window (GcrSystemPrompt *self); + +void gcr_system_prompt_set_caller_window (GcrSystemPrompt *self, + const gchar *window_id); + +void gcr_system_prompt_open_async (gint timeout_seconds, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); + +void gcr_system_prompt_open_for_prompter_async (const gchar *prompter_name, + gint timeout_seconds, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); + + +GcrSystemPrompt * gcr_system_prompt_open_finish (GAsyncResult *result, + GError **error); + +GcrSystemPrompt * gcr_system_prompt_open_for_prompter (const gchar *prompter_name, + gint timeout_seconds, + GCancellable *cancellable, + GError **error); + +GcrSystemPrompt * gcr_system_prompt_open (gint timeout_seconds, + GCancellable *cancellable, + GError **error); + +void gcr_system_prompt_password_async (GcrSystemPrompt *self, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); + +const gchar * gcr_system_prompt_password_finish (GcrSystemPrompt *self, + GAsyncResult *result, + GError **error); + +const gchar * gcr_system_prompt_password (GcrSystemPrompt *self, + GCancellable *cancellable, + GError **error); + +void gcr_system_prompt_confirm_async (GcrSystemPrompt *self, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); + +gboolean gcr_system_prompt_confirm_finish (GcrSystemPrompt *self, + GAsyncResult *result, + GError **error); + +gboolean gcr_system_prompt_confirm (GcrSystemPrompt *self, + GCancellable *cancellable, + GError **error); + +void gcr_system_prompt_close (GcrSystemPrompt *self); + +G_END_DECLS + +#endif /* __GCR_SYSTEM_PROMPT_H__ */ |