aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-passwords.h
diff options
context:
space:
mode:
authorMatthew Barnes <mbarnes@redhat.com>2012-12-10 21:09:59 +0800
committerMatthew Barnes <mbarnes@redhat.com>2012-12-13 03:33:43 +0800
commitd09d8de870b6697c8a8b262e7e077b871a69b315 (patch)
tree3b718882e7a0bb0a996daf2967a033d91714c9b5 /e-util/e-passwords.h
parentb61331ed03ac1c7a9b8614e25510040b9c60ae02 (diff)
downloadgsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar.gz
gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar.zst
gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.zip
Consolidate base utility libraries into libeutil.
Evolution consists of entirely too many small utility libraries, which increases linking and loading time, places a burden on higher layers of the application (e.g. modules) which has to remember to link to all the small in-tree utility libraries, and makes it difficult to generate API documentation for these utility libraries in one Gtk-Doc module. Merge the following utility libraries under the umbrella of libeutil, and enforce a single-include policy on libeutil so we can reorganize the files as desired without disrupting its pseudo-public API. libemail-utils/libemail-utils.la libevolution-utils/libevolution-utils.la filter/libfilter.la widgets/e-timezone-dialog/libetimezonedialog.la widgets/menus/libmenus.la widgets/misc/libemiscwidgets.la widgets/table/libetable.la widgets/text/libetext.la This also merges libedataserverui from the Evolution-Data-Server module, since Evolution is its only consumer nowadays, and I'd like to make some improvements to those APIs without concern for backward-compatibility. And finally, start a Gtk-Doc module for libeutil. It's going to be a project just getting all the symbols _listed_ much less _documented_. But the skeletal structure is in place and I'm off to a good start.
Diffstat (limited to 'e-util/e-passwords.h')
-rw-r--r--e-util/e-passwords.h81
1 files changed, 81 insertions, 0 deletions
diff --git a/e-util/e-passwords.h b/e-util/e-passwords.h
new file mode 100644
index 0000000000..83a4a7eaec
--- /dev/null
+++ b/e-util/e-passwords.h
@@ -0,0 +1,81 @@
+/*
+ * e-passwords.h
+ *
+ * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
+ */
+
+/*
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of version 2 of the GNU Lesser General Public
+ * License as published by the Free Software Foundation.
+ *
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
+ * USA.
+ */
+
+#if !defined (__E_UTIL_H_INSIDE__) && !defined (LIBEUTIL_COMPILATION)
+#error "Only <e-util/e-util.h> should be included directly."
+#endif
+
+#ifndef EDS_DISABLE_DEPRECATED
+
+#ifndef _E_PASSWORD_H_
+#define _E_PASSWORD_H_
+
+#include <gtk/gtk.h>
+
+G_BEGIN_DECLS
+
+/*
+ * initialization is now implicit when you call any of the functions
+ * below, although this is only correct if the functions are called
+ * from the main thread.
+ *
+ * e_passwords_shutdown should be called at exit time to synch the
+ * password on-disk storage, and to free up in-memory storage. */
+void e_passwords_init (void);
+
+void e_passwords_shutdown (void);
+void e_passwords_cancel (void);
+void e_passwords_set_online (gint state);
+void e_passwords_remember_password (const gchar *unused, const gchar *key);
+void e_passwords_add_password (const gchar *key, const gchar *passwd);
+gchar *e_passwords_get_password (const gchar *unused, const gchar *key);
+void e_passwords_forget_password (const gchar *unused, const gchar *key);
+void e_passwords_forget_passwords (void);
+void e_passwords_clear_passwords (const gchar *unused);
+
+typedef enum {
+ E_PASSWORDS_REMEMBER_NEVER,
+ E_PASSWORDS_REMEMBER_SESSION,
+ E_PASSWORDS_REMEMBER_FOREVER,
+ E_PASSWORDS_REMEMBER_MASK = 0xf,
+
+ /* option bits */
+ E_PASSWORDS_SECRET = 1 << 8,
+ E_PASSWORDS_REPROMPT = 1 << 9,
+ E_PASSWORDS_ONLINE = 1<<10, /* only ask if we're online */
+ E_PASSWORDS_DISABLE_REMEMBER = 1<<11, /* disable the 'remember password' checkbox */
+ E_PASSWORDS_PASSPHRASE = 1<<12 /* We are asking a passphrase */
+} EPasswordsRememberType;
+
+gchar * e_passwords_ask_password (const gchar *title,
+ const gchar *unused,
+ const gchar *key,
+ const gchar *prompt,
+ EPasswordsRememberType remember_type,
+ gboolean *remember,
+ GtkWindow *parent);
+
+G_END_DECLS
+
+#endif /* _E_PASSWORD_H_ */
+
+#endif /* EDS_DISABLE_DEPRECATED */