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 _LDM_GREETER_H_
  13 #define _LDM_GREETER_H_
  14
  15 #include <glib-object.h>
  16
  17 G_BEGIN_DECLS
  18
  19 #define LDM_TYPE_GREETER            (ldm_greeter_get_type())
  20 #define LDM_GREETER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), LDM_TYPE_GREETER, LdmGreeter));
  21 #define LDM_GREETER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), LDM_TYPE_GREETER, LdmGreeterClass))
  22 #define LDM_IS_GREETER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LDM_TYPE_GREETER))
  23 #define LDM_IS_GREETER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), LDM_TYPE_GREETER))
  24 #define LDM_GREETER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), LDM_TYPE_GREETER, LdmGreeterClass))
  25
  26 typedef struct _LdmGreeter        LdmGreeter;
  27 typedef struct _LdmGreeterClass   LdmGreeterClass;
  28 typedef struct _LdmGreeterPrivate LdmGreeterPrivate;
  29
  30 #include "user.h"
  31 #include "language.h"
  32 #include "layout.h"
  33 #include "session.h"
  34
  35 typedef enum
  36 {
  37     LDM_PROMPT_TYPE_QUESTION,
  38     LDM_PROMPT_TYPE_SECRET
  39 } LdmPromptType;
  40
  41 typedef enum
  42 {
  43     LDM_MESSAGE_TYPE_INFO,
  44     LDM_MESSAGE_TYPE_ERROR
  45 } LdmMessageType;
  46
  47 struct _LdmGreeter
  48 {
  49     GObject            parent_instance;
  50     /*<private>*/
  51     LdmGreeterPrivate *priv;
  52 };
  53
  54 struct _LdmGreeterClass
  55 {
  56     GObjectClass parent_class;
  57
  58     void (*connected)(LdmGreeter *greeter);
  59     void (*show_prompt)(LdmGreeter *greeter, const gchar *text, LdmPromptType type);
  60     void (*show_message)(LdmGreeter *greeter, const gchar *text, LdmMessageType type);
  61     void (*authentication_complete)(LdmGreeter *greeter);
  62     void (*timed_login)(LdmGreeter *greeter, const gchar *username);
  63     void (*user_added)(LdmGreeter *greeter, LdmUser *user);
  64     void (*user_changed)(LdmGreeter *greeter, LdmUser *user);
  65     void (*user_removed)(LdmGreeter *greeter, LdmUser *user);
  66     void (*quit)(LdmGreeter *greeter);
  67 };
  68
  69 GType ldm_greeter_get_type (void);
  70
  71 LdmGreeter *ldm_greeter_new (void);
  72
  73 gboolean ldm_greeter_connect_to_server (LdmGreeter *greeter);
  74
  75 const gchar *ldm_greeter_get_hostname (LdmGreeter *greeter);
  76
  77 gint ldm_greeter_get_num_users (LdmGreeter *greeter);
  78
  79 GList *ldm_greeter_get_users (LdmGreeter *greeter);
  80
  81 LdmUser *ldm_greeter_get_user_by_name (LdmGreeter *greeter, const gchar *username);
  82
  83 const gchar *ldm_greeter_get_default_language (LdmGreeter *greeter);
  84
  85 GList *ldm_greeter_get_languages (LdmGreeter *greeter);
  86
  87 GList *ldm_greeter_get_layouts (LdmGreeter *greeter);
  88
  89 void ldm_greeter_set_layout (LdmGreeter *greeter, const gchar *layout);
  90
  91 const gchar *ldm_greeter_get_layout (LdmGreeter *greeter);
  92
  93 GList *ldm_greeter_get_sessions (LdmGreeter *greeter);
  94
  95 const gchar *ldm_greeter_get_default_session (LdmGreeter *greeter);
  96
  97 gboolean ldm_greeter_get_has_guest_session (LdmGreeter *greeter);
  98
  99 const gchar *ldm_greeter_get_timed_login_user (LdmGreeter *greeter);
 100
 101 gint ldm_greeter_get_timed_login_delay (LdmGreeter *greeter);
 102
 103 void ldm_greeter_cancel_timed_login (LdmGreeter *greeter);
 104
 105 void ldm_greeter_login (LdmGreeter *greeter, const char *username);
 106
 107 void ldm_greeter_login_with_user_prompt (LdmGreeter *greeter);
 108
 109 void ldm_greeter_login_as_guest (LdmGreeter *greeter);
 110
 111 void ldm_greeter_respond (LdmGreeter *greeter, const gchar *response);
 112
 113 void ldm_greeter_cancel_authentication (LdmGreeter *greeter);
 114
 115 gboolean ldm_greeter_get_in_authentication (LdmGreeter *greeter);
 116
 117 gboolean ldm_greeter_get_is_authenticated (LdmGreeter *greeter);
 118
 119 const gchar *ldm_greeter_get_authentication_user (LdmGreeter *greeter);
 120
 121 void ldm_greeter_start_session (LdmGreeter *greeter, const gchar *session);
 122
 123 void ldm_greeter_start_default_session (LdmGreeter *greeter);
 124
 125 gboolean ldm_greeter_get_can_suspend (LdmGreeter *greeter);
 126
 127 void ldm_greeter_suspend (LdmGreeter *greeter);
 128
 129 gboolean ldm_greeter_get_can_hibernate (LdmGreeter *greeter);
 130
 131 void ldm_greeter_hibernate (LdmGreeter *greeter);
 132
 133 gboolean ldm_greeter_get_can_restart (LdmGreeter *greeter);
 134
 135 void ldm_greeter_restart (LdmGreeter *greeter);
 136
 137 gboolean ldm_greeter_get_can_shutdown (LdmGreeter *greeter);
 138
 139 void ldm_greeter_shutdown (LdmGreeter *greeter);
 140
 141 G_END_DECLS
 142
 143 #endif /* _LDM_GREETER_H_ */