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 3 of the License, or (at your option) any
   8  * later version. See http://www.gnu.org/copyleft/lgpl.html the full text of the
   9  * license.
  10  */
  11
  12 #ifndef _LIGHTDM_GREETER_H_
  13 #define _LIGHTDM_GREETER_H_
  14
  15 #include <glib-object.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 typedef struct _LightDMGreeter        LightDMGreeter;
  27 typedef struct _LightDMGreeterClass   LightDMGreeterClass;
  28
  29 #include "user.h"
  30 #include "language.h"
  31 #include "layout.h"
  32 #include "session.h"
  33
  34 /**
  35  * LightDMPromptType:
  36  * @LIGHTDM_PROMPT_TYPE_QUESTION: Prompt is a question.  The information can be shown as it is entered.
  37  * @LIGHTDM_PROMPT_TYPE_SECRET: Prompt is for secret information.  The entered information should be obscured so it can't be publically visible.
  38  */
  39 typedef enum
  40 {
  41     LIGHTDM_PROMPT_TYPE_QUESTION,
  42     LIGHTDM_PROMPT_TYPE_SECRET
  43 } LightDMPromptType;
  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 struct _LightDMGreeter
  57 {
  58     GObject parent_instance;
  59 };
  60
  61 struct _LightDMGreeterClass
  62 {
  63     GObjectClass parent_class;
  64
  65     void (*connected)(LightDMGreeter *greeter);
  66     void (*show_prompt)(LightDMGreeter *greeter, const gchar *text, LightDMPromptType type);
  67     void (*show_message)(LightDMGreeter *greeter, const gchar *text, LightDMMessageType type);
  68     void (*authentication_complete)(LightDMGreeter *greeter);
  69     void (*session_failed)(LightDMGreeter *greeter);
  70     void (*autologin_timer_expired)(LightDMGreeter *greeter);
  71     void (*user_added)(LightDMGreeter *greeter, LightDMUser *user);
  72     void (*user_changed)(LightDMGreeter *greeter, LightDMUser *user);
  73     void (*user_removed)(LightDMGreeter *greeter, LightDMUser *user);
  74     void (*quit)(LightDMGreeter *greeter);
  75 };
  76
  77 GType lightdm_greeter_get_type (void);
  78
  79 LightDMGreeter *lightdm_greeter_new (void);
  80
  81 gboolean lightdm_greeter_connect_to_server (LightDMGreeter *greeter);
  82
  83 const gchar *lightdm_greeter_get_hostname (LightDMGreeter *greeter);
  84
  85 gint lightdm_greeter_get_num_users (LightDMGreeter *greeter);
  86
  87 GList *lightdm_greeter_get_users (LightDMGreeter *greeter);
  88
  89 LightDMUser *lightdm_greeter_get_user_by_name (LightDMGreeter *greeter, const gchar *username);
  90
  91 const gchar *lightdm_greeter_get_default_language (LightDMGreeter *greeter);
  92
  93 GList *lightdm_greeter_get_languages (LightDMGreeter *greeter);
  94
  95 GList *lightdm_greeter_get_layouts (LightDMGreeter *greeter);
  96
  97 void lightdm_greeter_set_layout (LightDMGreeter *greeter, const gchar *layout);
  98
  99 const gchar *lightdm_greeter_get_layout (LightDMGreeter *greeter);
 100
 101 GList *lightdm_greeter_get_sessions (LightDMGreeter *greeter);
 102
 103 const gchar *lightdm_greeter_get_hint (LightDMGreeter *greeter, const gchar *name);
 104
 105 const gchar *lightdm_greeter_get_default_session_hint (LightDMGreeter *greeter);
 106
 107 gboolean lightdm_greeter_get_hide_users_hint (LightDMGreeter *greeter);
 108
 109 gboolean lightdm_greeter_get_has_guest_account_hint (LightDMGreeter *greeter);
 110
 111 const gchar *lightdm_greeter_get_select_user_hint (LightDMGreeter *greeter);
 112
 113 gboolean lightdm_greeter_get_select_guest_hint (LightDMGreeter *greeter);
 114
 115 const gchar *lightdm_greeter_get_autologin_user_hint (LightDMGreeter *greeter);
 116
 117 gboolean lightdm_greeter_get_autologin_guest_hint (LightDMGreeter *greeter);
 118
 119 gint lightdm_greeter_get_autologin_timeout_hint (LightDMGreeter *greeter);
 120
 121 void lightdm_greeter_cancel_timed_login (LightDMGreeter *greeter);
 122
 123 void lightdm_greeter_login (LightDMGreeter *greeter, const char *username);
 124
 125 void lightdm_greeter_login_with_user_prompt (LightDMGreeter *greeter);
 126
 127 void lightdm_greeter_login_as_guest (LightDMGreeter *greeter);
 128
 129 void lightdm_greeter_respond (LightDMGreeter *greeter, const gchar *response);
 130
 131 void lightdm_greeter_cancel_authentication (LightDMGreeter *greeter);
 132
 133 gboolean lightdm_greeter_get_in_authentication (LightDMGreeter *greeter);
 134
 135 gboolean lightdm_greeter_get_is_authenticated (LightDMGreeter *greeter);
 136
 137 const gchar *lightdm_greeter_get_authentication_user (LightDMGreeter *greeter);
 138
 139 void lightdm_greeter_start_session (LightDMGreeter *greeter, const gchar *session);
 140
 141 void lightdm_greeter_start_default_session (LightDMGreeter *greeter);
 142
 143 gboolean lightdm_greeter_get_can_suspend (LightDMGreeter *greeter);
 144
 145 void lightdm_greeter_suspend (LightDMGreeter *greeter);
 146
 147 gboolean lightdm_greeter_get_can_hibernate (LightDMGreeter *greeter);
 148
 149 void lightdm_greeter_hibernate (LightDMGreeter *greeter);
 150
 151 gboolean lightdm_greeter_get_can_restart (LightDMGreeter *greeter);
 152
 153 void lightdm_greeter_restart (LightDMGreeter *greeter);
 154
 155 gboolean lightdm_greeter_get_can_shutdown (LightDMGreeter *greeter);
 156
 157 void lightdm_greeter_shutdown (LightDMGreeter *greeter);
 158
 159 G_END_DECLS
 160
 161 #endif /* _LIGHTDM_GREETER_H_ */