path: root/e-util/e-passwords.h

/*
 * 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 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 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/>.
 */

#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_PASSWORDS_H
#define E_PASSWORDS_H

#include <gtk/gtk.h>

G_BEGIN_DECLS

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;

/*
 * 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.
 */
void        e_passwords_init        (void);
void        e_passwords_set_online      (gint state);
void        e_passwords_remember_password   (const gchar *key);
void        e_passwords_add_password    (const gchar *key,
                         const gchar *passwd);
gchar *     e_passwords_get_password    (const gchar *key);
void        e_passwords_forget_password (const gchar *key);
gchar *     e_passwords_ask_password    (const gchar *title,
                         const gchar *key,
                         const gchar *prompt,
                         EPasswordsRememberType remember_type,
                         gboolean *remember,
                         GtkWindow *parent);

G_END_DECLS

#endif /* E_PASSWORDS_H */

#endif /* EDS_DISABLE_DEPRECATED */