← 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-volume-manager.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-volume-manager.xml
 
1
<refentry id="ThunarVfsVolumeManager">
 
2
<refmeta>
 
3
<refentrytitle>ThunarVfsVolumeManager</refentrytitle>
 
4
<manvolnum>3</manvolnum>
 
5
<refmiscinfo>THUNAR-VFS Library</refmiscinfo>
 
6
</refmeta>
 
7
 
 
8
<refnamediv>
 
9
<refname>ThunarVfsVolumeManager</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="ThunarVfsVolumeManagerIface">ThunarVfsVolumeManagerIface</link>;
 
20
            <link linkend="ThunarVfsVolumeManager-struct">ThunarVfsVolumeManager</link>;
 
21
<link linkend="ThunarVfsVolumeManager">ThunarVfsVolumeManager</link>* <link linkend="thunar-vfs-volume-manager-get-default">thunar_vfs_volume_manager_get_default</link>
 
22
                                            (void);
 
23
<link linkend="ThunarVfsVolume">ThunarVfsVolume</link>* <link linkend="thunar-vfs-volume-manager-get-volume-by-info">thunar_vfs_volume_manager_get_volume_by_info</link>
 
24
                                            (<link linkend="ThunarVfsVolumeManager">ThunarVfsVolumeManager</link> *manager,
 
25
                                             const <link linkend="ThunarVfsInfo">ThunarVfsInfo</link> *info);
 
26
<link linkend="GList">GList</link>*      <link linkend="thunar-vfs-volume-manager-get-volumes">thunar_vfs_volume_manager_get_volumes</link>
 
27
                                            (<link linkend="ThunarVfsVolumeManager">ThunarVfsVolumeManager</link> *manager);
 
28
<link linkend="void">void</link>        <link linkend="thunar-vfs-volume-manager-volumes-added">thunar_vfs_volume_manager_volumes_added</link>
 
29
                                            (<link linkend="ThunarVfsVolumeManager">ThunarVfsVolumeManager</link> *manager,
 
30
                                             <link linkend="GList">GList</link> *volumes);
 
31
<link linkend="void">void</link>        <link linkend="thunar-vfs-volume-manager-volumes-removed">thunar_vfs_volume_manager_volumes_removed</link>
 
32
                                            (<link linkend="ThunarVfsVolumeManager">ThunarVfsVolumeManager</link> *manager,
 
33
                                             <link linkend="GList">GList</link> *volumes);
 
34
 
 
35
 
 
36
</synopsis>
 
37
</refsynopsisdiv>
 
38
 
 
39
<refsect1>
 
40
<title>Object Hierarchy</title>
 
41
<synopsis>
 
42
 
 
43
  <link linkend="GInterface">GInterface</link>
 
44
   +----ThunarVfsVolumeManager
 
45
</synopsis>
 
46
 
 
47
</refsect1>
 
48
 
 
49
<refsect1>
 
50
<title>Prerequisites</title>
 
51
<para>
 
52
ThunarVfsVolumeManager requires
 
53
 <link linkend="GObject">GObject</link>.</para>
 
54
 
 
55
</refsect1>
 
56
 
 
57
 
 
58
 
 
59
 
 
60
 
 
61
 
 
62
 
 
63
<refsect1>
 
64
<title>Description</title>
 
65
<para>
 
66
 
 
67
</para>
 
68
</refsect1>
 
69
 
 
70
<refsect1>
 
71
<title>Details</title>
 
72
<refsect2>
 
73
<title><anchor id="ThunarVfsVolumeManagerIface"/>ThunarVfsVolumeManagerIface</title>
 
74
<indexterm><primary>ThunarVfsVolumeManagerIface</primary></indexterm><programlisting>typedef struct {
 
75
  GTypeInterface __parent__;
 
76
 
 
77
  /* methods */
 
78
  ThunarVfsVolume *(*get_volume_by_info) (ThunarVfsVolumeManager *manager,
 
79
                                          const ThunarVfsInfo    *info);
 
80
  GList           *(*get_volumes)        (ThunarVfsVolumeManager *manager);
 
81
 
 
82
  /* signals */
 
83
  void (*volumes_added)   (ThunarVfsVolumeManager *manager,
 
84
                           GList                  *volumes);
 
85
  void (*volumes_removed) (ThunarVfsVolumeManager *manager,
 
86
                           GList                  *volumes);
 
87
} ThunarVfsVolumeManagerIface;
 
