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_SIGNAL_SHOW_PROMPT             "show-prompt"
  27 #define LIGHTDM_GREETER_SIGNAL_SHOW_MESSAGE            "show-message"
  28 #define LIGHTDM_GREETER_SIGNAL_AUTHENTICATION_COMPLETE "authentication-complete"
  29 #define LIGHTDM_GREETER_SIGNAL_AUTOLOGIN_TIMER_EXPIRED "autologin-timer-expired"
  30 #define LIGHTDM_GREETER_SIGNAL_IDLE                    "idle"
  31 #define LIGHTDM_GREETER_SIGNAL_RESET                   "reset"
  32
  33 /**
  34  * LightDMPromptType:
  35  * @LIGHTDM_PROMPT_TYPE_QUESTION: Prompt is a question.  The information can be shown as it is entered.
  36  * @LIGHTDM_PROMPT_TYPE_SECRET: Prompt is for secret information.  The entered information should be obscured so it can't be publically visible.
  37  */
  38 typedef enum
  39 {
  40     LIGHTDM_PROMPT_TYPE_QUESTION,
  41     LIGHTDM_PROMPT_TYPE_SECRET
  42 } LightDMPromptType;
  43
  44 /**
  45  * LightDMMessageType:
  46  * @LIGHTDM_MESSAGE_TYPE_INFO: Informational message.
  47  * @LIGHTDM_MESSAGE_TYPE_ERROR: Error message.
  48  */
  49 typedef enum
  50 {
  51     LIGHTDM_MESSAGE_TYPE_INFO,
  52     LIGHTDM_MESSAGE_TYPE_ERROR
  53 } LightDMMessageType;
  54
  55 typedef struct
  56 {
  57     GObject parent_instance;
  58 } LightDMGreeter;
  59
  60 typedef struct
  61 {
  62     GObjectClass parent_class;
  63
  64     void (*show_message)(LightDMGreeter *greeter, const gchar *text, LightDMMessageType type);
  65     void (*show_prompt)(LightDMGreeter *greeter, const gchar *text, LightDMPromptType type);
  66     void (*authentication_complete)(LightDMGreeter *greeter);
  67     void (*autologin_timer_expired)(LightDMGreeter *greeter);
  68     void (*idle)(LightDMGreeter *greeter);
  69     void (*reset)(LightDMGreeter *greeter);
  70
  71     /* Reserved */
  72     void (*reserved1) (void);
  73     void (*reserved2) (void);
  74     void (*reserved3) (void);
  75     void (*reserved4) (void);
  76 } LightDMGreeterClass;
  77
  78 GType lightdm_greeter_get_type (void);
  79
  80 LightDMGreeter *lightdm_greeter_new (void);
  81
  82 void lightdm_greeter_set_resettable (LightDMGreeter *greeter, gboolean resettable);
  83
  84 void lightdm_greeter_connect_to_daemon (LightDMGreeter *greeter, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
  85
  86 gboolean lightdm_greeter_connect_to_daemon_finish (LightDMGreeter *greeter, GAsyncResult *result, GError **error);
  87
  88 gboolean lightdm_greeter_connect_to_daemon_sync (LightDMGreeter *greeter, GError **error);
  89
  90 gboolean lightdm_greeter_connect_sync (LightDMGreeter *greeter, GError **error);
  91
  92 const gchar *lightdm_greeter_get_hint (LightDMGreeter *greeter, const gchar *name);
  93
  94 const gchar *lightdm_greeter_get_default_session_hint (LightDMGreeter *greeter);
  95
  96 gboolean lightdm_greeter_get_hide_users_hint (LightDMGreeter *greeter);
  97
  98 gboolean lightdm_greeter_get_show_manual_login_hint (LightDMGreeter *greeter);
  99
 100 gboolean lightdm_greeter_get_show_remote_login_hint (LightDMGreeter *greeter);
 101
 102 gboolean lightdm_greeter_get_lock_hint (LightDMGreeter *greeter);
 103
 104 gboolean lightdm_greeter_get_has_guest_account_hint (LightDMGreeter *greeter);
 105
 106 const gchar *lightdm_greeter_get_select_user_hint (LightDMGreeter *greeter);
 107
 108 gboolean lightdm_greeter_get_select_guest_hint (LightDMGreeter *greeter);
 109
 110 const gchar *lightdm_greeter_get_autologin_user_hint (LightDMGreeter *greeter);
 111
 112 gboolean lightdm_greeter_get_autologin_guest_hint (LightDMGreeter *greeter);
 113
 114 gint lightdm_greeter_get_autologin_timeout_hint (LightDMGreeter *greeter);
 115
 116 void lightdm_greeter_cancel_autologin (LightDMGreeter *greeter);
 117
 118 void lightdm_greeter_authenticate (LightDMGreeter *greeter, const gchar *username);
 119
 120 void lightdm_greeter_authenticate_as_guest (LightDMGreeter *greeter);
 121
 122 void lightdm_greeter_authenticate_autologin (LightDMGreeter *greeter);
 123
 124 void lightdm_greeter_authenticate_remote (LightDMGreeter *greeter, const gchar *session, const gchar *username);
 125
 126 void lightdm_greeter_respond (LightDMGreeter *greeter, const gchar *response);
 127
 128 void lightdm_greeter_cancel_authentication (LightDMGreeter *greeter);
 129
 130 gboolean lightdm_greeter_get_in_authentication (LightDMGreeter *greeter);
 131
 132 gboolean lightdm_greeter_get_is_authenticated (LightDMGreeter *greeter);
 133
 134 const gchar *lightdm_greeter_get_authentication_user (LightDMGreeter *greeter);
 135
 136 void lightdm_greeter_set_language (LightDMGreeter *greeter, const gchar *language);
 137
 138 void lightdm_greeter_start_session (LightDMGreeter *greeter, const gchar *session, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
 139
 140 gboolean lightdm_greeter_start_session_finish (LightDMGreeter *greeter, GAsyncResult *result, GError **error);
 141
 142 gboolean lightdm_greeter_start_session_sync (LightDMGreeter *greeter, const gchar *session, GError **error);
 143
 144 void lightdm_greeter_ensure_shared_data_dir (LightDMGreeter *greeter, const gchar *username, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
 145
 146 gchar *lightdm_greeter_ensure_shared_data_dir_finish (LightDMGreeter *greeter, GAsyncResult *result);
 147
 148 gchar *lightdm_greeter_ensure_shared_data_dir_sync (LightDMGreeter *greeter, const gchar *username);
 149
 150 G_END_DECLS
 151
 152 #endif /* LIGHTDM_GREETER_H_ */