~noskcaj/ubuntu/vivid/thunar/1.6.4

const gchar * <a class="link" href="ThunarxRenamer.html#thunarx-renamer-get-help-url" title="thunarx_renamer_get_help_url ()">thunarx_renamer_get_help_url</a> (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>);

const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">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> (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>);

void <a class="link" href="ThunarxRenamer.html#thunarx-renamer-set-help-url" title="thunarx_renamer_set_help_url ()">thunarx_renamer_set_help_url</a> (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>,

<code>const gchar *help_url</code>);

const gchar * <a class="link" href="ThunarxRenamer.html#thunarx-renamer-get-name" title="thunarx_renamer_get_name ()">thunarx_renamer_get_name</a> (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>);

<code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> *help_url</code>);

const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> * <a class="link" href="ThunarxRenamer.html#thunarx-renamer-get-name" title="thunarx_renamer_get_name ()">thunarx_renamer_get_name</a> (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>);

void <a class="link" href="ThunarxRenamer.html#thunarx-renamer-set-name" title="thunarx_renamer_set_name ()">thunarx_renamer_set_name</a> (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>,

<code>const gchar *name</code>);

gchar * <a class="link" href="ThunarxRenamer.html#thunarx-renamer-process" title="thunarx_renamer_process ()">thunarx_renamer_process</a> (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>,

<code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> *name</code>);

<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> * <a class="link" href="ThunarxRenamer.html#thunarx-renamer-process" title="thunarx_renamer_process ()">thunarx_renamer_process</a> (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>,

<code><a class="link" href="ThunarxFileInfo.html" title="ThunarxFileInfo">ThunarxFileInfo</a> *file</code>,

<code>const gchar *text</code>,

<code>guint index</code>);

<code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> *text</code>,

<code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint">guint</a> index</code>);

void <a class="link" href="ThunarxRenamer.html#thunarx-renamer-load" title="thunarx_renamer_load ()">thunarx_renamer_load</a> (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>,

<code>GHashTable *settings</code>);

<code><a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable">GHashTable</a> *settings</code>);

void <a class="link" href="ThunarxRenamer.html#thunarx-renamer-save" title="thunarx_renamer_save ()">thunarx_renamer_save</a> (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>,

<code>GHashTable *settings</code>);

GList * <a class="link" href="ThunarxRenamer.html#thunarx-renamer-get-actions" title="thunarx_renamer_get_actions ()">thunarx_renamer_get_actions</a> (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>,

<code>GtkWindow *window</code>,

<code>GList *files</code>);

<code><a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable">GHashTable</a> *settings</code>);

<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList">GList</a> * <a class="link" href="ThunarxRenamer.html#thunarx-renamer-get-actions" title="thunarx_renamer_get_actions ()">thunarx_renamer_get_actions</a> (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>,

<code><a href="/usr/share/gtk-doc/html/gtk/GtkWindow.html">GtkWindow</a> *window</code>,

<code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList">GList</a> *files</code>);

void <a class="link" href="ThunarxRenamer.html#thunarx-renamer-changed" title="thunarx_renamer_changed ()">thunarx_renamer_changed</a> (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>);

</pre>

</div>

<a name="ThunarxRenamer.object-hierarchy"></a><h2>Object Hierarchy</h2>

GObject

+----GInitiallyUnowned

+----GtkObject

+----GtkWidget

+----GtkContainer

+----GtkBox

+----GtkVBox

<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>

+----<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>

+----<a href="/usr/share/gtk-doc/html/gtk/GtkObject.html">GtkObject</a>

+----<a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html">GtkWidget</a>

+----<a href="/usr/share/gtk-doc/html/gtk/GtkContainer.html">GtkContainer</a>

+----<a href="/usr/share/gtk-doc/html/gtk/GtkBox.html">GtkBox</a>

+----<a href="/usr/share/gtk-doc/html/gtk/GtkVBox.html">GtkVBox</a>