88
</programlisting>
 
89
<para>
 
90
 
 
91
</para></refsect2>
 
92
<refsect2>
 
93
<title><anchor id="ThunarVfsVolumeManager-struct"/>ThunarVfsVolumeManager</title>
 
94
<indexterm><primary>ThunarVfsVolumeManager</primary></indexterm><programlisting>typedef struct _ThunarVfsVolumeManager ThunarVfsVolumeManager;</programlisting>
 
95
<para>
 
96
 
 
97
</para></refsect2>
 
98
<refsect2>
 
99
<title><anchor id="thunar-vfs-volume-manager-get-default"/>thunar_vfs_volume_manager_get_default ()</title>
 
100
<indexterm><primary>thunar_vfs_volume_manager_get_default</primary></indexterm><programlisting><link linkend="ThunarVfsVolumeManager">ThunarVfsVolumeManager</link>* thunar_vfs_volume_manager_get_default
 
101
                                            (void);</programlisting>
 
102
<para>
 
103
Returns the default, shared <link linkend="ThunarVfsVolumeManager"><type>ThunarVfsVolumeManager</type></link> instance
 
104
for this system. This function automatically determines, which
 
105
implementation of <link linkend="ThunarVfsVolumeManager"><type>ThunarVfsVolumeManager</type></link> should be used for
 
106
the target system and returns an instance of that class, which
 
107
is shared among all modules using the volume manager facility.
 
108
</para>
 
109
<para>
 
110
Call <link linkend="g-object-unref"><function>g_object_unref()</function></link> on the returned object when you are
 
111
done with it.</para>
 
112
<para>
 
113
 
 
114
</para><variablelist role="params">
 
115
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the shared <link linkend="ThunarVfsVolumeManager"><type>ThunarVfsVolumeManager</type></link> instance.
 
116
</simpara></listitem></varlistentry>
 
117
</variablelist></refsect2>
 
118
<refsect2>
 
119
<title><anchor id="thunar-vfs-volume-manager-get-volume-by-info"/>thunar_vfs_volume_manager_get_volume_by_info ()</title>
 
120
<indexterm><primary>thunar_vfs_volume_manager_get_volume_by_info</primary></indexterm><programlisting><link linkend="ThunarVfsVolume">ThunarVfsVolume</link>* thunar_vfs_volume_manager_get_volume_by_info
 
121
                                            (<link linkend="ThunarVfsVolumeManager">ThunarVfsVolumeManager</link> *manager,
 
122
                                             const <link linkend="ThunarVfsInfo">ThunarVfsInfo</link> *info);</programlisting>
 
123
<para>
 
124
Tries to lookup the <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link> on which <parameter>info</parameter> is
 
125
located. If <parameter>manager</parameter> doesn't know a <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link>
 
126
for <parameter>info</parameter>, <literal>NULL</literal> will be returned.
 
127
</para>
 
128
<para>
 
129
The returned <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link> (if any) is owned by
 
130
<parameter>manager</parameter> and must not be freed by the caller.</para>
 
131
<para>
 
132
 
 
133
</para><variablelist role="params">
 
134
<varlistentry><term><parameter>manager</parameter>&nbsp;:</term>
 
135
<listitem><simpara> a <link linkend="ThunarVfsVolumeManager"><type>ThunarVfsVolumeManager</type></link> instance.
 
136
</simpara></listitem></varlistentry>
 
137
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
 
138
<listitem><simpara> a <link linkend="ThunarVfsInfo"><type>ThunarVfsInfo</type></link>.
 
139
</simpara></listitem></varlistentry>
 
140
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link>, on which <parameter>info</parameter> is
 
141
              located or <literal>NULL</literal>.
 
142
</simpara></listitem></varlistentry>
 
143
</variablelist></refsect2>
 
144
<refsect2>
 
145
<title><anchor id="thunar-vfs-volume-manager-get-volumes"/>thunar_vfs_volume_manager_get_volumes ()</title>
 
146
<indexterm><primary>thunar_vfs_volume_manager_get_volumes</primary></indexterm><programlisting><link linkend="GList">GList</link>*      thunar_vfs_volume_manager_get_volumes
 
