← Back to branch summary

~ubuntu-branches/ubuntu/raring/lightdm/raring-updates

« back to all changes in this revision

Viewing changes to doc/tmpl/user.sgml

  • Committer: Package Import Robot
  • Author(s): Robert Ancell
  • Date: 2011-09-28 16:00:20 UTC
  • mto: (45.1.1 oneiric-proposed)
  • mto: This revision was merged to the branch mainline in revision 36.
  • Revision ID: package-import@ubuntu.com-20110928160020-5begtcf2pe4s0mzv
Tags: upstream-1.0.0
Import upstream version 1.0.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/tmpl/user.sgml
 
1
<!-- ##### SECTION Title ##### -->
 
2
User Accounts
 
3
 
 
4
<!-- ##### SECTION Short_Description ##### -->
 
5
Get information on user accounts on this system
 
6
 
 
7
<!-- ##### SECTION Long_Description ##### -->
 
8
<para>
 
9
Object containing information about a user present on this system. #LightDMUser objects are not created by the user, but provided by the #LightDMGreeter 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
<!-- ##### USER_FUNCTION changed ##### -->
 
40
<para>
 
41
 
 
42
</para>
 
43
 
 
44
@user: 
 
45
 
 
46
 
 
47
<!-- ##### FUNCTION lightdm_user_get_display_name ##### -->
 
48
<para>
 
49
 
 
50
</para>
 
51
 
 
52
@user: 
 
53
@Returns: 
 
54
 
 
55
 
 
56
<!-- ##### FUNCTION lightdm_user_get_home_directory ##### -->
 
57
<para>
 
58
 
 
59
</para>
 
60
 
 
61
@user: 
 
62
@Returns: 
 
63
 
 
64
 
 
65
<!-- ##### FUNCTION lightdm_user_get_image ##### -->
 
66
<para>
 
67
 
 
68
</para>
 
69
 
 
70
@user: 
 
71
@Returns: 
 
72
 
 
73
 
 
74
<!-- ##### FUNCTION lightdm_user_get_language ##### -->
 
75
<para>
 
76
 
 
77
</para>
 
78
 
 
79
@user: 
 
80
@Returns: 
 
81
 
 
82
 
 
83
<!-- ##### FUNCTION lightdm_user_get_layout ##### -->
 
84
<para>
 
85
 
 
86
</para>
 
87
 
 
88
@user: 
 
89
@Returns: 
 
90
 
 
91
 
 
92
<!-- ##### FUNCTION lightdm_user_get_logged_in ##### -->
 
93
<para>
 
94
 
 
95
</para>
 
96
 
 
97
@user: 
 
98
@Returns: 
 
99
 
 
100
 
 
101
<!-- ##### FUNCTION lightdm_user_get_name ##### -->
 
102
<para>
 
103
 
 
104
</para>
 
105
 
 
106
@user: 
 
107
@Returns: 
 
108
 
 
109
 
 
110
<!-- ##### FUNCTION lightdm_user_get_real_name ##### -->
 
111
<para>
 
112
 
 
113
</para>
 
114
 
 
115
@user: 
 
116
@Returns: 
 
117
 
 
118
 
 
119
<!-- ##### FUNCTION lightdm_user_get_session ##### -->
 
120
<para>
 
121
 
 
122
</para>
 
123
 
 
124
@user: 
 
125
@Returns: 
 
126
 
 
127
 
 
128
<!-- ##### USER_FUNCTION user_added ##### -->
 
129
<para>
 
130
 
 
131
</para>
 
132
 
 
133
@user_list: 
 
134
@user: 
 
135
 
 
136
 
 
137
<!-- ##### USER_FUNCTION user_changed ##### -->
 
138
<para>
 
139
 
 
140
</para>
 
141
 
 
142
@user_list: 
 
143
@user: 
 
144
 
 
145
 
 
146
<!-- ##### USER_FUNCTION user_removed ##### -->
 
147
<para>
 
148
 
 
149
</para>
 
150
 
 
151
@user_list: 
 
152
@user: 
 
153
 
 
154
 
 
155
<!-- ##### FUNCTION lightdm_user_list_get_instance ##### -->
 
156
<para>
 
157
 
 
158
</para>
 
159
 
 
160
@void: 
 
161
@Returns: 
 
162
 
 
163
 
 
164
<!-- ##### FUNCTION lightdm_user_list_get_length ##### -->
 
165
<para>
 
166
 
 
167
</para>
 
168
 
 
169
@user_list: 
 
170
@Returns: 
 
171
 
 
172
 
 
173
<!-- ##### FUNCTION lightdm_user_list_get_user_by_name ##### -->
 
174
<para>
 
175
 
 
176
</para>
 
177
 
 
178
@user_list: 
 
179
@username: 
 
180
@Returns: 
 
181
 
 
182
 
 
183
<!-- ##### FUNCTION lightdm_user_list_get_users ##### -->
 
184
<para>
 
185
 
 
186
</para>
 
187
 
 
188
@user_list: 
 
189
@Returns: 
 
190
 
 
191