+----ThunarxRenamer

</pre>

</div>

<a name="ThunarxRenamer.implemented-interfaces"></a><h2>Implemented Interfaces</h2>

ThunarxRenamer implements

AtkImplementorIface, GtkBuildable and GtkOrientable.

AtkImplementorIface, <a href="/usr/share/gtk-doc/html/gtk/gtk-gtkbuildable.html#GtkBuildable">GtkBuildable</a> and <a href="/usr/share/gtk-doc/html/gtk/gtk-Orientable.html#GtkOrientable">GtkOrientable</a>.

</div>

<a name="ThunarxRenamer.properties"></a><h2>Properties</h2>

"<a class="link" href="ThunarxRenamer.html#ThunarxRenamer--help-url" title='The "help-url" property'>help-url</a>" gchar* : Read / Write

"<a class="link" href="ThunarxRenamer.html#ThunarxRenamer--name" title='The "name" property'>name</a>" gchar* : Read / Write / Construct Only

"<a class="link" href="ThunarxRenamer.html#ThunarxRenamer--help-url" title='The "help-url" property'>help-url</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a>* : Read / Write

"<a class="link" href="ThunarxRenamer.html#ThunarxRenamer--name" title='The "name" property'>name</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a>* : Read / Write / Construct Only

</pre>

</div>

202

<hr>

203

204

<a name="thunarx-renamer-get-help-url"></a><h3>thunarx_renamer_get_help_url ()</h3>

205

<pre class="programlisting">const gchar * thunarx_renamer_get_help_url (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>);</pre>

205

<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> * thunarx_renamer_get_help_url (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>);</pre>

206

207

Returns the URL of the documentation for <code>renamer</code>

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

208

or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no specific documentation is available

209

for <code>renamer</code> and the general documentation of the

210

Thunar renamers should be displayed instead.

211

229

230

<a name="thunarx-renamer-set-help-url"></a><h3>thunarx_renamer_set_help_url ()</h3>

231

<pre class="programlisting">void thunarx_renamer_set_help_url (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>,

232

<code>const gchar *help_url</code>);</pre>

232

<code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> *help_url</code>);</pre>

233

234

The URL to the documentation of this <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a>.

235

Derived classes can set this property to point to the

261

<hr>

262

263

<a name="thunarx-renamer-get-name"></a><h3>thunarx_renamer_get_name ()</h3>

264

<pre class="programlisting">const gchar * thunarx_renamer_get_name (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>);</pre>

264

<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> * thunarx_renamer_get_name (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>);</pre>

265

266

Returns the user visible name for <code>renamer</code>, previously

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>.

286

287

<a name="thunarx-renamer-set-name"></a><h3>thunarx_renamer_set_name ()</h3>

288

<pre class="programlisting">void thunarx_renamer_set_name (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>,

289

<code>const gchar *name</code>);</pre>

289

<code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> *name</code>);</pre>

290

291

Sets the user visible name for <code>renamer</code> to <code>name</code>. This method should

292

only be called by derived classes and prior to returning the <code>renamer</code>

311

<hr>

312

313

<a name="thunarx-renamer-process"></a><h3>thunarx_renamer_process ()</h3>

314

