← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/thunarx/html/ThunarxRenamer.html

  • 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/thunarx/html/ThunarxRenamer.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>ThunarxRenamer</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
 
<link rel="start" href="index.html" title="Thunar Extensions Reference Manual">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="Thunar Extensions Reference Manual">
8
8
<link rel="up" href="thunarx-abstraction-layer.html" title="Part IV. Abstraction Layer">
9
9
<link rel="prev" href="ThunarxProviderPlugin.html" title="ThunarxProviderPlugin">
10
10
<link rel="next" href="thunarx-providers.html" title="Part V. Providers">
11
 
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="part" href="thunarx-overview.html" title="Part I. Overview">
14
 
<link rel="part" href="thunarx-writing-extensions.html" title="Part II. Writing Extensions">
15
 
<link rel="part" href="thunarx-fundamentals.html" title="Part III. Fundamentals">
16
 
<link rel="part" href="thunarx-abstraction-layer.html" title="Part IV. Abstraction Layer">
17
 
<link rel="part" href="thunarx-providers.html" title="Part V. Providers">
18
 
<link rel="part" href="thunarx-using-extensions.html" title="Part VI. Using Thunar extensions in applications">
19
 
<link rel="index" href="ix01.html" title="Index">
20
13
</head>
21
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
22
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
27
20
<th width="100%" align="center">Thunar Extensions Reference Manual</th>
28
21
<td><a accesskey="n" href="thunarx-providers.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
29
22
</tr>
30
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#ThunarxRenamer.synopsis" class="shortcut">Top</a>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#ThunarxRenamer.synopsis" class="shortcut">Top</a>
31
25
                   | 
32
26
                  <a href="#ThunarxRenamer.description" class="shortcut">Description</a>
33
27
                   | 
37
31
                   | 
38
32
                  <a href="#ThunarxRenamer.properties" class="shortcut">Properties</a>
39
33
                   | 
40
 
                  <a href="#ThunarxRenamer.signals" class="shortcut">Signals</a></nobr></td></tr>
 
34
                  <a href="#ThunarxRenamer.signals" class="shortcut">Signals</a>
 
35
</td></tr>
41
36
</table>
42
 
<div class="refentry" lang="en">
 
37
<div class="refentry" title="ThunarxRenamer">
43
38
<a name="ThunarxRenamer"></a><div class="titlepage"></div>
44
39
<div class="refnamediv"><table width="100%"><tr>
45
40
<td valign="top">
48
43
</td>
49
44
<td valign="top" align="right"></td>
50
45
</tr></table></div>
51
 
<div class="refsynopsisdiv">
 
46
<div class="refsynopsisdiv" title="Synopsis">
52
47
<a name="ThunarxRenamer.synopsis"></a><h2>Synopsis</h2>
53
48
<pre class="synopsis">
54
 
 
55
49
#include &lt;thunarx/thunarx.h&gt;
56
50
 
57
51
                    <a class="link" href="ThunarxRenamer.html#ThunarxRenamer-struct" title="ThunarxRenamer">ThunarxRenamer</a>;
58
52
                    <a class="link" href="ThunarxRenamer.html#ThunarxRenamerClass" title="ThunarxRenamerClass">ThunarxRenamerClass</a>;
59
 
const <a
60
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
61
 
>gchar</a>*        <a class="link" href="ThunarxRenamer.html#thunarx-renamer-get-help-url" title="thunarx_renamer_get_help_url ()">thunarx_renamer_get_help_url</a>        (<a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer);
62
 
void                <a class="link" href="ThunarxRenamer.html#thunarx-renamer-set-help-url" title="thunarx_renamer_set_help_url ()">thunarx_renamer_set_help_url</a>        (<a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer,
63
 
                                                         const <a
64
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
65
 
>gchar</a> *help_url);
66
 
const <a
67
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
68
 
>gchar</a>*        <a class="link" href="ThunarxRenamer.html#thunarx-renamer-get-name" title="thunarx_renamer_get_name ()">thunarx_renamer_get_name</a>            (<a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer);
69
 
void                <a class="link" href="ThunarxRenamer.html#thunarx-renamer-set-name" title="thunarx_renamer_set_name ()">thunarx_renamer_set_name</a>            (<a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer,
70
 
                                                         const <a
71
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
72
 
>gchar</a> *name);
73
 
<a
74
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
75
 
>gchar</a>*              <a class="link" href="ThunarxRenamer.html#thunarx-renamer-process" title="thunarx_renamer_process ()">thunarx_renamer_process</a>             (<a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer,
76
 
                                                         <a class="link" href="ThunarxFileInfo.html" title="ThunarxFileInfo">ThunarxFileInfo</a> *file,
77
 
                                                         const <a
78
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
79
 
>gchar</a> *text,
80
 
                                                         <a
81
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
82
 
>guint</a> index);
83
 
void                <a class="link" href="ThunarxRenamer.html#thunarx-renamer-load" title="thunarx_renamer_load ()">thunarx_renamer_load</a>                (<a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer,
84
 
                                                         <a
85
 
href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"
86
 
>GHashTable</a> *settings);
87
 
void                <a class="link" href="ThunarxRenamer.html#thunarx-renamer-save" title="thunarx_renamer_save ()">thunarx_renamer_save</a>                (<a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer,
88
 
                                                         <a
89
 
href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"
90
 
>GHashTable</a> *settings);
91
 
<a
92
 
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
93
 
>GList</a>*              <a class="link" href="ThunarxRenamer.html#thunarx-renamer-get-actions" title="thunarx_renamer_get_actions ()">thunarx_renamer_get_actions</a>         (<a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer,
94
 
                                                         <a
95
 
href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
96
 
>GtkWindow</a> *window,
97
 
                                                         <a
98
 
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
99
 
>GList</a> *files);
100
 
void                <a class="link" href="ThunarxRenamer.html#thunarx-renamer-changed" title="thunarx_renamer_changed ()">thunarx_renamer_changed</a>             (<a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer);
 
