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