Tidy up LightDMGreeterError documentation - still not sure why it doesn't show in...

[sojka/lightdm.git] / liblightdm-gobject / lightdm / greeter.h

diff --git a/liblightdm-gobject/lightdm/greeter.h b/liblightdm-gobject/lightdm/greeter.h
index dde714257d16436e7cddd1c7e48c2245efa92092..11f5e4bbad9ea9fb1978e4e4ab1988f28603314c 100644 (file)
--- a/liblightdm-gobject/lightdm/greeter.h
+++ b/liblightdm-gobject/lightdm/greeter.h
@@ -16,12 +16,18 @@
 
 G_BEGIN_DECLS
 
-#define LIGHTDM_TYPE_GREETER            (lightdm_greeter_get_type())
-#define LIGHTDM_GREETER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), LIGHTDM_TYPE_GREETER, LightDMGreeter))
-#define LIGHTDM_GREETER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), LIGHTDM_TYPE_GREETER, LightDMGreeterClass))
-#define LIGHTDM_IS_GREETER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LIGHTDM_TYPE_GREETER))
-#define LIGHTDM_IS_GREETER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), LIGHTDM_TYPE_GREETER))
-#define LIGHTDM_GREETER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), LIGHTDM_TYPE_GREETER, LightDMGreeterClass))
+#define LIGHTDM_TYPE_GREETER (lightdm_greeter_get_type())
+
+G_DECLARE_DERIVABLE_TYPE (LightDMGreeter, lightdm_greeter, LIGHTDM, GREETER, GObject)
+
+#define LIGHTDM_GREETER_ERROR lightdm_greeter_error_quark ()
+
+#define LIGHTDM_GREETER_SIGNAL_SHOW_PROMPT             "show-prompt"
+#define LIGHTDM_GREETER_SIGNAL_SHOW_MESSAGE            "show-message"
+#define LIGHTDM_GREETER_SIGNAL_AUTHENTICATION_COMPLETE "authentication-complete"
+#define LIGHTDM_GREETER_SIGNAL_AUTOLOGIN_TIMER_EXPIRED "autologin-timer-expired"
+#define LIGHTDM_GREETER_SIGNAL_IDLE                    "idle"
+#define LIGHTDM_GREETER_SIGNAL_RESET                   "reset"
 
 /**
  * LightDMPromptType:
@@ -34,6 +40,8 @@ typedef enum
     LIGHTDM_PROMPT_TYPE_SECRET
 } LightDMPromptType;
 
+GType lightdm_prompt_type_get_type (void);
+
 /**
  * LightDMMessageType:
  * @LIGHTDM_MESSAGE_TYPE_INFO: Informational message.
@@ -45,12 +53,9 @@ typedef enum
     LIGHTDM_MESSAGE_TYPE_ERROR
 } LightDMMessageType;
 
-typedef struct
-{
-    GObject parent_instance;
-} LightDMGreeter;
+GType lightdm_message_type_get_type (void);
 
-typedef struct
+struct _LightDMGreeterClass
 {
     GObjectClass parent_class;
 
@@ -66,19 +71,40 @@ typedef struct
     void (*reserved2) (void);
     void (*reserved3) (void);
     void (*reserved4) (void);
-} LightDMGreeterClass;
+};
 
-GType lightdm_greeter_get_type (void);
+/**
+ * LightDMGreeterError:
+ * @LIGHTDM_GREETER_ERROR_COMMUNICATION_ERROR: error communicating with daemon.
+ * @LIGHTDM_GREETER_ERROR_CONNECTION_FAILED: failed to connect to the daemon.
+ * @LIGHTDM_GREETER_ERROR_SESSION_FAILED: requested session failed to start.
+ * @LIGHTDM_GREETER_ERROR_NO_AUTOLOGIN: autologin not configured.
+ * @LIGHTDM_GREETER_ERROR_INVALID_USER: autologin not configured.
+ *
+ * Error codes returned by greeter operations.
+ */
+typedef enum
+{
+    LIGHTDM_GREETER_ERROR_COMMUNICATION_ERROR,
+    LIGHTDM_GREETER_ERROR_CONNECTION_FAILED,
+    LIGHTDM_GREETER_ERROR_SESSION_FAILED,
+    LIGHTDM_GREETER_ERROR_NO_AUTOLOGIN,
+    LIGHTDM_GREETER_ERROR_INVALID_USER
+} LightDMGreeterError;
+
+GQuark lightdm_greeter_error_quark (void);
+
+GType lightdm_greeter_error_get_type (void);
 
 LightDMGreeter *lightdm_greeter_new (void);
 
 void lightdm_greeter_set_resettable (LightDMGreeter *greeter, gboolean resettable);
 