53
const <span class="returnvalue">gchar</span> *       <a class="link" href="ThunarxRenamer.html#thunarx-renamer-get-help-url" title="thunarx_renamer_get_help_url ()">thunarx_renamer_get_help_url</a>        (<em class="parameter"><code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> *renamer</code></em>);
 
54
<span class="returnvalue">void</span>                <a class="link" href="ThunarxRenamer.html#thunarx-renamer-set-help-url" title="thunarx_renamer_set_help_url ()">thunarx_renamer_set_help_url</a>        (<em class="parameter"><code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> *renamer</code></em>,
 
55
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *help_url</code></em>);
 
56
const <span class="returnvalue">gchar</span> *       <a class="link" href="ThunarxRenamer.html#thunarx-renamer-get-name" title="thunarx_renamer_get_name ()">thunarx_renamer_get_name</a>            (<em class="parameter"><code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> *renamer</code></em>);
 
57
<span class="returnvalue">void</span>                <a class="link" href="ThunarxRenamer.html#thunarx-renamer-set-name" title="thunarx_renamer_set_name ()">thunarx_renamer_set_name</a>            (<em class="parameter"><code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> *renamer</code></em>,
 
58
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
 
59
<span class="returnvalue">gchar</span> *             <a class="link" href="ThunarxRenamer.html#thunarx-renamer-process" title="thunarx_renamer_process ()">thunarx_renamer_process</a>             (<em class="parameter"><code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> *renamer</code></em>,
 
60
                                                         <em class="parameter"><code><a class="link" href="ThunarxFileInfo.html" title="ThunarxFileInfo"><span class="type">ThunarxFileInfo</span></a> *file</code></em>,
 
61
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
 
62
                                                         <em class="parameter"><code><span class="type">guint</span> index</code></em>);
 
63
<span class="returnvalue">void</span>                <a class="link" href="ThunarxRenamer.html#thunarx-renamer-load" title="thunarx_renamer_load ()">thunarx_renamer_load</a>                (<em class="parameter"><code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> *renamer</code></em>,
 
64
                                                         <em class="parameter"><code><span class="type">GHashTable</span> *settings</code></em>);
 
65
<span class="returnvalue">void</span>                <a class="link" href="ThunarxRenamer.html#thunarx-renamer-save" title="thunarx_renamer_save ()">thunarx_renamer_save</a>                (<em class="parameter"><code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> *renamer</code></em>,
 
66
                                                         <em class="parameter"><code><span class="type">GHashTable</span> *settings</code></em>);
 
67
<span class="returnvalue">GList</span> *             <a class="link" href="ThunarxRenamer.html#thunarx-renamer-get-actions" title="thunarx_renamer_get_actions ()">thunarx_renamer_get_actions</a>         (<em class="parameter"><code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> *renamer</code></em>,
 
68
                                                         <em class="parameter"><code><span class="type">GtkWindow</span> *window</code></em>,
 
69
                                                         <em class="parameter"><code><span class="type">GList</span> *files</code></em>);
 
70
<span class="returnvalue">void</span>                <a class="link" href="ThunarxRenamer.html#thunarx-renamer-changed" title="thunarx_renamer_changed ()">thunarx_renamer_changed</a>             (<em class="parameter"><code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> *renamer</code></em>);
101
71
</pre>
102
72
</div>
103
 
<div class="refsect1" lang="en">
 
73
<div class="refsect1" title="Object Hierarchy">
104
74
<a name="ThunarxRenamer.object-hierarchy"></a><h2>Object Hierarchy</h2>
105
75
<pre class="synopsis">
106
 
  <a
107
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
108
 
>GObject</a>
109
 
   +----<a
110
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
111
 
>GInitiallyUnowned</a>
112
 
         +----<a
113
 
href="/usr/share/gtk-doc/html/gtk/GtkObject.html"
114
 
>GtkObject</a>
115
 
               +----<a
116
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
117
 
>GtkWidget</a>
118
 
                     +----<a
119
 
href="/usr/share/gtk-doc/html/gtk/GtkContainer.html"
120
 
>GtkContainer</a>
121
 
                           +----<a
122
 
href="/usr/share/gtk-doc/html/gtk/GtkBox.html"
123
 
>GtkBox</a>
124
 
                                 +----<a
125
 
href="/usr/share/gtk-doc/html/gtk/GtkVBox.html"
126
 
>GtkVBox</a>
 
76
  GObject
 
77
   +----GInitiallyUnowned
 
78
         +----GtkObject
 
79
               +----GtkWidget
 
80
                     +----GtkContainer
 
81
                           +----GtkBox
 
82
                                 +----GtkVBox
127
83
                                       +----ThunarxRenamer
128
84
</pre>
129
85
</div>
130
 
<div class="refsect1" lang="en">
 
86
<div class="refsect1" title="Implemented Interfaces">
131
87
<a name="ThunarxRenamer.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
132
88
<p>
133
89
ThunarxRenamer implements
134
 
 AtkImplementorIface and  <a
135
 
href="/usr/share/gtk-doc/html/gtk/gtk-gtkbuildable.html#GtkBuildable"
136
 
>GtkBuildable</a>.</p>
 
90
 AtkImplementorIface,  GtkBuildable and  GtkOrientable.</p>
137
91
</div>
138
 
<div class="refsect1" lang="en">
 
92
<div class="refsect1" title="Properties">
139
93
<a name="ThunarxRenamer.properties"></a><h2>Properties</h2>
140
94
<pre class="synopsis">
141
 
  "<a class="link" href="ThunarxRenamer.html#ThunarxRenamer--help-url" title='The "help-url" property'>help-url</a>"                 <a
142
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
143
 
>gchar</a>*                : Read / Write
144
 
  "<a class="link" href="ThunarxRenamer.html#ThunarxRenamer--name" title='The "name" property'>name</a>"                     <a
145
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
146
 
>gchar</a>*                : Read / Write / Construct Only
 
95
  "<a class="link" href="ThunarxRenamer.html#ThunarxRenamer--help-url" title='The "help-url" property'>help-url</a>"                 <span class="type">gchar</span>*                : Read / Write
 
96
  "<a class="link" href="ThunarxRenamer.html#ThunarxRenamer--name" title='The "name" property'>name</a>"                     <span class="type">gchar</span>*                : Read / Write / Construct Only
147
97
</pre>
148
98
</div>
149
 
<div class="refsect1" lang="en">
 
99
<div class="refsect1" title="Signals">
150
100
<a name="ThunarxRenamer.signals"></a><h2>Signals</h2>
151
101
<pre class="synopsis">
152
102
  "<a class="link" href="ThunarxRenamer.html#ThunarxRenamer-changed" title='The "changed" signal'>changed</a>"                                        : Run First
153
103
</pre>
154
104
</div>
155
 
<div class="refsect1" lang="en">
 
105
<div class="refsect1" title="Description">
156
106
<a name="ThunarxRenamer.description"></a><h2>Description</h2>
157
107
<p>
158
108
  The abstract base class <span class="type">ThunarxRenamer</span> is implemented by
180
130
  button which opens a dialog with the additional settings.
181
131
</p>
182
132
</div>
183
 
<div class="refsect1" lang="en">
 
133
<div class="refsect1" title="Details">
184
134
<a name="ThunarxRenamer.details"></a><h2>Details</h2>
185
 
<div class="refsect2" lang="en">
 
135
<div class="refsect2" title="ThunarxRenamer">
186
136
<a name="ThunarxRenamer-struct"></a><h3>ThunarxRenamer</h3>
187
137
<pre class="programlisting">typedef struct _ThunarxRenamer ThunarxRenamer;</pre>
188
138
<p>
190
140
</p>
191
141
</div>
192
142
<hr>
193
 
<div class="refsect2" lang="en">
 
143
<div class="refsect2" title="ThunarxRenamerClass">
194
144
<a name="ThunarxRenamerClass"></a><h3>ThunarxRenamerClass</h3>
195
145
<pre class="programlisting">typedef struct {
196
146
  /* virtual methods */
222
172
<col align="left" valign="top">
223
173
<tbody>
224
174
<tr>
225
 
<td><p><span class="term"><em class="structfield"><code>process</code></em> ()</span></p></td>
 
175
<td><p><span class="term"><em class="structfield"><code><a name="ThunarxRenamerClass.process"></a>process</code></em> ()</span></p></td>
226
176
<td>    see <a class="link" href="ThunarxRenamer.html#thunarx-renamer-process" title="thunarx_renamer_process ()"><code class="function">thunarx_renamer_process()</code></a>.
227
177
</td>
228
178
</tr>
229
179
<tr>
230
 
<td><p><span class="term"><em class="structfield"><code>load</code></em> ()</span></p></td>
 
180
<td><p><span class="term"><em class="structfield"><code><a name="ThunarxRenamerClass.load"></a>load</code></em> ()</span></p></td>
231
181
<td>    see <a class="link" href="ThunarxRenamer.html#thunarx-renamer-load" title="thunarx_renamer_load ()"><code class="function">thunarx_renamer_load()</code></a>.
232
182
</td>
233
183
</tr>
234
184
<tr>
235
 
<td><p><span class="term"><em class="structfield"><code>save</code></em> ()</span></p></td>
 
185
<td><p><span class="term"><em class="structfield"><code><a name="ThunarxRenamerClass.save"></a>save</code></em> ()</span></p></td>
236
186
<td>    see <a class="link" href="ThunarxRenamer.html#thunarx-renamer-save" title="thunarx_renamer_save ()"><code class="function">thunarx_renamer_save()</code></a>.
237
187
</td>
238
188
</tr>
239
189
<tr>
240
 
<td><p><span class="term"><em class="structfield"><code>get_actions</code></em> ()</span></p></td>
 
190
<td><p><span class="term"><em class="structfield"><code><a name="ThunarxRenamerClass.get-actions"></a>get_actions</code></em> ()</span></p></td>
241
191
<td>    see <a class="link" href="ThunarxRenamer.html#thunarx-renamer-get-actions" title="thunarx_renamer_get_actions ()"><code class="function">thunarx_renamer_get_actions()</code></a>.
242
192
</td>
243
193
</tr>
244
194
<tr>
245
 
<td><p><span class="term"><em class="structfield"><code>changed</code></em> ()</span></p></td>
 
195
<td><p><span class="term"><em class="structfield"><code><a name="ThunarxRenamerClass.changed"></a>changed</code></em> ()</span></p></td>
246
196
<td>    see <a class="link" href="ThunarxRenamer.html#thunarx-renamer-changed" title="thunarx_renamer_changed ()"><code class="function">thunarx_renamer_changed()</code></a>.
247
 
 
248
197
</td>
249
198
</tr>
250
199
</tbody>
251
200
</table></div>
252
201
</div>
253
202
<hr>
254
 
<div class="refsect2" lang="en">
 
203
<div class="refsect2" title="thunarx_renamer_get_help_url ()">
255
204
<a name="thunarx-renamer-get-help-url"></a><h3>thunarx_renamer_get_help_url ()</h3>
256
 
<pre class="programlisting">const <a
257
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
258
 
>gchar</a>*        thunarx_renamer_get_help_url        (<a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer);</pre>
 
205
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       thunarx_renamer_get_help_url        (<em class="parameter"><code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> *renamer</code></em>);</pre>
259
206
<p>
260
207
Returns the URL of the documentation for <em class="parameter"><code>renamer</code></em>
261
 
or <a
262
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
263
 
><code class="literal">NULL</code></a> if no specific documentation is available
 
208
or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if no specific documentation is available
264
209
for <em class="parameter"><code>renamer</code></em> and the general documentation of the
265
 
Thunar renamers should be displayed instead.</p>
266
 
<p>
267
 
 
 
210
Thunar renamers should be displayed instead.
268
211
</p>
269
212
<div class="variablelist"><table border="0">
270
213
<col align="left" valign="top">
271
214
<tbody>
272
215
<tr>
273
216
<td><p><span class="term"><em class="parameter"><code>renamer</code></em> :</span></p></td>
274
 
<td> a <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
 
217
<td>a <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
275
218
</td>
276
219
</tr>
277
220
<tr>
283
226
</table></div>
284
227
</div>
285
228
<hr>
286
 
<div class="refsect2" lang="en">
 
229
<div class="refsect2" title="thunarx_renamer_set_help_url ()">
287
230
<a name="thunarx-renamer-set-help-url"></a><h3>thunarx_renamer_set_help_url ()</h3>
288
 
<pre class="programlisting">void                thunarx_renamer_set_help_url        (<a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer,
289
 
                                                         const <a
290
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
291
 
>gchar</a> *help_url);</pre>
 
231
<pre class="programlisting"><span class="returnvalue">void</span>                thunarx_renamer_set_help_url        (<em class="parameter"><code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> *renamer</code></em>,
 
232
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *help_url</code></em>);</pre>
292
233
<p>
293
234
The URL to the documentation of this <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
294
235
Derived classes can set this property to point to the
299
240
<p>
300
241
May also be unset, in which case the general Thunar renamer
301
242
documentation will be shown when the user clicks the "Help"
302
 
button.</p>
303
 
<p>
304
 
 
 
243
button.
305
244
</p>
306
245
<div class="variablelist"><table border="0">
307
246
<col align="left" valign="top">
308
247
<tbody>
309
248
<tr>
310
249
<td><p><span class="term"><em class="parameter"><code>renamer</code></em> :</span></p></td>
311
 
<td> a <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
 
250
<td>a <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
312
251
</td>
313
252
</tr>
314
253
<tr>
315
254
<td><p><span class="term"><em class="parameter"><code>help_url</code></em> :</span></p></td>
316
 
<td> the new URL to the documentation of <em class="parameter"><code>renamer</code></em>.
 
255
<td>the new URL to the documentation of <em class="parameter"><code>renamer</code></em>.
317
256
</td>
318
257
</tr>
319
258
</tbody>
320
259
</table></div>
321
260
</div>
322
261
<hr>
323
 
<div class="refsect2" lang="en">
 
262
<div class="refsect2" title="thunarx_renamer_get_name ()">
324
263
<a name="thunarx-renamer-get-name"></a><h3>thunarx_renamer_get_name ()</h3>
325
 
<pre class="programlisting">const <a
326
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
327
 
>gchar</a>*        thunarx_renamer_get_name            (<a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer);</pre>
 
264
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       thunarx_renamer_get_name            (<em class="parameter"><code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> *renamer</code></em>);</pre>
328
265
<p>
329
266
Returns the user visible name for <em class="parameter"><code>renamer</code></em>, previously
330
 
set with <a class="link" href="ThunarxRenamer.html#thunarx-renamer-set-name" title="thunarx_renamer_set_name ()"><code class="function">thunarx_renamer_set_name()</code></a>.</p>
331
 
<p>
332
 
 
 
267
set with <a class="link" href="ThunarxRenamer.html#thunarx-renamer-set-name" title="thunarx_renamer_set_name ()"><code class="function">thunarx_renamer_set_name()</code></a>.
333
268
</p>
334
269
<div class="variablelist"><table border="0">
335
270
<col align="left" valign="top">
336
271
<tbody>
337
272
<tr>
338
273
<td><p><span class="term"><em class="parameter"><code>renamer</code></em> :</span></p></td>
339
 
<td> a <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
 
274
<td>a <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
340
275
</td>
341
276
</tr>
342
277
<tr>
348
283
</table></div>
349
284
</div>
350
285
<hr>
351
 
<div class="refsect2" lang="en">
 
286
<div class="refsect2" title="thunarx_renamer_set_name ()">
352
287
<a name="thunarx-renamer-set-name"></a><h3>thunarx_renamer_set_name ()</h3>
353
 
<pre class="programlisting">void                thunarx_renamer_set_name            (<a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer,
354
 
                                                         const <a
355
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
356
 
>gchar</a> *name);</pre>
 
288
<pre class="programlisting"><span class="returnvalue">void</span>                thunarx_renamer_set_name            (<em class="parameter"><code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> *renamer</code></em>,
 
289
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
357
290
<p>
358
291
Sets the user visible name for <em class="parameter"><code>renamer</code></em> to <em class="parameter"><code>name</code></em>. This method should
359
292
only be called by derived classes and prior to returning the <em class="parameter"><code>renamer</code></em>
360
 
is returned from <a class="link" href="ThunarxRenamerProvider.html#thunarx-renamer-provider-get-renamers" title="thunarx_renamer_provider_get_renamers ()"><code class="function">thunarx_renamer_provider_get_renamers()</code></a>.</p>
361
 
<p>
362
 
 
 
293
is returned from <a class="link" href="ThunarxRenamerProvider.html#thunarx-renamer-provider-get-renamers" title="thunarx_renamer_provider_get_renamers ()"><code class="function">thunarx_renamer_provider_get_renamers()</code></a>.
363
294
</p>
364
295
<div class="variablelist"><table border="0">
365
296
<col align="left" valign="top">
366
297
<tbody>
367
298
<tr>
368
299
<td><p><span class="term"><em class="parameter"><code>renamer</code></em> :</span></p></td>
369
 
<td> a <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
 
300
<td>a <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
370
301
</td>
371
302
</tr>
372
303
<tr>
373
304
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
374
 
<td> the new user visible name for <em class="parameter"><code>renamer</code></em>.
 
305
<td>the new user visible name for <em class="parameter"><code>renamer</code></em>.
375
306
</td>
376
307
</tr>
377
308
</tbody>
378
309
</table></div>
379
310
</div>
380
311
<hr>
381
 
<div class="refsect2" lang="en">
 
312
<div class="refsect2" title="thunarx_renamer_process ()">
382
313
<a name="thunarx-renamer-process"></a><h3>thunarx_renamer_process ()</h3>
383
 
<pre class="programlisting"><a
384
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
385
 
>gchar</a>*              thunarx_renamer_process             (<a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer,
386
 
                                                         <a class="link" href="ThunarxFileInfo.html" title="ThunarxFileInfo">ThunarxFileInfo</a> *file,
387
 
                                                         const <a
388
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
389
 
>gchar</a> *text,
390
 
                                                         <a
391
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
392
 
>guint</a> index);</pre>
 
314
<pre class="programlisting"><span class="returnvalue">gchar</span> *             thunarx_renamer_process             (<em class="parameter"><code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> *renamer</code></em>,
 
315
                                                         <em class="parameter"><code><a class="link" href="ThunarxFileInfo.html" title="ThunarxFileInfo"><span class="type">ThunarxFileInfo</span></a> *file</code></em>,
 
316
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
 
317
                                                         <em class="parameter"><code><span class="type">guint</span> index</code></em>);</pre>
393
318
<p>
394
319
Determines the replacement for <em class="parameter"><code>text</code></em> (which is the relevant
395
320
part of the full <em class="parameter"><code>file</code></em> name, i.e. either the suffix, the name
397
322
</p>
398
323
<p>
399
324
The caller is responsible to free the returned string using
400
 
<a
401
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
402
 
><code class="function">g_free()</code></a> when no longer needed.</p>
403
 
<p>
404
 
 
 
325
<code class="function">g_free()</code> when no longer needed.
405
326
</p>
406
327
<div class="variablelist"><table border="0">
407
328
<col align="left" valign="top">
408
329
<tbody>
409
330
<tr>
410
331
<td><p><span class="term"><em class="parameter"><code>renamer</code></em> :</span></p></td>
411
 
<td> a <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
 
332
<td>a <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
412
333
</td>
413
334
</tr>
414
335
<tr>
415
336
<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
416
 
<td> the <a class="link" href="ThunarxFileInfo.html" title="ThunarxFileInfo"><span class="type">ThunarxFileInfo</span></a> for the file whose new
 
337
<td>the <a class="link" href="ThunarxFileInfo.html" title="ThunarxFileInfo"><span class="type">ThunarxFileInfo</span></a> for the file whose new
417
338
           name - according to <em class="parameter"><code>renamer</code></em> - should be
418
339
           determined.
419
340
</td>
420
341
</tr>
421
342
<tr>
422
343
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
423
 
<td> the part of the filename to which the
 
344
<td>the part of the filename to which the
424
345
           <em class="parameter"><code>renamer</code></em> should be applied.
425
346
</td>
426
347
</tr>
427
348
<tr>
428
349
<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
429
 
<td> the index of the file in the list, used
 
350
<td>the index of the file in the list, used
430
351
           for renamers that work on numbering.
431
352
</td>
432
353
</tr>
439
360
</table></div>
440
361
</div>
441
362
<hr>
442
 
<div class="refsect2" lang="en">
 
363
<div class="refsect2" title="thunarx_renamer_load ()">
443
364
<a name="thunarx-renamer-load"></a><h3>thunarx_renamer_load ()</h3>
444
 
<pre class="programlisting">void                thunarx_renamer_load                (<a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer,
445
 
                                                         <a
446
 
href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"
447
 
>GHashTable</a> *settings);</pre>
 
365
<pre class="programlisting"><span class="returnvalue">void</span>                thunarx_renamer_load                (<em class="parameter"><code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> *renamer</code></em>,
 
366
                                                         <em class="parameter"><code><span class="type">GHashTable</span> *settings</code></em>);</pre>
448
367
<p>
449
368
Tells <em class="parameter"><code>renamer</code></em> to load its internal settings from the specified
450
369
<em class="parameter"><code>settings</code></em>. The <em class="parameter"><code>settings</code></em> hash table contains previously saved
455
374
Implementations of <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> may decide to override this
456
375
method to perform custom loading of settings. If you do not
457
376
override this method, the default method of <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>
458
 
will be used, which simply loads all <a
459
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
460
 
><span class="type">GObject</span></a> properties
 
377
will be used, which simply loads all <span class="type">GObject</span> properties
461
378
provided by <em class="parameter"><code>renamer</code></em>s class (excluding the ones
462
379
provided by the parent classes) from the <em class="parameter"><code>settings</code></em>. The
463
 
<a
464
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
465
 
><span class="type">GObject</span></a> properties must be transformable to strings and
 
380
<span class="type">GObject</span> properties must be transformable to strings and
466
381
from strings.
467
382
</p>
468
383
<p>
469
384
If you decide to override this method for your <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>
470
 
implementation, you should also override <a class="link" href="ThunarxRenamer.html#thunarx-renamer-save" title="thunarx_renamer_save ()"><code class="function">thunarx_renamer_save()</code></a>.</p>
471
 
<p>
472
 
 
 
385
implementation, you should also override <a class="link" href="ThunarxRenamer.html#thunarx-renamer-save" title="thunarx_renamer_save ()"><code class="function">thunarx_renamer_save()</code></a>.
473
386
</p>
474
387
<div class="variablelist"><table border="0">
475
388
<col align="left" valign="top">
476
389
<tbody>
477
390
<tr>
478
391
<td><p><span class="term"><em class="parameter"><code>renamer</code></em> :</span></p></td>
479
 
<td> a <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
 
392
<td>a <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
480
393
</td>
481
394
</tr>
482
395
<tr>
483
396
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
484
 
<td> a <a
485
 
href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"
486
 
><span class="type">GHashTable</span></a> which contains the previously saved
 
397
<td>a <span class="type">GHashTable</span> which contains the previously saved
487
398
            settings for <em class="parameter"><code>renamer</code></em> as key/value pairs of strings.
488
399
</td>
489
400
</tr>
491
402
</table></div>
492
403
</div>
493
404
<hr>
494
 
<div class="refsect2" lang="en">
 
405
<div class="refsect2" title="thunarx_renamer_save ()">
495
406
<a name="thunarx-renamer-save"></a><h3>thunarx_renamer_save ()</h3>
496
 
<pre class="programlisting">void                thunarx_renamer_save                (<a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer,
497
 
                                                         <a
498
 
href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"
499
 
>GHashTable</a> *settings);</pre>
 
407
<pre class="programlisting"><span class="returnvalue">void</span>                thunarx_renamer_save                (<em class="parameter"><code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> *renamer</code></em>,
 
408
                                                         <em class="parameter"><code><span class="type">GHashTable</span> *settings</code></em>);</pre>
500
409
<p>
501
410
Tells <em class="parameter"><code>renamer</code></em> to save its internal settings to the specified
502
411
<em class="parameter"><code>settings</code></em>, which can afterwards be loaded by <a class="link" href="ThunarxRenamer.html#thunarx-renamer-load" title="thunarx_renamer_load ()"><code class="function">thunarx_renamer_load()</code></a>.
503
412
</p>
504
413
<p>
505
 
The strings saved to <em class="parameter"><code>settings</code></em> must be allocated by <a
506
 
href="/usr/share/gtk-doc/html/glib/glib-String-Utility-Functions.html#g-strdup"
507
 
><code class="function">g_strdup()</code></a>,
 
414
The strings saved to <em class="parameter"><code>settings</code></em> must be allocated by <code class="function">g_strdup()</code>,
508
415
both the keys and the values. For example to store the string
509
416
<code class="literal">Bar</code> for the setting <code class="literal">Foo</code>,
510
417
you'd use:
518
425
Implementations of <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> may decide to override this
519
426
method to perform custom saving of settings. If you do not overrride
520
427
this method, the default method of <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> will be used,
521
 
which simply stores all <a
522
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
523
 
><span class="type">GObject</span></a> properties provided by the
 
428
which simply stores all <span class="type">GObject</span> properties provided by the
524
429
<em class="parameter"><code>renamer</code></em>s class (excluding the ones provided by the parent
525
 
classes) to the <em class="parameter"><code>settings</code></em>. The <a
526
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
527
 
><span class="type">GObject</span></a> properties must be transformable
 
430
classes) to the <em class="parameter"><code>settings</code></em>. The <span class="type">GObject</span> properties must be transformable
528
431
to strings.
529
432
</p>
530
433
<p>
531
434
If you decide to override this method for your <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>
532
 
implementation, you should also override <a class="link" href="ThunarxRenamer.html#thunarx-renamer-load" title="thunarx_renamer_load ()"><code class="function">thunarx_renamer_load()</code></a>.</p>
533
 
<p>
534
 
 
 
435
implementation, you should also override <a class="link" href="ThunarxRenamer.html#thunarx-renamer-load" title="thunarx_renamer_load ()"><code class="function">thunarx_renamer_load()</code></a>.
535
436
</p>
536
437
<div class="variablelist"><table border="0">
537
438
<col align="left" valign="top">
538
439
<tbody>
539
440
<tr>
540
441
<td><p><span class="term"><em class="parameter"><code>renamer</code></em> :</span></p></td>
541
 
<td> a <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
 
442
<td>a <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
542
443
</td>
543
444
</tr>
544
445
<tr>
545
446
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
546
 
<td> a <a
547
 
href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"
548
 
><span class="type">GHashTable</span></a> to which the current settings of <em class="parameter"><code>renamer</code></em>
 
447
<td>a <span class="type">GHashTable</span> to which the current settings of <em class="parameter"><code>renamer</code></em>
549
448
            should be stored as key/value pairs of strings.
550
449
</td>
551
450
</tr>
553
452
</table></div>
554
453
</div>
555
454
<hr>
556
 
<div class="refsect2" lang="en">
 
455
<div class="refsect2" title="thunarx_renamer_get_actions ()">
557
456
<a name="thunarx-renamer-get-actions"></a><h3>thunarx_renamer_get_actions ()</h3>
558
 
<pre class="programlisting"><a
559
 
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
560
 
>GList</a>*              thunarx_renamer_get_actions         (<a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer,
561
 
                                                         <a
562
 
href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
563
 
>GtkWindow</a> *window,
564
 
                                                         <a
565
 
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
566
 
>GList</a> *files);</pre>
 
457
<pre class="programlisting"><span class="returnvalue">GList</span> *             thunarx_renamer_get_actions         (<em class="parameter"><code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> *renamer</code></em>,
 
458
                                                         <em class="parameter"><code><span class="type">GtkWindow</span> *window</code></em>,
 
459
                                                         <em class="parameter"><code><span class="type">GList</span> *files</code></em>);</pre>
567
460
<p>
568
 
Returns the list of <a
569
 
href="/usr/share/gtk-doc/html/gtk/GtkAction.html"
570
 
><span class="type">GtkAction</span></a>s provided by <em class="parameter"><code>renamer</code></em> for
571
 
the given list of <em class="parameter"><code>files</code></em>. By default, this method returns <a
572
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
573
 
><code class="literal">NULL</code></a>
 
461
Returns the list of <span class="type">GtkAction</span>s provided by <em class="parameter"><code>renamer</code></em> for
 
462
the given list of <em class="parameter"><code>files</code></em>. By default, this method returns <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
574
463
(the empty list), but derived classes may override this method
575
464
to provide additional actions for files in the bulk renamer
576
465
dialog list.
577
466
</p>
578
467
<p>
579
 
The returned <a
580
 
href="/usr/share/gtk-doc/html/gtk/GtkAction.html"
581
 
><span class="type">GtkAction</span></a>s will be displayed in the file's
 
468
The returned <span class="type">GtkAction</span>s will be displayed in the file's
582
469
context menu of the bulk renamer dialog, when this <em class="parameter"><code>renamer</code></em> is
583
470
active. For example, an ID3-Tag based renamer may add an action
584
471
"Edit Tags" to the context menus of supported media files and,
585
472
when activated, display a dialog (which should be transient and
586
 
modal for <em class="parameter"><code>window</code></em>, if not <a
587
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
588
 
><code class="literal">NULL</code></a>), which allows the users to edit
 
473
modal for <em class="parameter"><code>window</code></em>, if not <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>), which allows the users to edit
589
474
media file tags on-the-fly.
590
475
</p>
591
476
<p>
602
487
Some actions may only work properly if only a single file ist
603
488
selected (for example, the ID3-Tag renamer will probably only
604
489
supporting editing one file at a time). In this case you have
605
 
basicly two options: Either you can return <a
606
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
607
 
><code class="literal">NULL</code></a> here if <em class="parameter"><code>files</code></em>
 
490
basicly two options: Either you can return <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> here if <em class="parameter"><code>files</code></em>
608
491
does not contain exactly one item, or you can return the actions
609
492
as usual, but make them insensitive, using:
610
493
</p>
628
511
</p>
629
512
<p>
630
513
As a special note, this method automatically takes a reference on the
631
 
<em class="parameter"><code>renamer</code></em> for every <a
632
 
href="/usr/share/gtk-doc/html/gtk/GtkAction.html"
633
 
><span class="type">GtkAction</span></a> object returned from the real implementation
 
514
<em class="parameter"><code>renamer</code></em> for every <span class="type">GtkAction</span> object returned from the real implementation
634
515
of this method in <em class="parameter"><code>renamer</code></em>. This is to make sure that the extension stays
635
516
in memory for atleast the time that the actions are used.
636
517
</p>
637
518
<p>
638
 
The <a
639
 
href="/usr/share/gtk-doc/html/gtk/GtkAction.html"
640
 
><span class="type">GtkAction</span></a>s returned from this method must be namespaced with
 
519
The <span class="type">GtkAction</span>s returned from this method must be namespaced with
641
520
the module to avoid collision with internal file manager actions and
642
521
actions provided by other extensions. For example, the menu action
643
522
provided by the ID3-Tag renamer mentioned above, should be named
644
523
<code class="literal">TagRenamer::edit-tags</code> (if <code class="literal">TagRenamer</code>
645
 
is the class name). For additional information about the way <a
646
 
href="/usr/share/gtk-doc/html/gtk/GtkAction.html"
647
 
><span class="type">GtkAction</span></a>s
 
524
is the class name). For additional information about the way <span class="type">GtkAction</span>s
648
525
should be returned from extensions and the way they are used, read the
649
526
description of the <a class="link" href="ThunarxMenuProvider.html" title="ThunarxMenuProvider"><span class="type">ThunarxMenuProvider</span></a> interface or read the introduction
650
527
provided with this reference manual.
653
530
A note of warning concerning the <em class="parameter"><code>window</code></em> parameter. Plugins should
654
531
avoid taking a reference on <em class="parameter"><code>window</code></em>, as that might introduce a
655
532
circular reference and can thereby cause a quite large memory leak.
656
 
Instead, if <em class="parameter"><code>window</code></em> is not <a
657
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
658
 
><code class="literal">NULL</code></a>, add a weak reference using the
659
 
<a
660
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-weak-ref"
661
 
><code class="function">g_object_weak_ref()</code></a> or <a
662
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-add-weak-pointer"
663
 
><code class="function">g_object_add_weak_pointer()</code></a> method. But don't
 
533
Instead, if <em class="parameter"><code>window</code></em> is not <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>, add a weak reference using the
 
534
<code class="function">g_object_weak_ref()</code> or <code class="function">g_object_add_weak_pointer()</code> method. But don't
664
535
forget to release the weak reference if <em class="parameter"><code>window</code></em> survived the lifetime
665
 
of your action (which is likely to be the case in most situations).</p>
666
 
<p>
667
 
 
 
536
of your action (which is likely to be the case in most situations).
668
537
</p>
669
538
<div class="variablelist"><table border="0">
670
539
<col align="left" valign="top">
671
540
<tbody>
672
541
<tr>
673
542
<td><p><span class="term"><em class="parameter"><code>renamer</code></em> :</span></p></td>
674
 
<td> a <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
 
543
<td>a <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
675
544
</td>
676
545
</tr>
677
546
<tr>
678
547
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
679
 
<td> a <a
680
 
href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
681
 
><span class="type">GtkWindow</span></a> or <a
682
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
683
 
><code class="literal">NULL</code></a>.
 
548
<td>a <span class="type">GtkWindow</span> or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.
684
549
</td>
685
550
</tr>
686
551
<tr>
687
552
<td><p><span class="term"><em class="parameter"><code>files</code></em> :</span></p></td>
688
 
<td> a <a
689
 
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
690
 
><span class="type">GList</span></a> of <a class="link" href="ThunarxFileInfo.html" title="ThunarxFileInfo"><span class="type">ThunarxFileInfo</span></a>s.
 
553
<td>a <span class="type">GList</span> of <a class="link" href="ThunarxFileInfo.html" title="ThunarxFileInfo"><span class="type">ThunarxFileInfo</span></a>s.
691
554
</td>
692
555
</tr>
693
556
<tr>
694
557
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
695
 
<td> the list of <a
696
 
href="/usr/share/gtk-doc/html/gtk/GtkAction.html"
697
 
><span class="type">GtkAction</span></a>s provided by <em class="parameter"><code>renamer</code></em>
 
558
<td> the list of <span class="type">GtkAction</span>s provided by <em class="parameter"><code>renamer</code></em>
698
559
              for the given list of <em class="parameter"><code>files</code></em>.
699
560
</td>
700
561
</tr>
702
563
</table></div>
703
564
</div>
704
565
<hr>
705
 
<div class="refsect2" lang="en">
 
566
<div class="refsect2" title="thunarx_renamer_changed ()">
706
567
<a name="thunarx-renamer-changed"></a><h3>thunarx_renamer_changed ()</h3>
707
 
<pre class="programlisting">void                thunarx_renamer_changed             (<a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer);</pre>
 
568
<pre class="programlisting"><span class="returnvalue">void</span>                thunarx_renamer_changed             (<em class="parameter"><code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> *renamer</code></em>);</pre>
708
569
<p>
709
570
This method should be used by derived classes
710
571
to emit the "changed" signal for <em class="parameter"><code>renamer</code></em>. See
711
572
the documentation of the "changed" signal for
712
 
details.</p>
713
 
<p>
714
 
 
 
573
details.
715
574
</p>
716
575
<div class="variablelist"><table border="0">
717
576
<col align="left" valign="top">
718
577
<tbody><tr>
719
578
<td><p><span class="term"><em class="parameter"><code>renamer</code></em> :</span></p></td>
720
 
<td> a <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
 
579
<td>a <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
721
580
</td>
722
581
</tr></tbody>
723
582
</table></div>
724
583
</div>
725
584
</div>
726
 
<div class="refsect1" lang="en">
 
585
<div class="refsect1" title="Property Details">
727
586
<a name="ThunarxRenamer.property-details"></a><h2>Property Details</h2>
728
 
<div class="refsect2" lang="en">
 
587
<div class="refsect2" title='The "help-url" property'>
729
588
<a name="ThunarxRenamer--help-url"></a><h3>The <code class="literal">"help-url"</code> property</h3>
730
 
<pre class="programlisting">  "help-url"                 <a
731
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
732
 
>gchar</a>*                : Read / Write</pre>
 
589
<pre class="programlisting">  "help-url"                 <span class="type">gchar</span>*                : Read / Write</pre>
733
590
<p>
734
591
The URL to the documentation of this <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
735
592
Derived classes can set this property to point to the
740
597
<p>
741
598
May also be unset, in which case the general Thunar renamer
742
599
documentation will be shown when the user clicks the "Help"
743
 
button.</p>
744
 
<p>
745
 
 
 
600
button.
746
601
</p>
747
602
<p>Default value: NULL</p>
748
603
</div>
749
604
<hr>
750
 
<div class="refsect2" lang="en">
 
605
<div class="refsect2" title='The "name" property'>
751
606
<a name="ThunarxRenamer--name"></a><h3>The <code class="literal">"name"</code> property</h3>
752
 
<pre class="programlisting">  "name"                     <a
753
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
754
 
>gchar</a>*                : Read / Write / Construct Only</pre>
 
607
<pre class="programlisting">  "name"                     <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
755
608
<p>
756
609
The user visible name of the renamer, that is displayed
757
610
in the bulk rename dialog of the file manager. Derived
758
 
classes should set a useful name.</p>
759
 
<p>
760
 
 
 
611
classes should set a useful name.
761
612
</p>
762
613
<p>Default value: NULL</p>
763
614
</div>
764
615
</div>
765
 
<div class="refsect1" lang="en">
 
616
<div class="refsect1" title="Signal Details">
766
617
<a name="ThunarxRenamer.signal-details"></a><h2>Signal Details</h2>
767
 
<div class="refsect2" lang="en">
 
618
<div class="refsect2" title='The "changed" signal'>
768
619
<a name="ThunarxRenamer-changed"></a><h3>The <code class="literal">"changed"</code> signal</h3>
769
 
<pre class="programlisting">void                user_function                      (<a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer,
770
 
                                                        <a
771
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
772
 
>gpointer</a>        user_data)      : Run First</pre>
 
620
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a> *renamer,
 
621
                                                        <span class="type">gpointer</span>        user_data)      : Run First</pre>
