diff options
author | Robert Ancell <robert.ancell@canonical.com> | 2011-07-19 16:40:33 +1000 |
---|---|---|
committer | Robert Ancell <robert.ancell@canonical.com> | 2011-07-19 16:40:33 +1000 |
commit | afa0ab56faa78e7ac6eef409ec2a89992e153896 (patch) | |
tree | ff960ffb270895a520c8b242ae6ebaec58596a3a /doc | |
parent | bb700a166d0416462e511189c9804634f11e5d16 (diff) | |
download | lightdm-afa0ab56faa78e7ac6eef409ec2a89992e153896.tar.gz |
Really tidy up liblightdm
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 2 | ||||
-rw-r--r-- | doc/lightdm-gobject-1-docs.sgml | 2 | ||||
-rw-r--r-- | doc/lightdm-gobject-1-sections.txt | 106 | ||||
-rw-r--r-- | doc/tmpl/greeter.sgml | 151 | ||||
-rw-r--r-- | doc/tmpl/language.sgml | 22 | ||||
-rw-r--r-- | doc/tmpl/layout.sgml | 30 | ||||
-rw-r--r-- | doc/tmpl/power.sgml | 90 | ||||
-rw-r--r-- | doc/tmpl/session.sgml | 13 | ||||
-rw-r--r-- | doc/tmpl/system.sgml | 31 | ||||
-rw-r--r-- | doc/tmpl/user.sgml | 84 |
10 files changed, 317 insertions, 214 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index e67c158b..6594a626 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -4,7 +4,7 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml DOC_SOURCE_DIR=$(top_srcdir)/liblightdm-gobject -HFILE_GLOB=$(top_srcdir)/liblightdm-gobject/lightdm/*.h +HFILE_GLOB=$(top_srcdir)/liblightdm-gobject/lightdm.h CFILE_GLOB=$(top_srcdir)/liblightdm-gobject/*.c INCLUDES = \ diff --git a/doc/lightdm-gobject-1-docs.sgml b/doc/lightdm-gobject-1-docs.sgml index a8be08d3..31fdcb2b 100644 --- a/doc/lightdm-gobject-1-docs.sgml +++ b/doc/lightdm-gobject-1-docs.sgml @@ -20,5 +20,7 @@ <xi:include href="xml/layout.xml"/> <xi:include href="xml/session.xml"/> <xi:include href="xml/user.xml"/> + <xi:include href="xml/power.xml"/> + <xi:include href="xml/system.xml"/> </part> </book> diff --git a/doc/lightdm-gobject-1-sections.txt b/doc/lightdm-gobject-1-sections.txt index 86eaf37a..0e71ca85 100644 --- a/doc/lightdm-gobject-1-sections.txt +++ b/doc/lightdm-gobject-1-sections.txt @@ -1,8 +1,29 @@ -<INCLUDE>lightdm/greeter.h</INCLUDE> +<INCLUDE>lightdm.h</INCLUDE> + +<SECTION> +<FILE>system</FILE> +<TITLE>System Information</TITLE> +lightdm_get_hostname +</SECTION> + +<SECTION> +<FILE>power</FILE> +<TITLE>Power Management</TITLE> +lightdm_get_can_suspend +lightdm_suspend +lightdm_get_can_hibernate +lightdm_hibernate +lightdm_get_can_restart +lightdm_restart +lightdm_get_can_shutdown +lightdm_shutdown +</SECTION> <SECTION> <FILE>language</FILE> -<TITLE>LightDMLanguage</TITLE> +<TITLE>Languages</TITLE> +lightdm_get_languages +lightdm_get_language lightdm_language_get_code lightdm_language_get_name lightdm_language_get_territory @@ -20,7 +41,10 @@ lightdm_language_get_type <SECTION> <FILE>layout</FILE> -<TITLE>LightDMLayout</TITLE> +<TITLE>Keyboard Layout</TITLE> +lightdm_get_layouts +lightdm_get_layout +lightdm_set_layout lightdm_layout_get_name lightdm_layout_get_short_description lightdm_layout_get_description @@ -36,32 +60,9 @@ lightdm_layout_get_type </SECTION> <SECTION> -<FILE>user</FILE> -<TITLE>LightDMUser</TITLE> -changed -lightdm_user_get_name -lightdm_user_get_real_name -lightdm_user_get_display_name -lightdm_user_get_home_directory -lightdm_user_get_image -lightdm_user_get_language -lightdm_user_get_layout -lightdm_user_get_session -lightdm_user_get_logged_in -<SUBSECTION Standard> -LIGHTDM_USER -LIGHTDM_IS_USER -LIGHTDM_TYPE_USER -lightdm_user_get_type -LIGHTDM_USER_CLASS -LIGHTDM_IS_USER_CLASS -LIGHTDM_USER_GET_CLASS -<SUBSECTION Private> -</SECTION> - -<SECTION> <FILE>session</FILE> -<TITLE>LightDMSession</TITLE> +<TITLE>Sessions</TITLE> +lightdm_get_sessions lightdm_session_get_key lightdm_session_get_name lightdm_session_get_comment @@ -77,16 +78,33 @@ LIGHTDM_SESSION_GET_CLASS </SECTION> <SECTION> -<FILE>user-list</FILE> -<TITLE>LightDMUserList</TITLE> +<FILE>user</FILE> +<TITLE>User Accounts</TITLE> +changed +lightdm_user_get_display_name +lightdm_user_get_home_directory +lightdm_user_get_image +lightdm_user_get_language +lightdm_user_get_layout +lightdm_user_get_logged_in +lightdm_user_get_name +lightdm_user_get_real_name +lightdm_user_get_session user_added user_changed user_removed -lightdm_user_list_new -lightdm_user_list_get_num_users +lightdm_user_list_get_instance +lightdm_user_list_get_length lightdm_user_list_get_user_by_name lightdm_user_list_get_users <SUBSECTION Standard> +LIGHTDM_IS_USER +LIGHTDM_IS_USER_CLASS +LIGHTDM_TYPE_USER +lightdm_user_get_type +LIGHTDM_USER +LIGHTDM_USER_CLASS +LIGHTDM_USER_GET_CLASS LIGHTDM_USER_LIST LIGHTDM_IS_USER_LIST LIGHTDM_TYPE_USER_LIST @@ -99,7 +117,7 @@ LIGHTDM_USER_LIST_GET_CLASS <SECTION> <FILE>greeter</FILE> -<TITLE>LightDMGreeter</TITLE> +<TITLE>Greeter Interface</TITLE> connected autologin_timer_expired show_message @@ -111,13 +129,6 @@ LightDMMessageType LightDMPromptType lightdm_greeter_new lightdm_greeter_connect_to_server -lightdm_greeter_get_hostname -lightdm_greeter_get_default_language -lightdm_greeter_get_languages -lightdm_greeter_get_layouts -lightdm_greeter_get_layout -lightdm_greeter_set_layout -lightdm_greeter_get_sessions lightdm_greeter_get_default_session_hint lightdm_greeter_get_hint lightdm_greeter_get_has_guest_account_hint @@ -127,10 +138,9 @@ lightdm_greeter_get_select_guest_hint lightdm_greeter_get_autologin_user_hint lightdm_greeter_get_autologin_guest_hint lightdm_greeter_get_autologin_timeout_hint -lightdm_greeter_cancel_timed_login -lightdm_greeter_login -lightdm_greeter_login_with_user_prompt -lightdm_greeter_login_as_guest +lightdm_greeter_cancel_autologin +lightdm_greeter_authenticate +lightdm_greeter_authenticate_as_guest lightdm_greeter_respond lightdm_greeter_cancel_authentication lightdm_greeter_get_in_authentication @@ -138,14 +148,6 @@ lightdm_greeter_get_is_authenticated lightdm_greeter_get_authentication_user lightdm_greeter_start_session lightdm_greeter_start_default_session -lightdm_greeter_get_can_suspend -lightdm_greeter_suspend -lightdm_greeter_get_can_hibernate -lightdm_greeter_hibernate -lightdm_greeter_get_can_restart -lightdm_greeter_restart -lightdm_greeter_get_can_shutdown -lightdm_greeter_shutdown <SUBSECTION Standard> LIGHTDM_GREETER LIGHTDM_IS_GREETER diff --git a/doc/tmpl/greeter.sgml b/doc/tmpl/greeter.sgml index fc6c4803..c3e2761e 100644 --- a/doc/tmpl/greeter.sgml +++ b/doc/tmpl/greeter.sgml @@ -1,8 +1,8 @@ <!-- ##### SECTION Title ##### --> -LightDMGreeter +Greeter Interface <!-- ##### SECTION Short_Description ##### --> -Manages connection to LightDM server and provides greeter functionality +Make a connection to the LightDM daemon and authenticate users <!-- ##### SECTION Long_Description ##### --> <para> @@ -31,7 +31,7 @@ int main () static void connected_cb (LightDMGreeter *greeter) { // Start authentication - lightdm_greeter_login_with_user_prompt (greeter); + lightdm_greeter_authenticate (greeter, NULL); } static void show_prompt_cb (LightDMGreeter *greeter, const char *text, LightDMPromptType type) @@ -177,69 +177,6 @@ static void quit_cb (LightDMGreeter *greeter) @Returns: -<!-- ##### FUNCTION lightdm_greeter_get_hostname ##### --> -<para> - -</para> - -@greeter: -@Returns: - - -<!-- ##### FUNCTION lightdm_greeter_get_default_language ##### --> -<para> - -</para> - -@greeter: -@Returns: - - -<!-- ##### FUNCTION lightdm_greeter_get_languages ##### --> -<para> - -</para> - -@greeter: -@Returns: - - -<!-- ##### FUNCTION lightdm_greeter_get_layouts ##### --> -<para> - -</para> - -@greeter: -@Returns: - - -<!-- ##### FUNCTION lightdm_greeter_get_layout ##### --> -<para> - -</para> - -@greeter: -@Returns: - - -<!-- ##### FUNCTION lightdm_greeter_set_layout ##### --> -<para> - -</para> - -@greeter: -@layout: - - -<!-- ##### FUNCTION lightdm_greeter_get_sessions ##### --> -<para> - -</para> - -@greeter: -@Returns: - - <!-- ##### FUNCTION lightdm_greeter_get_default_session_hint ##### --> <para> @@ -322,7 +259,7 @@ static void quit_cb (LightDMGreeter *greeter) @Returns: -<!-- ##### FUNCTION lightdm_greeter_cancel_timed_login ##### --> +<!-- ##### FUNCTION lightdm_greeter_cancel_autologin ##### --> <para> </para> @@ -330,7 +267,7 @@ static void quit_cb (LightDMGreeter *greeter) @greeter: -<!-- ##### FUNCTION lightdm_greeter_login ##### --> +<!-- ##### FUNCTION lightdm_greeter_authenticate ##### --> <para> </para> @@ -339,15 +276,7 @@ static void quit_cb (LightDMGreeter *greeter) @username: -<!-- ##### FUNCTION lightdm_greeter_login_with_user_prompt ##### --> -<para> - -</para> - -@greeter: - - -<!-- ##### FUNCTION lightdm_greeter_login_as_guest ##### --> +<!-- ##### FUNCTION lightdm_greeter_authenticate_as_guest ##### --> <para> </para> @@ -416,71 +345,3 @@ static void quit_cb (LightDMGreeter *greeter) @greeter: -<!-- ##### FUNCTION lightdm_greeter_get_can_suspend ##### --> -<para> - -</para> - -@greeter: -@Returns: - - -<!-- ##### FUNCTION lightdm_greeter_suspend ##### --> -<para> - -</para> - -@greeter: - - -<!-- ##### FUNCTION lightdm_greeter_get_can_hibernate ##### --> -<para> - -</para> - -@greeter: -@Returns: - - -<!-- ##### FUNCTION lightdm_greeter_hibernate ##### --> -<para> - -</para> - -@greeter: - - -<!-- ##### FUNCTION lightdm_greeter_get_can_restart ##### --> -<para> - -</para> - -@greeter: -@Returns: - - -<!-- ##### FUNCTION lightdm_greeter_restart ##### --> -<para> - -</para> - -@greeter: - - -<!-- ##### FUNCTION lightdm_greeter_get_can_shutdown ##### --> -<para> - -</para> - -@greeter: -@Returns: - - -<!-- ##### FUNCTION lightdm_greeter_shutdown ##### --> -<para> - -</para> - -@greeter: - - diff --git a/doc/tmpl/language.sgml b/doc/tmpl/language.sgml index c78ffc5d..e8f7269b 100644 --- a/doc/tmpl/language.sgml +++ b/doc/tmpl/language.sgml @@ -1,8 +1,8 @@ <!-- ##### SECTION Title ##### --> -LightDMLanguage +Languages <!-- ##### SECTION Short_Description ##### --> -Information about an available language +Get information on available languges <!-- ##### SECTION Long_Description ##### --> <para> @@ -20,6 +20,24 @@ Information about an available language <!-- ##### SECTION Image ##### --> +<!-- ##### FUNCTION lightdm_get_languages ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION lightdm_get_language ##### --> +<para> + +</para> + +@void: +@Returns: + + <!-- ##### FUNCTION lightdm_language_get_code ##### --> <para> diff --git a/doc/tmpl/layout.sgml b/doc/tmpl/layout.sgml index 5dc905c6..91db412b 100644 --- a/doc/tmpl/layout.sgml +++ b/doc/tmpl/layout.sgml @@ -1,8 +1,8 @@ <!-- ##### SECTION Title ##### --> -LightDMLayout +Keyboard Layouts <!-- ##### SECTION Short_Description ##### --> -Information about an available keyboard layout +Control the keyboard layout <!-- ##### SECTION Long_Description ##### --> <para> @@ -20,6 +20,32 @@ Information about an available keyboard layout <!-- ##### SECTION Image ##### --> +<!-- ##### FUNCTION lightdm_get_layouts ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION lightdm_get_layout ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION lightdm_set_layout ##### --> +<para> + +</para> + +@layout: + + <!-- ##### FUNCTION lightdm_layout_get_name ##### --> <para> diff --git a/doc/tmpl/power.sgml b/doc/tmpl/power.sgml new file mode 100644 index 00000000..2d1f5ff5 --- /dev/null +++ b/doc/tmpl/power.sgml @@ -0,0 +1,90 @@ +<!-- ##### SECTION Title ##### --> +Power Management + +<!-- ##### SECTION Short_Description ##### --> +Shutdown, restart, sleep the system + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION lightdm_get_can_suspend ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION lightdm_suspend ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION lightdm_get_can_hibernate ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION lightdm_hibernate ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION lightdm_get_can_restart ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION lightdm_restart ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION lightdm_get_can_shutdown ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION lightdm_shutdown ##### --> +<para> + +</para> + +@void: + + diff --git a/doc/tmpl/session.sgml b/doc/tmpl/session.sgml index 7fe247c7..96f850ba 100644 --- a/doc/tmpl/session.sgml +++ b/doc/tmpl/session.sgml @@ -1,8 +1,8 @@ <!-- ##### SECTION Title ##### --> -LightDMSession +User Sessions <!-- ##### SECTION Short_Description ##### --> -Information about an available session +Choose the session to use <!-- ##### SECTION Long_Description ##### --> <para> @@ -20,6 +20,15 @@ Object containing information about a session type. #LightDMSession objects are <!-- ##### SECTION Image ##### --> +<!-- ##### FUNCTION lightdm_get_sessions ##### --> +<para> + +</para> + +@void: +@Returns: + + <!-- ##### FUNCTION lightdm_session_get_key ##### --> <para> diff --git a/doc/tmpl/system.sgml b/doc/tmpl/system.sgml new file mode 100644 index 00000000..c8cdb54c --- /dev/null +++ b/doc/tmpl/system.sgml @@ -0,0 +1,31 @@ +<!-- ##### SECTION Title ##### --> +System Information + +<!-- ##### SECTION Short_Description ##### --> +Get system infomation + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION lightdm_get_hostname ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/doc/tmpl/user.sgml b/doc/tmpl/user.sgml index c5aa4750..515d2ba2 100644 --- a/doc/tmpl/user.sgml +++ b/doc/tmpl/user.sgml @@ -1,8 +1,8 @@ <!-- ##### SECTION Title ##### --> -LightDMUser +User Accounts <!-- ##### SECTION Short_Description ##### --> -Information about a user account +Get information on user accounts on this system <!-- ##### SECTION Long_Description ##### --> <para> @@ -44,7 +44,7 @@ A user has the following properties: @user: -<!-- ##### FUNCTION lightdm_user_get_name ##### --> +<!-- ##### FUNCTION lightdm_user_get_display_name ##### --> <para> </para> @@ -53,7 +53,7 @@ A user has the following properties: @Returns: -<!-- ##### FUNCTION lightdm_user_get_real_name ##### --> +<!-- ##### FUNCTION lightdm_user_get_home_directory ##### --> <para> </para> @@ -62,7 +62,7 @@ A user has the following properties: @Returns: -<!-- ##### FUNCTION lightdm_user_get_display_name ##### --> +<!-- ##### FUNCTION lightdm_user_get_image ##### --> <para> </para> @@ -71,7 +71,7 @@ A user has the following properties: @Returns: -<!-- ##### FUNCTION lightdm_user_get_home_directory ##### --> +<!-- ##### FUNCTION lightdm_user_get_language ##### --> <para> </para> @@ -80,7 +80,7 @@ A user has the following properties: @Returns: -<!-- ##### FUNCTION lightdm_user_get_image ##### --> +<!-- ##### FUNCTION lightdm_user_get_layout ##### --> <para> </para> @@ -89,7 +89,7 @@ A user has the following properties: @Returns: -<!-- ##### FUNCTION lightdm_user_get_language ##### --> +<!-- ##### FUNCTION lightdm_user_get_logged_in ##### --> <para> </para> @@ -98,7 +98,16 @@ A user has the following properties: @Returns: -<!-- ##### FUNCTION lightdm_user_get_layout ##### --> +<!-- ##### FUNCTION lightdm_user_get_name ##### --> +<para> + +</para> + +@user: +@Returns: + + +<!-- ##### FUNCTION lightdm_user_get_real_name ##### --> <para> </para> @@ -116,12 +125,67 @@ A user has the following properties: @Returns: -<!-- ##### FUNCTION lightdm_user_get_logged_in ##### --> +<!-- ##### USER_FUNCTION user_added ##### --> +<para> + +</para> + +@user_list: +@user: + + +<!-- ##### USER_FUNCTION user_changed ##### --> <para> </para> +@user_list: @user: + + +<!-- ##### USER_FUNCTION user_removed ##### --> +<para> + +</para> + +@user_list: +@user: + + +<!-- ##### FUNCTION lightdm_user_list_get_instance ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION lightdm_user_list_get_length ##### --> +<para> + +</para> + +@user_list: +@Returns: + + +<!-- ##### FUNCTION lightdm_user_list_get_user_by_name ##### --> +<para> + +</para> + +@user_list: +@username: +@Returns: + + +<!-- ##### FUNCTION lightdm_user_list_get_users ##### --> +<para> + +</para> + +@user_list: @Returns: |