← Back to branch summary

~ubuntu-branches/debian/experimental/thunar/experimental

« back to all changes in this revision

Viewing changes to docs/reference/thunar-vfs/xml/thunar-vfs-user.xml

  • Committer: Bazaar Package Importer
  • Author(s): Yves-Alexis Perez
  • Date: 2006-01-02 23:42:32 UTC
  • Revision ID: james.westby@ubuntu.com-20060102234232-8xeq0lqhyn70syr0
Tags: upstream-0.1.4svn+r18850
Import upstream version 0.1.4svn+r18850

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/thunar-vfs/xml/thunar-vfs-user.xml
 
1
<refentry id="ThunarVfsUser">
 
2
<refmeta>
 
3
<refentrytitle>ThunarVfsUser</refentrytitle>
 
4
<manvolnum>3</manvolnum>
 
5
<refmiscinfo>THUNAR-VFS Library</refmiscinfo>
 
6
</refmeta>
 
7
 
 
8
<refnamediv>
 
9
<refname>ThunarVfsUser</refname><refpurpose></refpurpose>
 
10
</refnamediv>
 
11
 
 
12
<refsynopsisdiv><title>Synopsis</title>
 
13
 
 
14
<synopsis>
 
15
 
 
16
#include &lt;thunar-vfs/thunar-vfs.h&gt;
 
17
 
 
18
 
 
19
            <link linkend="ThunarVfsUser-struct">ThunarVfsUser</link>;
 
20
<link linkend="GList">GList</link>*      <link linkend="thunar-vfs-user-get-groups">thunar_vfs_user_get_groups</link>      (<link linkend="ThunarVfsUser">ThunarVfsUser</link> *user);
 
21
<link linkend="ThunarVfsGroup">ThunarVfsGroup</link>* <link linkend="thunar-vfs-user-get-primary-group">thunar_vfs_user_get_primary_group</link>
 
22
                                            (<link linkend="ThunarVfsUser">ThunarVfsUser</link> *user);
 
23
<link linkend="ThunarVfsUserId">ThunarVfsUserId</link> <link linkend="thunar-vfs-user-get-id">thunar_vfs_user_get_id</link>      (<link linkend="ThunarVfsUser">ThunarVfsUser</link> *user);
 
24
const <link linkend="gchar">gchar</link>* <link linkend="thunar-vfs-user-get-name">thunar_vfs_user_get_name</link>       (<link linkend="ThunarVfsUser">ThunarVfsUser</link> *user);
 
25
const <link linkend="gchar">gchar</link>* <link linkend="thunar-vfs-user-get-real-name">thunar_vfs_user_get_real_name</link>  (<link linkend="ThunarVfsUser">ThunarVfsUser</link> *user);
 
26
<link linkend="gboolean">gboolean</link>    <link linkend="thunar-vfs-user-is-me">thunar_vfs_user_is_me</link>           (<link linkend="ThunarVfsUser">ThunarVfsUser</link> *user);
 
27
 
 
28
 
 
29
</synopsis>
 
30
</refsynopsisdiv>
 
31
 
 
32
<refsect1>
 
33
<title>Object Hierarchy</title>
 
34
<synopsis>
 
35
 
 
36
  <link linkend="GObject">GObject</link>
 
37
   +----ThunarVfsUser
 
38
</synopsis>
 
39
 
 
40
</refsect1>
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
 
 
47
 
 
48
 
 
49
<refsect1>
 
50
<title>Description</title>
 
51
<para>
 
52
 
 
53
</para>
 
54
</refsect1>
 
55
 
 
56
<refsect1>
 
57
<title>Details</title>
 
58
<refsect2>
 
59
<title><anchor id="ThunarVfsUser-struct"/>ThunarVfsUser</title>
 
60
<indexterm><primary>ThunarVfsUser</primary></indexterm><programlisting>typedef struct _ThunarVfsUser ThunarVfsUser;</programlisting>
 
61
<para>
 
62
 
 
63
</para></refsect2>
 
64
<refsect2>
 
65
<title><anchor id="thunar-vfs-user-get-groups"/>thunar_vfs_user_get_groups ()</title>
 
66
<indexterm><primary>thunar_vfs_user_get_groups</primary></indexterm><programlisting><link linkend="GList">GList</link>*      thunar_vfs_user_get_groups      (<link linkend="ThunarVfsUser">ThunarVfsUser</link> *user);</programlisting>
 
67
<para>
 
68
Returns all <link linkend="ThunarVfsGroup"><type>ThunarVfsGroup</type></link><!---->s that <parameter>user</parameter>
 
69
belongs to. The returned list and the <link linkend="ThunarVfsGroup"><type>ThunarVfsGroup</type></link><!---->s
 
70
contained within the list are owned by <parameter>user</parameter> and must not be
 
71
freed or altered by the caller.
 
72
</para>
 
73
<para>
 
74
Note that if <parameter>user</parameter> has a primary group, this group will
 
75
also be contained in the returned list.</para>
 
76
<para>
 
77
 
 
78
</para><variablelist role="params">
 
79
<varlistentry><term><parameter>user</parameter>&nbsp;:</term>
 
80
<listitem><simpara> a <link linkend="ThunarVfsUser"><type>ThunarVfsUser</type></link>.
 
81
</simpara></listitem></varlistentry>
 
82
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the groups that <parameter>user</parameter> belongs to.
 
83
</simpara></listitem></varlistentry>
 
84
</variablelist></refsect2>
 
85
<refsect2>
 
86
<title><anchor id="thunar-vfs-user-get-primary-group"/>thunar_vfs_user_get_primary_group ()</title>
 