773
622
<p>
774
623
Derived classes should emit this signal using the
775
624
<a class="link" href="ThunarxRenamer.html#thunarx-renamer-changed" title="thunarx_renamer_changed ()"><code class="function">thunarx_renamer_changed()</code></a> method whenever the user
777
626
</p>
778
627
<p>
779
628
The file manager will then invoke <a class="link" href="ThunarxRenamer.html#thunarx-renamer-process" title="thunarx_renamer_process ()"><code class="function">thunarx_renamer_process()</code></a>
780
 
for all files that should be renamed and update the preview.</p>
781
 
<p>
782
 
 
 
629
for all files that should be renamed and update the preview.
783
630
</p>
784
631
<div class="variablelist"><table border="0">
785
632
<col align="left" valign="top">
786
633
<tbody>
787
634
<tr>
788
635
<td><p><span class="term"><em class="parameter"><code>renamer</code></em> :</span></p></td>
789
 
<td> a <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
 
636
<td>a <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer"><span class="type">ThunarxRenamer</span></a>.
790
637
</td>
791
638
</tr>
792
639
<tr>
797
644
</table></div>
798
645
</div>
799
646
</div>
800
 
<div class="refsect1" lang="en">
 
647
<div class="refsect1" title="See Also">
801
648
<a name="ThunarxRenamer.see-also"></a><h2>See Also</h2>
802
649
<p>
803
650
  The description of the <a class="link" href="ThunarxRenamerProvider.html" title="ThunarxRenamerProvider"><span class="type">ThunarxRenamerProvider</span></a>
807
654
</div>
808
655
<div class="footer">
809
656
<hr>
810
 
          Generated by GTK-Doc V1.10</div>
 
657
          Generated by GTK-Doc V1.14</div>
811
658
</body>
812
 
</html>
 
659
</html>
 
 
b'\\ No newline at end of file'