<pre class="programlisting">gchar * thunarx_renamer_process (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>,

314

<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> * thunarx_renamer_process (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>,

315

<code><a class="link" href="ThunarxFileInfo.html" title="ThunarxFileInfo">ThunarxFileInfo</a> *file</code>,

316

<code>const gchar *text</code>,

317

<code>guint index</code>);</pre>

316

<code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> *text</code>,

317

<code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint">guint</a> index</code>);</pre>

318

319

Determines the replacement for <code>text</code> (which is the relevant

320

part of the full <code>file</code> name, i.e. either the suffix, the name

322

323

324

The caller is responsible to free the returned string using

325

<code class="function">g_free()</code> when no longer needed.

325

<a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed.

326

327

328

347

</tr>

348

<tr>

349

<td><code>index</code> :</td>

350

<td>the index of the file in the list, used

351

for renamers that work on numbering.

350

<td>

352

351

</td>

353

352

</tr>

354

353

<tr>

363

362

364

363

<a name="thunarx-renamer-load"></a><h3>thunarx_renamer_load ()</h3>

365

364

<pre class="programlisting">void thunarx_renamer_load (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>,

366

<code>GHashTable *settings</code>);</pre>

365

<code><a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable">GHashTable</a> *settings</code>);</pre>

367

366

368

367

Tells <code>renamer</code> to load its internal settings from the specified

369

368

<code>settings</code>. The <code>settings</code> hash table contains previously saved

374

373

Implementations of <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> may decide to override this

375

374

method to perform custom loading of settings. If you do not

376

375

override this method, the default method of <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a>

377

will be used, which simply loads all GObject properties

376

will be used, which simply loads all <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> properties

378

377

provided by <code>renamer</code>s class (excluding the ones

379

378

provided by the parent classes) from the <code>settings</code>. The

380

GObject properties must be transformable to strings and

379

<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> properties must be transformable to strings and

381

380

from strings.

382

381

383

382

394

393

</tr>

395

394

<tr>

396

395

<td><code>settings</code> :</td>

397

<td>a GHashTable which contains the previously saved

396

<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable">GHashTable</a> which contains the previously saved

398

397

settings for <code>renamer</code> as key/value pairs of strings.

399

398

</td>

400

399

</tr>

405

404

406

405

<a name="thunarx-renamer-save"></a><h3>thunarx_renamer_save ()</h3>

407

406

<pre class="programlisting">void thunarx_renamer_save (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>,

408

<code>GHashTable *settings</code>);</pre>

407

<code><a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable">GHashTable</a> *settings</code>);</pre>

409

408

410

409

Tells <code>renamer</code> to save its internal settings to the specified

411

410

<code>settings</code>, 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>.

412

411

413

412

414

The strings saved to <code>settings</code> must be allocated by <code class="function">g_strdup()</code>,

413

The strings saved to <code>settings</code> must be allocated by <a href="/usr/share/gtk-doc/html/glib/glib-String-Utility-Functions.html#g-strdup"><code class="function">g_strdup()</code></a>,

415

414

both the keys and the values. For example to store the string

416

415

<code class="literal">Bar</code> for the setting <code class="literal">Foo</code>,

417

416

you'd use:

418

417

419

420

g_hash_table_replace (settings, g_strdup ("Foo"), g_strdup ("Bar"));

421

</pre></div>

418

419

420

<tbody>

421

<tr>

422

423

<td class="listing_code"><pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#g-hash-table-replace">g_hash_table_replace</a> (settings, <a href="/usr/share/gtk-doc/html/glib/glib-String-Utility-Functions.html#g-strdup">g_strdup</a> ("Foo"), <a href="/usr/share/gtk-doc/html/glib/glib-String-Utility-Functions.html#g-strdup">g_strdup</a> ("Bar"));</pre></td>

424

</tr>

425

</tbody>

426

</table>

427

</div>

428

422

429

423

430

424

431

425

432

Implementations of <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> may decide to override this

426

433

method to perform custom saving of settings. If you do not overrride

427

434

this method, the default method of <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> will be used,

428

which simply stores all GObject properties provided by the

435

which simply stores all <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> properties provided by the

429

436

<code>renamer</code>s class (excluding the ones provided by the parent

430

classes) to the <code>settings</code>. The GObject properties must be transformable

437

classes) to the <code>settings</code>. The <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> properties must be transformable

431

438

to strings.

432

439

433

440

444

451

</tr>

445

452

<tr>

446

453

<td><code>settings</code> :</td>

447

<td>a GHashTable to which the current settings of <code>renamer</code>

454

<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable">GHashTable</a> to which the current settings of <code>renamer</code>

448

455

should be stored as key/value pairs of strings.

449

456

</td>

450

457

</tr>

454

461

<hr>

455

462

456

463

<a name="thunarx-renamer-get-actions"></a><h3>thunarx_renamer_get_actions ()</h3>

457

<pre class="programlisting">GList * thunarx_renamer_get_actions (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>,

458

<code>GtkWindow *window</code>,

459

<code>GList *files</code>);</pre>

464

<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList">GList</a> * thunarx_renamer_get_actions (<code><a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer</code>,

465

<code><a href="/usr/share/gtk-doc/html/gtk/GtkWindow.html">GtkWindow</a> *window</code>,

466

<code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList">GList</a> *files</code>);</pre>

460

467

461

Returns the list of GtkActions provided by <code>renamer</code> for

462

the given list of <code>files</code>. By default, this method returns <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>

468

Returns the list of <a href="/usr/share/gtk-doc/html/gtk/GtkAction.html">GtkAction</a>s provided by <code>renamer</code> for

469

the given list of <code>files</code>. By default, this method returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

463

470

(the empty list), but derived classes may override this method

464

471

to provide additional actions for files in the bulk renamer

465

472

dialog list.

466

473

467

474

468

The returned GtkActions will be displayed in the file's

475

The returned <a href="/usr/share/gtk-doc/html/gtk/GtkAction.html">GtkAction</a>s will be displayed in the file's

469

476

context menu of the bulk renamer dialog, when this <code>renamer</code> is

470

477

active. For example, an ID3-Tag based renamer may add an action

471

478

"Edit Tags" to the context menus of supported media files and,

472

479

when activated, display a dialog (which should be transient and

473

modal for <code>window</code>, 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

480

modal for <code>window</code>, if not <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>), which allows the users to edit

474

481

media file tags on-the-fly.

475

482

476

483

487

494

Some actions may only work properly if only a single file ist

488

495

selected (for example, the ID3-Tag renamer will probably only

489

496

supporting editing one file at a time). In this case you have

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 <code>files</code>

497

basicly two options: Either you can return <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> here if <code>files</code>

491

498

does not contain exactly one item, or you can return the actions

492

499

as usual, but make them insensitive, using:

493

500

494

495

gtk_action_set_sensitive (action, FALSE);

496

</pre></div>

501

502

503

<tbody>

504

<tr>

505

506

<td class="listing_code"><pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk/GtkAction.html#gtk-action-set-sensitive">gtk_action_set_sensitive</a> (action, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS">FALSE</a>);</pre></td>

507

</tr>

508

</tbody>

509

</table>

510

</div>

511

497

512

498

513

The latter has the advantage that the user will still notice the

499

514

existance of the action and probably realize that it can only be

503

518

The caller is responsible to free the returned list using something

504

519

like the following:

505

520

506

507

g_list_foreach (list, (GFunc) g_object_unref, NULL);

508

g_list_free (list);

509

</pre></div>

521

522

523

<tbody>

524

<tr>

525

<td class="listing_lines" align="right"><pre>1

526

2</pre></td>

527

<td class="listing_code"><pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#g-list-foreach">g_list_foreach</a> (list, (<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GFunc">GFunc</a>) <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a>, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a>);

528

529

</tr>

530

</tbody>

531

</table>

532

</div>

533

510

534

511

535

512

536

513

537

As a special note, this method automatically takes a reference on the

514

<code>renamer</code> for every GtkAction object returned from the real implementation

538

<code>renamer</code> for every <a href="/usr/share/gtk-doc/html/gtk/GtkAction.html">GtkAction</a> object returned from the real implementation

515

539

of this method in <code>renamer</code>. This is to make sure that the extension stays

516

540

in memory for atleast the time that the actions are used.

517

541

518

542

519

The GtkActions returned from this method must be namespaced with

543

The <a href="/usr/share/gtk-doc/html/gtk/GtkAction.html">GtkAction</a>s returned from this method must be namespaced with

520

544

the module to avoid collision with internal file manager actions and

521

545

actions provided by other extensions. For example, the menu action

522

546

provided by the ID3-Tag renamer mentioned above, should be named

523

547

<code class="literal">TagRenamer::edit-tags</code> (if <code class="literal">TagRenamer</code>

524

is the class name). For additional information about the way GtkActions

548

is the class name). For additional information about the way <a href="/usr/share/gtk-doc/html/gtk/GtkAction.html">GtkAction</a>s

