← Back to branch summary

~ubuntu-branches/debian/sid/thunar/sid

« 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): Lionel Le Folgoc
  • Date: 2010-05-23 14:12:33 UTC
  • mfrom: (1.1.24 upstream)
  • Revision ID: james.westby@ubuntu.com-20100523141233-ntplken25atdr214
Tags: 1.0.2-1
* New upstream release.
* debian/patches/04_fix-umask-handling.patch: dropped, included upstream.
* debian/control: build-dep on libstartup-notification0-dev (>= 0.4) as
  startup notification support is enabled in debian/rules.

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