doc/tmpl/user.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 LdmUser
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Information about a user
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 Object containing information about a user present on this system. #LdmUser objects are not created by the user, but provided by the #LdmGreeter object.
  10 </para>
  11 <para>
  12 A user has the following properties:
  13 <itemizedlist>
  14 <listitem>
  15     <para>The user name is used to refer to this user.</para>
  16 </listitem>
  17 <listitem>
  18     <para>The real name is the name of the person that owns this user account.</para>
  19 </listitem>
  20 <listitem>
  21     <para>The display name provides text to use for the user label.</para>
  22 </listitem>
  23 <listitem>
  24     <para>The image URI provides an image to use for the user.</para>
  25 </listitem>
  26 </itemizedlist>
  27 </para>
  28
  29 <!-- ##### SECTION See_Also ##### -->
  30 <para>
  31 </para>
  32
  33 <!-- ##### SECTION Stability_Level ##### -->
  34
  35
  36 <!-- ##### SECTION Image ##### -->
  37
  38
  39 <!-- ##### STRUCT LdmUser ##### -->
  40 <para>
  41
  42 </para>
  43
  44
  45 <!-- ##### ARG LdmUser:display-name ##### -->
  46 <para>
  47
  48 </para>
  49
  50 <!-- ##### ARG LdmUser:greeter ##### -->
  51 <para>
  52
  53 </para>
  54
  55 <!-- ##### ARG LdmUser:image ##### -->
  56 <para>
  57
  58 </para>
  59
  60 <!-- ##### ARG LdmUser:language ##### -->
  61 <para>
  62
  63 </para>
  64
  65 <!-- ##### ARG LdmUser:layout ##### -->
  66 <para>
  67
  68 </para>
  69
  70 <!-- ##### ARG LdmUser:logged-in ##### -->
  71 <para>
  72
  73 </para>
  74
  75 <!-- ##### ARG LdmUser:name ##### -->
  76 <para>
  77
  78 </para>
  79
  80 <!-- ##### ARG LdmUser:real-name ##### -->
  81 <para>
  82
  83 </para>
  84
  85 <!-- ##### ARG LdmUser:session ##### -->
  86 <para>
  87
  88 </para>
  89
  90 <!-- ##### FUNCTION ldm_user_get_name ##### -->
  91 <para>
  92
  93 </para>
  94
  95 @user:
  96 @Returns:
  97
  98
  99 <!-- ##### FUNCTION ldm_user_get_real_name ##### -->
 100 <para>
 101
 102 </para>
 103
 104 @user:
 105 @Returns:
 106
 107
 108 <!-- ##### FUNCTION ldm_user_get_display_name ##### -->
 109 <para>
 110
 111 </para>
 112
 113 @user:
 114 @Returns:
 115
 116
 117 <!-- ##### FUNCTION ldm_user_get_image ##### -->
 118 <para>
 119
 120 </para>
 121
 122 @user:
 123 @Returns:
 124
 125
 126 <!-- ##### FUNCTION ldm_user_get_language ##### -->
 127 <para>
 128
 129 </para>
 130
 131 @user:
 132 @Returns:
 133
 134
 135 <!-- ##### FUNCTION ldm_user_get_layout ##### -->
 136 <para>
 137
 138 </para>
 139
 140 @user:
 141 @Returns:
 142
 143
 144 <!-- ##### FUNCTION ldm_user_get_session ##### -->
 145 <para>
 146
 147 </para>
 148
 149 @user:
 150 @Returns:
 151
 152
 153 <!-- ##### FUNCTION ldm_user_get_logged_in ##### -->
 154 <para>
 155
 156 </para>
 157
 158 @user:
 159 @Returns:
 160
 161