525

549

should be returned from extensions and the way they are used, read the

526

550

description of the <a class="link" href="ThunarxMenuProvider.html" title="ThunarxMenuProvider">ThunarxMenuProvider</a> interface or read the introduction

527

551

provided with this reference manual.

530

554

A note of warning concerning the <code>window</code> parameter. Plugins should

531

555

avoid taking a reference on <code>window</code>, as that might introduce a

532

556

circular reference and can thereby cause a quite large memory leak.

533

Instead, if <code>window</code> 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

557

Instead, if <code>window</code> is not <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, add a weak reference using the

558

<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-weak-ref"><code class="function">g_object_weak_ref()</code></a> or <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-add-weak-pointer"><code class="function">g_object_add_weak_pointer()</code></a> method. But don't

535

559

forget to release the weak reference if <code>window</code> survived the lifetime

536

560

of your action (which is likely to be the case in most situations).

537

561

545

569

</tr>

546

570

<tr>

547

571

<td><code>window</code> :</td>

548

<td>a GtkWindow or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.

572

<td>a <a href="/usr/share/gtk-doc/html/gtk/GtkWindow.html">GtkWindow</a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

549

573

</td>

550

574

</tr>

551

575

<tr>

552

576

<td><code>files</code> :</td>

553

<td>a GList of <a class="link" href="ThunarxFileInfo.html" title="ThunarxFileInfo">ThunarxFileInfo</a>s.