87
<indexterm><primary>thunar_vfs_user_get_primary_group</primary></indexterm><programlisting><link linkend="ThunarVfsGroup">ThunarVfsGroup</link>* thunar_vfs_user_get_primary_group
 
88
                                            (<link linkend="ThunarVfsUser">ThunarVfsUser</link> *user);</programlisting>
 
89
<para>
 
90
Returns the primary group of <parameter>user</parameter> or <literal>NULL</literal> if <parameter>user</parameter>
 
91
has no primary group.
 
92
</para>
 
93
<para>
 
94
No reference is taken for the caller, so you must
 
95
not call <link linkend="g-object-unref"><function>g_object_unref()</function></link> on the returned object.</para>
 
96
<para>
 
97
 
 
98
</para><variablelist role="params">
 
99
<varlistentry><term><parameter>user</parameter>&nbsp;:</term>
 
100
<listitem><simpara> a <link linkend="ThunarVfsUser"><type>ThunarVfsUser</type></link>.
 
101
</simpara></listitem></varlistentry>
 
102
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the primary group of <parameter>user</parameter> or <literal>NULL</literal>.
 
103
</simpara></listitem></varlistentry>
 
104
</variablelist></refsect2>
 
105
<refsect2>
 
106
<title><anchor id="thunar-vfs-user-get-id"/>thunar_vfs_user_get_id ()</title>
 
107
<indexterm><primary>thunar_vfs_user_get_id</primary></indexterm><programlisting><link linkend="ThunarVfsUserId">ThunarVfsUserId</link> thunar_vfs_user_get_id      (<link linkend="ThunarVfsUser">ThunarVfsUser</link> *user);</programlisting>
 
108
<para>
 
109
Returns the unique id of <parameter>user</parameter>.</para>
 
110
<para>
 
111
 
 
112
</para><variablelist role="params">
 
113
<varlistentry><term><parameter>user</parameter>&nbsp;:</term>
 
114
<listitem><simpara> a <link linkend="ThunarVfsUser"><type>ThunarVfsUser</type></link>.
 
115
</simpara></listitem></varlistentry>
 
116
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the unique id of <parameter>user</parameter>.
 
117
</simpara></listitem></varlistentry>
 
118
</variablelist></refsect2>
 
119
<refsect2>
 
120
<title><anchor id="thunar-vfs-user-get-name"/>thunar_vfs_user_get_name ()</title>
 
121
<indexterm><primary>thunar_vfs_user_get_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* thunar_vfs_user_get_name       (<link linkend="ThunarVfsUser">ThunarVfsUser</link> *user);</programlisting>
 
122
<para>
 
123
Returns the name of <parameter>user</parameter>. If the system is
 
124
unable to determine the account name of <parameter>user</parameter>,
 
125
it'll return the user id as string.</para>
 
126
<para>
 
127
 
 
128
</para><variablelist role="params">
 
129
<varlistentry><term><parameter>user</parameter>&nbsp;:</term>
 
130
<listitem><simpara> a <link linkend="ThunarVfsUser"><type>ThunarVfsUser</type></link>.
 
131
</simpara></listitem></varlistentry>
 
132
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the name of <parameter>user</parameter>.
 
133
</simpara></listitem></varlistentry>
 
134
</variablelist></refsect2>
 
135
<refsect2>
 
136
<title><anchor id="thunar-vfs-user-get-real-name"/>thunar_vfs_user_get_real_name ()</title>
 
137
<indexterm><primary>thunar_vfs_user_get_real_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* thunar_vfs_user_get_real_name  (<link linkend="ThunarVfsUser">ThunarVfsUser</link> *user);</programlisting>
 
138
<para>
 
139
Returns the real name of <parameter>user</parameter> or <literal>NULL</literal> if the
 
140
real name for <parameter>user</parameter> is not known to the underlying
 
141
system.</para>
 
142
<para>
 
143
 
 
144
</para><variablelist role="params">
 
145
<varlistentry><term><parameter>user</parameter>&nbsp;:</term>
 
146
<listitem><simpara> a <link linkend="ThunarVfsUser"><type>ThunarVfsUser</type></link>.
 
147
</simpara></listitem></varlistentry>
 
148
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the real name for <parameter>user</parameter> or <literal>NULL</literal>.
 
149
</simpara></listitem></varlistentry>
 
150
</variablelist></refsect2>
 
151
<refsect2>
 
152
<title><anchor id="thunar-vfs-user-is-me"/>thunar_vfs_user_is_me ()</title>
 
153
<indexterm><primary>thunar_vfs_user_is_me</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    thunar_vfs_user_is_me           (<link linkend="ThunarVfsUser">ThunarVfsUser</link> *user);</programlisting>
 
154
<para>
 
155
Checks whether the owner of the current process is
 
156
described by <parameter>user</parameter>.</para>
 
157
<para>
 
158
 
 
159
</para><variablelist role="params">
 
160
<varlistentry><term><parameter>user</parameter>&nbsp;:</term>
 
161
<listitem><simpara> a <link linkend="ThunarVfsUser"><type>ThunarVfsUser</type></link>.
 
162
</simpara></listitem></varlistentry>
 
163
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <literal>TRUE</literal> if <parameter>user</parameter> is the owner of the current
 
164
              process, else <literal>FALSE</literal>.
 
165
</simpara></listitem></varlistentry>
 
166
</variablelist></refsect2>
 
167
 
 
168
</refsect1>
 
169
 
 
170
 
 
171
 
 
172
 
 
173
</refentry>