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
  16 G_BEGIN_DECLS
  17
  18 #define LIGHTDM_TYPE_GREETER            (lightdm_greeter_get_type())
  19 #define LIGHTDM_GREETER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), LIGHTDM_TYPE_GREETER, LightDMGreeter));
  20 #define LIGHTDM_GREETER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), LIGHTDM_TYPE_GREETER, LightDMGreeterClass))
  21 #define LIGHTDM_IS_GREETER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LIGHTDM_TYPE_GREETER))
  22 #define LIGHTDM_IS_GREETER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), LIGHTDM_TYPE_GREETER))
  23 #define LIGHTDM_GREETER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), LIGHTDM_TYPE_GREETER, LightDMGreeterClass))
  24
  25 /**
  26  * LightDMPromptType:
  27  * @LIGHTDM_PROMPT_TYPE_QUESTION: Prompt is a question.  The information can be shown as it is entered.
  28  * @LIGHTDM_PROMPT_TYPE_SECRET: Prompt is for secret information.  The entered information should be obscured so it can't be publically visible.
  29  */
  30 typedef enum
  31 {
  32     LIGHTDM_PROMPT_TYPE_QUESTION,
  33     LIGHTDM_PROMPT_TYPE_SECRET
  34 } LightDMPromptType;
  35
  36 /**
  37  * LightDMMessageType:
  38  * @LIGHTDM_MESSAGE_TYPE_INFO: Informational message.
  39  * @LIGHTDM_MESSAGE_TYPE_ERROR: Error message.
  40  */
  41 typedef enum
  42 {
  43     LIGHTDM_MESSAGE_TYPE_INFO,
  44     LIGHTDM_MESSAGE_TYPE_ERROR
  45 } LightDMMessageType;
  46
  47 typedef struct
  48 {
  49     GObject parent_instance;
  50 } LightDMGreeter;
  51
  52 typedef struct
  53 {
  54     GObjectClass parent_class;
  55
  56     void (*show_message)(LightDMGreeter *greeter, const gchar *text, LightDMMessageType type);
  57     void (*show_prompt)(LightDMGreeter *greeter, const gchar *text, LightDMPromptType type);
  58     void (*authentication_complete)(LightDMGreeter *greeter);
  59     void (*autologin_timer_expired)(LightDMGreeter *greeter);
  60
  61     /* Reserved */
  62     void (*reserved1) (void);
  63     void (*reserved2) (void);
  64     void (*reserved3) (void);
  65     void (*reserved4) (void);
  66     void (*reserved5) (void);
  67     void (*reserved6) (void);
  68 } LightDMGreeterClass;
  69
  70 GType lightdm_greeter_get_type (void);
  71
  72 LightDMGreeter *lightdm_greeter_new (void);
  73
  74 gboolean lightdm_greeter_connect_sync (LightDMGreeter *greeter, GError **error);
  75
  76 const gchar *lightdm_greeter_get_hint (LightDMGreeter *greeter, const gchar *name);
  77
  78 const gchar *lightdm_greeter_get_default_session_hint (LightDMGreeter *greeter);
  79
  80 gboolean lightdm_greeter_get_hide_users_hint (LightDMGreeter *greeter);
  81
  82 gboolean lightdm_greeter_get_show_manual_login_hint (LightDMGreeter *greeter);
  83
  84 gboolean lightdm_greeter_get_show_remote_login_hint (LightDMGreeter *greeter);
  85
  86 gboolean lightdm_greeter_get_lock_hint (LightDMGreeter *greeter);
  87
  88 gboolean lightdm_greeter_get_has_guest_account_hint (LightDMGreeter *greeter);
  89
  90 const gchar *lightdm_greeter_get_select_user_hint (LightDMGreeter *greeter);
  91
  92 gboolean lightdm_greeter_get_select_guest_hint (LightDMGreeter *greeter);
  93
  94 const gchar *lightdm_greeter_get_autologin_user_hint (LightDMGreeter *greeter);
  95
  96 gboolean lightdm_greeter_get_autologin_guest_hint (LightDMGreeter *greeter);
  97
  98 gint lightdm_greeter_get_autologin_timeout_hint (LightDMGreeter *greeter);
  99
 100 void lightdm_greeter_cancel_autologin (LightDMGreeter *greeter);
 101
 102 void lightdm_greeter_authenticate (LightDMGreeter *greeter, const gchar *username);
 103
 104 void lightdm_greeter_authenticate_as_guest (LightDMGreeter *greeter);
 105
 106 void lightdm_greeter_authenticate_autologin (LightDMGreeter *greeter);
 107
 108 void lightdm_greeter_authenticate_remote (LightDMGreeter *greeter, const gchar *session, const gchar *username);
 109
 110 void lightdm_greeter_respond (LightDMGreeter *greeter, const gchar *response);
 111
 112 void lightdm_greeter_cancel_authentication (LightDMGreeter *greeter);
 113
 114 gboolean lightdm_greeter_get_in_authentication (LightDMGreeter *greeter);
 115
 116 gboolean lightdm_greeter_get_is_authenticated (LightDMGreeter *greeter);
 117
 118 const gchar *lightdm_greeter_get_authentication_user (LightDMGreeter *greeter);
 119
 120 void lightdm_greeter_set_language (LightDMGreeter *greeter, const gchar *language);
 121
 122 gboolean lightdm_greeter_start_session_sync (LightDMGreeter *greeter, const gchar *session, GError **error);
 123
 124 G_END_DECLS
 125
 126 #endif /* LIGHTDM_GREETER_H_ */