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 #define LIGHTDM_GREETER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), LIGHTDM_TYPE_GREETER, LightDMGreeter))
  21 #define LIGHTDM_GREETER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), LIGHTDM_TYPE_GREETER, LightDMGreeterClass))
  22 #define LIGHTDM_IS_GREETER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LIGHTDM_TYPE_GREETER))
  23 #define LIGHTDM_IS_GREETER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), LIGHTDM_TYPE_GREETER))
  24 #define LIGHTDM_GREETER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), LIGHTDM_TYPE_GREETER, LightDMGreeterClass))
  25
  26 #define LIGHTDM_GREETER_ERROR lightdm_greeter_error_quark ()
  27
  28 #define LIGHTDM_GREETER_SIGNAL_SHOW_PROMPT             "show-prompt"
  29 #define LIGHTDM_GREETER_SIGNAL_SHOW_MESSAGE            "show-message"
  30 #define LIGHTDM_GREETER_SIGNAL_AUTHENTICATION_COMPLETE "authentication-complete"
  31 #define LIGHTDM_GREETER_SIGNAL_AUTOLOGIN_TIMER_EXPIRED "autologin-timer-expired"
  32 #define LIGHTDM_GREETER_SIGNAL_IDLE                    "idle"
  33 #define LIGHTDM_GREETER_SIGNAL_RESET                   "reset"
  34
  35 /**
  36  * LightDMPromptType:
  37  * @LIGHTDM_PROMPT_TYPE_QUESTION: Prompt is a question.  The information can be shown as it is entered.
  38  * @LIGHTDM_PROMPT_TYPE_SECRET: Prompt is for secret information.  The entered information should be obscured so it can't be publically visible.
  39  */
  40 typedef enum
  41 {
  42     LIGHTDM_PROMPT_TYPE_QUESTION,
  43     LIGHTDM_PROMPT_TYPE_SECRET
  44 } LightDMPromptType;
  45
  46 GType lightdm_prompt_type_get_type (void);
  47
  48 /**
  49  * LightDMMessageType:
  50  * @LIGHTDM_MESSAGE_TYPE_INFO: Informational message.
  51  * @LIGHTDM_MESSAGE_TYPE_ERROR: Error message.
  52  */
  53 typedef enum
  54 {
  55     LIGHTDM_MESSAGE_TYPE_INFO,
  56     LIGHTDM_MESSAGE_TYPE_ERROR
  57 } LightDMMessageType;
  58
  59 GType lightdm_message_type_get_type (void);
  60
  61 typedef struct
  62 {
  63     GObject parent_instance;
  64 } LightDMGreeter;
  65
  66 typedef struct
  67 {
  68     GObjectClass parent_class;
  69
  70     void (*show_message)(LightDMGreeter *greeter, const gchar *text, LightDMMessageType type);
  71     void (*show_prompt)(LightDMGreeter *greeter, const gchar *text, LightDMPromptType type);
  72     void (*authentication_complete)(LightDMGreeter *greeter);
  73     void (*autologin_timer_expired)(LightDMGreeter *greeter);
  74     void (*idle)(LightDMGreeter *greeter);
  75     void (*reset)(LightDMGreeter *greeter);
  76
  77     /* Reserved */
  78     void (*reserved1) (void);
  79     void (*reserved2) (void);
  80     void (*reserved3) (void);
  81     void (*reserved4) (void);
  82 } LightDMGreeterClass;
  83
  84 #ifdef GLIB_VERSION_2_44
  85 typedef LightDMGreeter *LightDMGreeter_autoptr;
  86 static inline void glib_autoptr_cleanup_LightDMGreeter (LightDMGreeter **_ptr)
  87 {
  88     glib_autoptr_cleanup_GObject ((GObject **) _ptr);
  89 }
  90 #endif
  91
  92 /**
  93  * LightDMGreeterError:
  94  * @LIGHTDM_GREETER_ERROR_COMMUNICATION_ERROR: error communicating with daemon.
  95  * @LIGHTDM_GREETER_ERROR_CONNECTION_FAILED: failed to connect to the daemon.
  96  * @LIGHTDM_GREETER_ERROR_SESSION_FAILED: requested session failed to start.
  97  * @LIGHTDM_GREETER_ERROR_NO_AUTOLOGIN: autologin not configured.
  98  * @LIGHTDM_GREETER_ERROR_INVALID_USER: autologin not configured.
  99  *
 100  * Error codes returned by greeter operations.
 101  */
 102 typedef enum
 103 {
 104     LIGHTDM_GREETER_ERROR_COMMUNICATION_ERROR,
 105     LIGHTDM_GREETER_ERROR_CONNECTION_FAILED,
 106     LIGHTDM_GREETER_ERROR_SESSION_FAILED,
 107     LIGHTDM_GREETER_ERROR_NO_AUTOLOGIN,
 108     LIGHTDM_GREETER_ERROR_INVALID_USER
 109 } LightDMGreeterError;
 110
 111 GQuark lightdm_greeter_error_quark (void);
 112
 113 GType lightdm_greeter_error_get_type (void);
 114
 115 GType lightdm_greeter_get_type (void);
 116
 117 LightDMGreeter *lightdm_greeter_new (void);
 118
 119 void lightdm_greeter_set_resettable (LightDMGreeter *greeter, gboolean resettable);
 120
 121 void lightdm_greeter_connect_to_daemon (LightDMGreeter *greeter, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
 122
 123 gboolean lightdm_greeter_connect_to_daemon_finish (LightDMGreeter *greeter, GAsyncResult *result, GError **error);
 124
 125 gboolean lightdm_greeter_connect_to_daemon_sync (LightDMGreeter *greeter, GError **error);
 126
 127 const gchar *lightdm_greeter_get_hint (LightDMGreeter *greeter, const gchar *name);
 128
 129 const gchar *lightdm_greeter_get_default_session_hint (LightDMGreeter *greeter);
 130
 131 gboolean lightdm_greeter_get_hide_users_hint (LightDMGreeter *greeter);
 132
 133 gboolean lightdm_greeter_get_show_manual_login_hint (LightDMGreeter *greeter);
 134
 135 gboolean lightdm_greeter_get_show_remote_login_hint (LightDMGreeter *greeter);
 136
 137 gboolean lightdm_greeter_get_lock_hint (LightDMGreeter *greeter);
 138
 139 gboolean lightdm_greeter_get_has_guest_account_hint (LightDMGreeter *greeter);
 140
 141 const gchar *lightdm_greeter_get_select_user_hint (LightDMGreeter *greeter);
 142
 143 gboolean lightdm_greeter_get_select_guest_hint (LightDMGreeter *greeter);
 144
 145 const gchar *lightdm_greeter_get_autologin_user_hint (LightDMGreeter *greeter);
 146
 147 gboolean lightdm_greeter_get_autologin_guest_hint (LightDMGreeter *greeter);
 148
 149 gint lightdm_greeter_get_autologin_timeout_hint (LightDMGreeter *greeter);
 150
 151 void lightdm_greeter_cancel_autologin (LightDMGreeter *greeter);
 152
 153 gboolean lightdm_greeter_authenticate (LightDMGreeter *greeter, const gchar *username, GError **error);
 154
 155 gboolean lightdm_greeter_authenticate_as_guest (LightDMGreeter *greeter, GError **error);
 156
 157 gboolean lightdm_greeter_authenticate_autologin (LightDMGreeter *greeter, GError **error);
 158
 159 gboolean lightdm_greeter_authenticate_remote (LightDMGreeter *greeter, const gchar *session, const gchar *username, GError **error);
 160
 161 gboolean lightdm_greeter_respond (LightDMGreeter *greeter, const gchar *response, GError **error);
 162
 163 gboolean lightdm_greeter_cancel_authentication (LightDMGreeter *greeter, GError **error);
 164
 165 gboolean lightdm_greeter_get_in_authentication (LightDMGreeter *greeter);
 166
 167 gboolean lightdm_greeter_get_is_authenticated (LightDMGreeter *greeter);
 168
 169 const gchar *lightdm_greeter_get_authentication_user (LightDMGreeter *greeter);
 170
 171 gboolean lightdm_greeter_set_language (LightDMGreeter *greeter, const gchar *language, GError **error);
 172
 173 void lightdm_greeter_start_session (LightDMGreeter *greeter, const gchar *session, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
 174
 175 gboolean lightdm_greeter_start_session_finish (LightDMGreeter *greeter, GAsyncResult *result, GError **error);
 176
 177 gboolean lightdm_greeter_start_session_sync (LightDMGreeter *greeter, const gchar *session, GError **error);
 178
 179 void lightdm_greeter_ensure_shared_data_dir (LightDMGreeter *greeter, const gchar *username, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
 180
 181 gchar *lightdm_greeter_ensure_shared_data_dir_finish (LightDMGreeter *greeter, GAsyncResult *result, GError **error);
 182
 183 gchar *lightdm_greeter_ensure_shared_data_dir_sync (LightDMGreeter *greeter, const gchar *username, GError **error);
 184
 185 #ifndef LIGHTDM_DISABLE_DEPRECATED
 186 gboolean lightdm_greeter_connect_sync (LightDMGreeter *greeter, GError **error);
 187 #endif
 188
 189 G_END_DECLS
 190
 191 #endif /* LIGHTDM_GREETER_H_ */