libldmgreeter/greeter.h

   1 /*
   2  * Copyright (C) 2010 Robert Ancell.
   3  * Author: Robert Ancell <robert.ancell@canonical.com>
   4  *
   5  * This program is free software: you can redistribute it and/or modify it under
   6  * the terms of the GNU General Public License as published by the Free Software
   7  * Foundation, either version 3 of the License, or (at your option) any later
   8  * version. See http://www.gnu.org/copyleft/gpl.html the full text of the
   9  * license.
  10  */
  11
  12 #ifndef _GREETER_H_
  13 #define _GREETER_H_
  14
  15 #include <glib-object.h>
  16
  17 G_BEGIN_DECLS
  18
  19 #define TYPE_GREETER            (greeter_get_type())
  20 #define GREETER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), TYPE_GREETER, Greeter));
  21 #define GREETER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), TYPE_GREETER, GreeterClass))
  22 #define IS_GREETER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), TYPE_GREETER))
  23 #define IS_GREETER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), TYPE_GREETER))
  24 #define GREETER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), TYPE_GREETER, GreeterClass))
  25
  26
  27 /*<private>*/
  28 typedef struct GreeterPrivate GreeterPrivate;
  29
  30 typedef struct
  31 {
  32     GObject         parent_instance;
  33     GreeterPrivate *GSEAL (priv);
  34 } Greeter;
  35
  36 typedef struct
  37 {
  38     GObjectClass parent_class;
  39
  40     /*< private >*/
  41
  42     void (*show_prompt)(Greeter *greeter, const gchar *text);
  43     void (*show_message)(Greeter *greeter, const gchar *text);
  44     void (*show_error)(Greeter *greeter, const gchar *text);
  45     void (*authentication_complete)(Greeter *greeter);
  46     void (*timed_login)(Greeter *greeter, const gchar *username);
  47 } GreeterClass;
  48
  49 typedef struct
  50 {
  51    gchar *name;
  52    gchar *real_name;
  53    gchar *image;
  54    gboolean logged_in;
  55 } UserInfo;
  56
  57 typedef struct
  58 {
  59    gchar *key;
  60    gchar *name;
  61    gchar *comment;
  62 } Session;
  63
  64 GType greeter_get_type (void);
  65
  66 Greeter *greeter_new (void);
  67
  68 gboolean greeter_connect (Greeter *greeter);
  69
  70 gint greeter_get_num_users (Greeter *greeter);
  71
  72 const GList *greeter_get_users (Greeter *greeter);
  73
  74 const GList *greeter_get_sessions (Greeter *greeter);
  75
  76 const gchar *greeter_get_session (Greeter *greeter);
  77
  78 void greeter_set_session (Greeter *greeter, const gchar *session);
  79
  80 const gchar *greeter_get_timed_login_user (Greeter *greeter);
  81
  82 gint greeter_get_timed_login_delay (Greeter *greeter);
  83
  84 void greeter_cancel_timed_login (Greeter *greeter);
  85
  86 void greeter_start_authentication (Greeter *greeter, const char *username);
  87
  88 void greeter_provide_secret (Greeter *greeter, const gchar *secret);
  89
  90 void greeter_cancel_authentication (Greeter *greeter);
  91
  92 gboolean greeter_get_is_authenticated (Greeter *greeter);
  93
  94 gboolean greeter_get_can_suspend (Greeter *greeter);
  95
  96 void greeter_suspend (Greeter *greeter);
  97
  98 gboolean greeter_get_can_hibernate (Greeter *greeter);
  99
 100 void greeter_hibernate (Greeter *greeter);
 101
 102 gboolean greeter_get_can_restart (Greeter *greeter);
 103
 104 void greeter_restart (Greeter *greeter);
 105
 106 gboolean greeter_get_can_shutdown (Greeter *greeter);
 107
 108 void greeter_shutdown (Greeter *greeter);
 109
 110 G_END_DECLS
 111
 112 #endif /* _GREETER_H_ */