-void lightdm_greeter_connect (LightDMGreeter *greeter, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
+void lightdm_greeter_connect_to_daemon (LightDMGreeter *greeter, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
 
-gboolean lightdm_greeter_connect_finish (LightDMGreeter *greeter, GAsyncResult *result, GError **error);
+gboolean lightdm_greeter_connect_to_daemon_finish (LightDMGreeter *greeter, GAsyncResult *result, GError **error);
 
-gboolean lightdm_greeter_connect_sync (LightDMGreeter *greeter, GError **error);
+gboolean lightdm_greeter_connect_to_daemon_sync (LightDMGreeter *greeter, GError **error);
 
 const gchar *lightdm_greeter_get_hint (LightDMGreeter *greeter, const gchar *name);
 
@@ -106,17 +132,17 @@ gint lightdm_greeter_get_autologin_timeout_hint (LightDMGreeter *greeter);
 
 void lightdm_greeter_cancel_autologin (LightDMGreeter *greeter);
 
-void lightdm_greeter_authenticate (LightDMGreeter *greeter, const gchar *username);
+gboolean lightdm_greeter_authenticate (LightDMGreeter *greeter, const gchar *username, GError **error);
 
-void lightdm_greeter_authenticate_as_guest (LightDMGreeter *greeter);
+gboolean lightdm_greeter_authenticate_as_guest (LightDMGreeter *greeter, GError **error);
 
-void lightdm_greeter_authenticate_autologin (LightDMGreeter *greeter);
+gboolean lightdm_greeter_authenticate_autologin (LightDMGreeter *greeter, GError **error);
 
-void lightdm_greeter_authenticate_remote (LightDMGreeter *greeter, const gchar *session, const gchar *username);
+gboolean lightdm_greeter_authenticate_remote (LightDMGreeter *greeter, const gchar *session, const gchar *username, GError **error);
 
-void lightdm_greeter_respond (LightDMGreeter *greeter, const gchar *response);
+gboolean lightdm_greeter_respond (LightDMGreeter *greeter, const gchar *response, GError **error);
 
-void lightdm_greeter_cancel_authentication (LightDMGreeter *greeter);
+gboolean lightdm_greeter_cancel_authentication (LightDMGreeter *greeter, GError **error);
 
 gboolean lightdm_greeter_get_in_authentication (LightDMGreeter *greeter);
 
@@ -124,7 +150,7 @@ gboolean lightdm_greeter_get_is_authenticated (LightDMGreeter *greeter);
 
 const gchar *lightdm_greeter_get_authentication_user (LightDMGreeter *greeter);
 
-void lightdm_greeter_set_language (LightDMGreeter *greeter, const gchar *language);
+gboolean lightdm_greeter_set_language (LightDMGreeter *greeter, const gchar *language, GError **error);
 
 void lightdm_greeter_start_session (LightDMGreeter *greeter, const gchar *session, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
 
@@ -134,9 +160,13 @@ gboolean lightdm_greeter_start_session_sync (LightDMGreeter *greeter, const gcha
 
 void lightdm_greeter_ensure_shared_data_dir (LightDMGreeter *greeter, const gchar *username, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
 
-gchar *lightdm_greeter_ensure_shared_data_dir_finish (LightDMGreeter *greeter, GAsyncResult *result);
+gchar *lightdm_greeter_ensure_shared_data_dir_finish (LightDMGreeter *greeter, GAsyncResult *result, GError **error);
+
+gchar *lightdm_greeter_ensure_shared_data_dir_sync (LightDMGreeter *greeter, const gchar *username, GError **error);
 
-gchar *lightdm_greeter_ensure_shared_data_dir_sync (LightDMGreeter *greeter, const gchar *username);
+#ifndef LIGHTDM_DISABLE_DEPRECATED
+gboolean lightdm_greeter_connect_sync (LightDMGreeter *greeter, GError **error);
+#endif
 
 G_END_DECLS