liblightdm-gobject/lightdm/greeter.h

   1 /*
   2  * Copyright (C) 2010 Robert Ancell.
   3  * Author: Robert Ancell <robert.ancell@canonical.com>
   4  *
   5  * This library is free software; you can redistribute it and/or modify it under
   6  * the terms of the GNU Lesser General Public License as published by the Free
   7  * Software Foundation; either version 2 or version 3 of the License.
   8  * See http://www.gnu.org/copyleft/lgpl.html the full text of the license.
   9  */
  10
  11 #ifndef LIGHTDM_GREETER_H_
  12 #define LIGHTDM_GREETER_H_
  13
  14 #include <glib-object.h>
  15 #include <gio/gio.h>
  16
  17 G_BEGIN_DECLS
  18
  19 #define LIGHTDM_TYPE_GREETER (lightdm_greeter_get_type())
  20
  21 G_DECLARE_DERIVABLE_TYPE (LightDMGreeter, lightdm_greeter, LIGHTDM, GREETER, GObject)
  22
  23 #define LIGHTDM_GREETER_ERROR lightdm_greeter_error_quark ()
  24
  25 #define LIGHTDM_GREETER_SIGNAL_SHOW_PROMPT             "show-prompt"
  26 #define LIGHTDM_GREETER_SIGNAL_SHOW_MESSAGE            "show-message"
  27 #define LIGHTDM_GREETER_SIGNAL_AUTHENTICATION_COMPLETE "authentication-complete"
  28 #define LIGHTDM_GREETER_SIGNAL_AUTOLOGIN_TIMER_EXPIRED "autologin-timer-expired"
  29 #define LIGHTDM_GREETER_SIGNAL_IDLE                    "idle"
  30 #define LIGHTDM_GREETER_SIGNAL_RESET                   "reset"
  31
  32 /**
  33  * LightDMPromptType:
  34  * @LIGHTDM_PROMPT_TYPE_QUESTION: Prompt is a question.  The information can be shown as it is entered.
  35  * @LIGHTDM_PROMPT_TYPE_SECRET: Prompt is for secret information.  The entered information should be obscured so it can't be publically visible.
  36  */
  37 typedef enum
  38 {
  39     LIGHTDM_PROMPT_TYPE_QUESTION,
  40     LIGHTDM_PROMPT_TYPE_SECRET
  41 } LightDMPromptType;
  42
  43 GType lightdm_prompt_type_get_type (void);
  44
  45 /**
  46  * LightDMMessageType:
  47  * @LIGHTDM_MESSAGE_TYPE_INFO: Informational message.
  48  * @LIGHTDM_MESSAGE_TYPE_ERROR: Error message.
  49  */
  50 typedef enum
  51 {
  52     LIGHTDM_MESSAGE_TYPE_INFO,
  53     LIGHTDM_MESSAGE_TYPE_ERROR
  54 } LightDMMessageType;
  55
  56 GType lightdm_message_type_get_type (void);
  57
  58 struct _LightDMGreeterClass
  59 {
  60     GObjectClass parent_class;
  61
  62     void (*show_message)(LightDMGreeter *greeter, const gchar *text, LightDMMessageType type);
  63     void (*show_prompt)(LightDMGreeter *greeter, const gchar *text, LightDMPromptType type);
  64     void (*authentication_complete)(LightDMGreeter *greeter);
  65     void (*autologin_timer_expired)(LightDMGreeter *greeter);
  66     void (*idle)(LightDMGreeter *greeter);
  67     void (*reset)(LightDMGreeter *greeter);
  68
  69     /* Reserved */
  70     void (*reserved1) (void);
  71     void (*reserved2) (void);
  72     void (*reserved3) (void);
  73     void (*reserved4) (void);
  74 };
  75
  76 /**
  77  * LightDMGreeterError:
  78  * @LIGHTDM_GREETER_ERROR_COMMUNICATION_ERROR: error communicating with daemon.
  79  * @LIGHTDM_GREETER_ERROR_CONNECTION_FAILED: failed to connect to the daemon.
  80  * @LIGHTDM_GREETER_ERROR_SESSION_FAILED: requested session failed to start.
  81  * @LIGHTDM_GREETER_ERROR_NO_AUTOLOGIN: autologin not configured.
  82  * @LIGHTDM_GREETER_ERROR_INVALID_USER: autologin not configured.
  83  *
  84  * Error codes returned by greeter operations.
  85  */
  86 typedef enum
  87 {
  88     LIGHTDM_GREETER_ERROR_COMMUNICATION_ERROR,
  89     LIGHTDM_GREETER_ERROR_CONNECTION_FAILED,
  90     LIGHTDM_GREETER_ERROR_SESSION_FAILED,
  91     LIGHTDM_GREETER_ERROR_NO_AUTOLOGIN,
  92     LIGHTDM_GREETER_ERROR_INVALID_USER
  93 } LightDMGreeterError;
  94
  95 GQuark lightdm_greeter_error_quark (void);
  96
  97 GType lightdm_greeter_error_get_type (void);
  98
  99 LightDMGreeter *lightdm_greeter_new (void);
 100
 101 void lightdm_greeter_set_resettable (LightDMGreeter *greeter, gboolean resettable);
 102
 103 void lightdm_greeter_connect_to_daemon (LightDMGreeter *greeter, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
 104
 105 gboolean lightdm_greeter_connect_to_daemon_finish (LightDMGreeter *greeter, GAsyncResult *result, GError **error);
 106
 107 gboolean lightdm_greeter_connect_to_daemon_sync (LightDMGreeter *greeter, GError **error);
 108
 109 const gchar *lightdm_greeter_get_hint (LightDMGreeter *greeter, const gchar *name);
 110
 111 const gchar *lightdm_greeter_get_default_session_hint (LightDMGreeter *greeter);
 112
 113 gboolean lightdm_greeter_get_hide_users_hint (LightDMGreeter *greeter);
 114
 115 gboolean lightdm_greeter_get_show_manual_login_hint (LightDMGreeter *greeter);
 116
 117 gboolean lightdm_greeter_get_show_remote_login_hint (LightDMGreeter *greeter);
 118
 119 gboolean lightdm_greeter_get_lock_hint (LightDMGreeter *greeter);
 120
 121 gboolean lightdm_greeter_get_has_guest_account_hint (LightDMGreeter *greeter);
 122
 123 const gchar *lightdm_greeter_get_select_user_hint (LightDMGreeter *greeter);
 124
 125 gboolean lightdm_greeter_get_select_guest_hint (LightDMGreeter *greeter);
 126
 127 const gchar *lightdm_greeter_get_autologin_user_hint (LightDMGreeter *greeter);
 128
 129 gboolean lightdm_greeter_get_autologin_guest_hint (LightDMGreeter *greeter);
 130
 131 gint lightdm_greeter_get_autologin_timeout_hint (LightDMGreeter *greeter);
 132
 133 void lightdm_greeter_cancel_autologin (LightDMGreeter *greeter);
 134
 135 gboolean lightdm_greeter_authenticate (LightDMGreeter *greeter, const gchar *username, GError **error);
 136
 137 gboolean lightdm_greeter_authenticate_as_guest (LightDMGreeter *greeter, GError **error);
 138
 139 gboolean lightdm_greeter_authenticate_autologin (LightDMGreeter *greeter, GError **error);
 140
 141 gboolean lightdm_greeter_authenticate_remote (LightDMGreeter *greeter, const gchar *session, const gchar *username, GError **error);
 142
 143 gboolean lightdm_greeter_respond (LightDMGreeter *greeter, const gchar *response, GError **error);
 144
 145 gboolean lightdm_greeter_cancel_authentication (LightDMGreeter *greeter, GError **error);
 146
 147 gboolean lightdm_greeter_get_in_authentication (LightDMGreeter *greeter);
 148
 149 gboolean lightdm_greeter_get_is_authenticated (LightDMGreeter *greeter);
 150
 151 const gchar *lightdm_greeter_get_authentication_user (LightDMGreeter *greeter);
 152
 153 gboolean lightdm_greeter_set_language (LightDMGreeter *greeter, const gchar *language, GError **error);
 154
 155 void lightdm_greeter_start_session (LightDMGreeter *greeter, const gchar *session, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
 156
 157 gboolean lightdm_greeter_start_session_finish (LightDMGreeter *greeter, GAsyncResult *result, GError **error);
 158
 159 gboolean lightdm_greeter_start_session_sync (LightDMGreeter *greeter, const gchar *session, GError **error);
 160
 161 void lightdm_greeter_ensure_shared_data_dir (LightDMGreeter *greeter, const gchar *username, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
 162
 163 gchar *lightdm_greeter_ensure_shared_data_dir_finish (LightDMGreeter *greeter, GAsyncResult *result, GError **error);
 164
 165 gchar *lightdm_greeter_ensure_shared_data_dir_sync (LightDMGreeter *greeter, const gchar *username, GError **error);
 166
 167 #ifndef LIGHTDM_DISABLE_DEPRECATED
 168 gboolean lightdm_greeter_connect_sync (LightDMGreeter *greeter, GError **error);
 169 #endif
 170
 171 G_END_DECLS
 172
 173 #endif /* LIGHTDM_GREETER_H_ */