577

<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList">GList</a> of <a class="link" href="ThunarxFileInfo.html" title="ThunarxFileInfo">ThunarxFileInfo</a>s.

554

578

</td>

555

579

</tr>

556

580

<tr>

557

581

<td>Returns :</td>

558

<td> the list of GtkActions provided by <code>renamer</code>

582

<td> the list of <a href="/usr/share/gtk-doc/html/gtk/GtkAction.html">GtkAction</a>s provided by <code>renamer</code>

559

583

for the given list of <code>files</code>.

560

584

</td>

561

585

</tr>

586

610

<a name="ThunarxRenamer.property-details"></a><h2>Property Details</h2>

587

611

588

612

<a name="ThunarxRenamer--help-url"></a><h3>The <code class="literal">"help-url"</code> property</h3>

589

<pre class="programlisting"> "help-url" gchar* : Read / Write</pre>

613

<pre class="programlisting"> "help-url" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a>* : Read / Write</pre>

590

614

591

615

The URL to the documentation of this <a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a>.

592

616

Derived classes can set this property to point to the

604

628

<hr>

605

629

606

630

<a name="ThunarxRenamer--name"></a><h3>The <code class="literal">"name"</code> property</h3>

607

<pre class="programlisting"> "name" gchar* : Read / Write / Construct Only</pre>

631

<pre class="programlisting"> "name" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a>* : Read / Write / Construct Only</pre>

608

632

609

633

The user visible name of the renamer, that is displayed

610

634

in the bulk rename dialog of the file manager. Derived

618

642

619

643

<a name="ThunarxRenamer-changed"></a><h3>The <code class="literal">"changed"</code> signal</h3>

620

644

<pre class="programlisting">void user_function (<a class="link" href="ThunarxRenamer.html" title="ThunarxRenamer">ThunarxRenamer</a> *renamer,

621

gpointer user_data) : Run First</pre>

645

<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data) : Run First</pre>

622

646

623

647

Derived classes should emit this signal using the

624

648

<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

Older »