147
                                            (<link linkend="ThunarVfsVolumeManager">ThunarVfsVolumeManager</link> *manager);</programlisting>
 
148
<para>
 
149
Returns all <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link><!---->s currently known for
 
150
<parameter>manager</parameter>. The returned list is owned by <parameter>manager</parameter> and should
 
151
therefore considered constant in the caller.</para>
 
152
<para>
 
153
 
 
154
</para><variablelist role="params">
 
155
<varlistentry><term><parameter>manager</parameter>&nbsp;:</term>
 
156
<listitem><simpara> a <link linkend="ThunarVfsVolumeManager"><type>ThunarVfsVolumeManager</type></link> instance.
 
157
</simpara></listitem></varlistentry>
 
158
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the list of volumes known for <parameter>manager</parameter>.
 
159
</simpara></listitem></varlistentry>
 
160
</variablelist></refsect2>
 
161
<refsect2>
 
162
<title><anchor id="thunar-vfs-volume-manager-volumes-added"/>thunar_vfs_volume_manager_volumes_added ()</title>
 
163
<indexterm><primary>thunar_vfs_volume_manager_volumes_added</primary></indexterm><programlisting><link linkend="void">void</link>        thunar_vfs_volume_manager_volumes_added
 
164
                                            (<link linkend="ThunarVfsVolumeManager">ThunarVfsVolumeManager</link> *manager,
 
165
                                             <link linkend="GList">GList</link> *volumes);</programlisting>
 
166
<para>
 
167
Emits the "volumes-added" signal on <parameter>manager</parameter> using the
 
168
given <parameter>volumes</parameter>.
 
169
</para>
 
170
<para>
 
171
This method should only be used by classes implementing
 
172
the <link linkend="ThunarVfsVolumeManager"><type>ThunarVfsVolumeManager</type></link> interface.</para>
 
173
<para>
 
174
 
 
175
</para><variablelist role="params">
 
176
<varlistentry><term><parameter>manager</parameter>&nbsp;:</term>
 
177
<listitem><simpara> a <link linkend="ThunarVfsVolumeManager"><type>ThunarVfsVolumeManager</type></link> instance.
 
178
</simpara></listitem></varlistentry>
 
179
<varlistentry><term><parameter>volumes</parameter>&nbsp;:</term>
 
180
<listitem><simpara> a list of <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link><!---->s.
 
181
</simpara></listitem></varlistentry>
 
182
</variablelist></refsect2>
 
183
<refsect2>
 
184
<title><anchor id="thunar-vfs-volume-manager-volumes-removed"/>thunar_vfs_volume_manager_volumes_removed ()</title>
 
185
<indexterm><primary>thunar_vfs_volume_manager_volumes_removed</primary></indexterm><programlisting><link linkend="void">void</link>        thunar_vfs_volume_manager_volumes_removed
 
186
                                            (<link linkend="ThunarVfsVolumeManager">ThunarVfsVolumeManager</link> *manager,
 
187
                                             <link linkend="GList">GList</link> *volumes);</programlisting>
 
188
<para>
 
189
Emits the "volumes-removed" signal on <parameter>manager</parameter> using
 
190
the given <parameter>volumes</parameter>.
 
191
</para>
 
192
<para>
 
193
This method should only be used by classes implementing
 
194
the <link linkend="ThunarVfsVolumeManager"><type>ThunarVfsVolumeManager</type></link> interface.</para>
 
195
<para>
 
196
 
 
197
</para><variablelist role="params">
 
198
<varlistentry><term><parameter>manager</parameter>&nbsp;:</term>
 
199
<listitem><simpara> a <link linkend="ThunarVfsVolumeManager"><type>ThunarVfsVolumeManager</type></link> instance.
 
200
</simpara></listitem></varlistentry>
 
201
<varlistentry><term><parameter>volumes</parameter>&nbsp;:</term>
 
202
<listitem><simpara> a list of <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link><!---->s.
 
203
</simpara></listitem></varlistentry>
 
204
</variablelist></refsect2>
 
205
 
 
206
</refsect1>
 
207
 
 
208
 
 
209
 
 
210
 
 
211
</refentry>