~ubuntu-branches/debian/jessie/glib2.0/jessie

<a class="link" href="GApplication.html#g-application-get-application-id" title="g_application_get_application_id ()">g_application_get_application_id</a> ()

</tr>

<tr>

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a>

<a href="../glib/glib-Basic-Types.html#guint">guint</a>

</td>

<a class="link" href="GApplication.html#g-application-get-inactivity-timeout" title="g_application_get_inactivity_timeout ()">g_application_get_inactivity_timeout</a> ()

107

</td>

108

</tr>

109

<tr>

110

<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *

110

<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *

111

</td>

112

113

<a class="link" href="GApplication.html#g-application-get-resource-base-path" title="g_application_get_resource_base_path ()">g_application_get_resource_base_path</a> ()

130

</td>

131

</tr>

132

<tr>

133

<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *

133

<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *

134

</td>

135

136

<a class="link" href="GApplication.html#g-application-get-dbus-object-path" title="g_application_get_dbus_object_path ()">g_application_get_dbus_object_path</a> ()

146

</tr>

147

<tr>

148

149

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

149

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

150

</td>

151

152

<a class="link" href="GApplication.html#g-application-get-is-registered" title="g_application_get_is_registered ()">g_application_get_is_registered</a> ()

154

</tr>

155

<tr>

156

157

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

157

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

158

</td>

159

160

<a class="link" href="GApplication.html#g-application-get-is-remote" title="g_application_get_is_remote ()">g_application_get_is_remote</a> ()

162

</tr>

163

<tr>

164

165

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

165

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

166

</td>

167

168

<a class="link" href="GApplication.html#g-application-register" title="g_application_register ()">g_application_register</a> ()

308

</tr>

309

<tr>

310

311

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *</td>

311

<a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *</td>

312

<td class="property_name"><a class="link" href="GApplication.html#GApplication--application-id" title="The “application-id” property">application-id</a></td>

313

<td class="property_flags">Read / Write / Construct</td>

314

</tr>

318

<td class="property_flags">Read / Write</td>

319

</tr>

320

<tr>

321

<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a></td>

321

<td class="property_type"><a href="../glib/glib-Basic-Types.html#guint">guint</a></td>

322

<td class="property_name"><a class="link" href="GApplication.html#GApplication--inactivity-timeout" title="The “inactivity-timeout” property">inactivity-timeout</a></td>

323

<td class="property_flags">Read / Write</td>

324

</tr>

325

<tr>

326

<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a></td>

326

<td class="property_type"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a></td>

327

<td class="property_name"><a class="link" href="GApplication.html#GApplication--is-registered" title="The “is-registered” property">is-registered</a></td>

328

329

</tr>

330

<tr>

331

<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a></td>

331

<td class="property_type"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a></td>

332

<td class="property_name"><a class="link" href="GApplication.html#GApplication--is-remote" title="The “is-remote” property">is-remote</a></td>

333

334

</tr>

335

<tr>

336

337

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *</td>

337

<a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *</td>

338

<td class="property_name"><a class="link" href="GApplication.html#GApplication--resource-base-path" title="The “resource-base-path” property">resource-base-path</a></td>

339

<td class="property_flags">Read / Write</td>

340

</tr>

356

357

</tr>

358

<tr>

359

359

360

<td class="signal_name"><a class="link" href="GApplication.html#GApplication-command-line" title="The “command-line” signal">command-line</a></td>

361

362

</tr>

363

<tr>

364

364

365

<td class="signal_name"><a class="link" href="GApplication.html#GApplication-handle-local-options" title="The “handle-local-options” signal">handle-local-options</a></td>

366

367

</tr>

408

</div>

409

410

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

411

<pre class="screen"> GFlags

411

<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GFlags</a>

412

╰── GApplicationFlags

413

<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>

413

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

414

╰── GApplication

415

</pre>

416

</div>

430

A <a class="link" href="GApplication.html" title="GApplication">GApplication</a> is the foundation of an application. It wraps some

431

low-level platform-specific services and is intended to act as the

432

foundation for higher-level application classes such as

433

<a href="http://developer.gnome.org/gtk2/GtkApplication.html">GtkApplication</a> or MxApplication. In general, you should not use

433

GtkApplication or MxApplication. In general, you should not use

434

this class outside of a higher level framework.

435

GApplication provides convenient life cycle management by maintaining

436

a "use count" for the primary application instance. The use count can

437

be changed using <a class="link" href="GApplication.html#g-application-hold" title="g_application_hold ()"><code class="function">g_application_hold()</code></a> and <a class="link" href="GApplication.html#g-application-release" title="g_application_release ()"><code class="function">g_application_release()</code></a>. If

438

it drops to zero, the application exits. Higher-level classes such as

439

<a href="http://developer.gnome.org/gtk2/GtkApplication.html">GtkApplication</a> employ the use count to ensure that the application

439

GtkApplication employ the use count to ensure that the application

440

stays alive as long as it has any opened windows.

441

Another feature that GApplication (optionally) provides is process

442

uniqueness. Applications can make use of this functionality by

498

Regardless of which of these entry points is used to start the

499

application, GApplication passes some "platform data from the

500

launching instance to the primary instance, in the form of a

501

<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a> dictionary mapping strings to variants. To use platform

501

<a href="../glib/glib-GVariant.html#GVariant">GVariant</a> dictionary mapping strings to variants. To use platform

502

data, override the <code>before_emit</code>

503

or <code>after_emit</code>

504

virtual functions

515

<a class="link" href="GApplication.html#G-APPLICATION-SEND-ENVIRONMENT:CAPS"><code class="literal">G_APPLICATION_SEND_ENVIRONMENT</code></a> flag is set. <a class="link" href="GApplication.html" title="GApplication">GApplication</a> subclasses

516

can add their own platform data by overriding the <code>add_platform_data</code>

517

518

virtual function. For instance, <a href="http://developer.gnome.org/gtk2/GtkApplication.html">GtkApplication</a> adds startup notification

518

virtual function. For instance, GtkApplication adds startup notification

519

data in this way.

520

To parse commandline arguments you may handle the

521

<a class="link" href="GApplication.html#GApplication-command-line" title="The “command-line” signal">“command-line”</a> signal or override the <code class="function">local_command_line()</code>

532

<a name="GApplication.functions_details"></a><h2>Functions</h2>

533

534

<a name="g-application-id-is-valid"></a><h3>g_application_id_is_valid ()</h3>

535

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

536

g_application_id_is_valid (<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *application_id</code>);</pre>

535

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

536

g_application_id_is_valid (<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *application_id</code>);</pre>

537

Checks if <code>application_id</code>

538

is a valid application identifier.

539

A valid ID is required for calls to <a class="link" href="GApplication.html#g-application-new" title="g_application_new ()"><code class="function">g_application_new()</code></a> and

568

</div>

569

570

<a name="id-1.4.22.2.11.2.9"></a><h4>Returns</h4>

571

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <code>application_id</code>

571

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <code>application_id</code>

572

is valid

573

574

</div>

577

578

<a name="g-application-new"></a><h3>g_application_new ()</h3>

579

<pre class="programlisting"><a class="link" href="GApplication.html" title="GApplication">GApplication</a> *

580

g_application_new (<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *application_id</code>,

580

g_application_new (<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *application_id</code>,

581

<code><a class="link" href="GApplication.html#GApplicationFlags" title="enum GApplicationFlags">GApplicationFlags</a> flags</code>);</pre>

582

Creates a new <a class="link" href="GApplication.html" title="GApplication">GApplication</a> instance.

583

If non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the application id must be valid. See

583

If non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the application id must be valid. See

584

<a class="link" href="GApplication.html#g-application-id-is-valid" title="g_application_id_is_valid ()"><code class="function">g_application_id_is_valid()</code></a>.

585

If no application ID is given then some features of <a class="link" href="GApplication.html" title="GApplication">GApplication</a>

586

(most notably application uniqueness) will be disabled.

615

<hr>

616

617

<a name="g-application-get-application-id"></a><h3>g_application_get_application_id ()</h3>

618

<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *

618

<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *

619

g_application_get_application_id (<code><a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application</code>);</pre>

620

Gets the unique identifier for <code>application</code>

621

.

648

<a name="g-application-set-application-id"></a><h3>g_application_set_application_id ()</h3>

649

<pre class="programlisting">void

650

g_application_set_application_id (<code><a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application</code>,

651

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *application_id</code>);</pre>

651

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *application_id</code>);</pre>

652

Sets the unique identifier for <code>application</code>

653

.

654

The application id can only be modified if <code>application</code>

655

has not yet

656

been registered.

657

If non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the application id must be valid. See

657

If non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the application id must be valid. See

658

<a class="link" href="GApplication.html#g-application-id-is-valid" title="g_application_id_is_valid ()"><code class="function">g_application_id_is_valid()</code></a>.

659

660

<a name="id-1.4.22.2.11.5.7"></a><h4>Parameters</h4>

684

<hr>

685

686

<a name="g-application-get-inactivity-timeout"></a><h3>g_application_get_inactivity_timeout ()</h3>

687

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a>

687

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint">guint</a>

688

g_application_get_inactivity_timeout (<code><a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application</code>);</pre>

689

Gets the current inactivity timeout for the application.

690

This is the amount of time (in milliseconds) after the last call to

716

<a name="g-application-set-inactivity-timeout"></a><h3>g_application_set_inactivity_timeout ()</h3>

717

<pre class="programlisting">void

718

g_application_set_inactivity_timeout (<code><a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application</code>,

719

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a> inactivity_timeout</code>);</pre>

719

<code><a href="../glib/glib-Basic-Types.html#guint">guint</a> inactivity_timeout</code>);</pre>

720

Sets the current inactivity timeout for the application.

721

This is the amount of time (in milliseconds) after the last call to

722

<a class="link" href="GApplication.html#g-application-release" title="g_application_release ()"><code class="function">g_application_release()</code></a> before the application stops running.

818

<hr>

819

820

<a name="g-application-get-resource-base-path"></a><h3>g_application_get_resource_base_path ()</h3>

821

<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *

821

<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *

822

g_application_get_resource_base_path (<code><a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application</code>);</pre>

823

Gets the resource base path of <code>application</code>

824

.

850

<a name="g-application-set-resource-base-path"></a><h3>g_application_set_resource_base_path ()</h3>

851

<pre class="programlisting">void

852

g_application_set_resource_base_path (<code><a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application</code>,

853

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *resource_base_path</code>);</pre>

853

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *resource_path</code>);</pre>

854

Sets (or unsets) the base resource path of <code>application</code>

855

.

856

The path is used to automatically load various <GTKDOCLINK HREF="gresource">application

864

resource base path.

865

As an example, if the application has an ID of "org.example.app" then

866

the default resource base path will be "/org/example/app". If this

867

is a <a href="http://developer.gnome.org/gtk2/GtkApplication.html">GtkApplication</a> (and you have not manually changed the path)

867

is a GtkApplication (and you have not manually changed the path)

868

then Gtk will then search for the menus of the application at

869

"/org/example/app/gtk/menus.ui".

870

See <a class="link" href="gio-GResource.html#GResource" title="GResource">GResource</a> for more information about adding resources to your

871

application.

872

You can disable automatic resource loading functionality by setting

873

the path to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

873

the path to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

874

Changing the resource base path once the application is running is

875

not recommended. The point at which the resource path is consulted

876

for forming paths for various purposes is unspecified.

903

<a name="g-application-get-dbus-connection"></a><h3>g_application_get_dbus_connection ()</h3>

904

<pre class="programlisting"><a class="link" href="GDBusConnection.html" title="GDBusConnection">GDBusConnection</a> *

905

g_application_get_dbus_connection (<code><a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application</code>);</pre>

906

Gets the <a class="link" href="GDBusConnection.html" title="GDBusConnection">GDBusConnection</a> being used by the application, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

906

Gets the <a class="link" href="GDBusConnection.html" title="GDBusConnection">GDBusConnection</a> being used by the application, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

907

If <a class="link" href="GApplication.html" title="GApplication">GApplication</a> is using its D-Bus backend then this function will

908

return the <a class="link" href="GDBusConnection.html" title="GDBusConnection">GDBusConnection</a> being used for uniqueness and

909

communication with the desktop environment and other instances of the

910

application.

911

If <a class="link" href="GApplication.html" title="GApplication">GApplication</a> is not using D-Bus then this function will return

912

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. This includes the situation where the D-Bus backend would

912

<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. This includes the situation where the D-Bus backend would

913

normally be in use but we were unable to connect to the bus.

914

This function must not be called before the application has been

915

registered. See <a class="link" href="GApplication.html#g-application-get-is-registered" title="g_application_get_is_registered ()"><code class="function">g_application_get_is_registered()</code></a>.

930

</div>

931

932

<a name="id-1.4.22.2.11.12.9"></a><h4>Returns</h4>

933

a <a class="link" href="GDBusConnection.html" title="GDBusConnection">GDBusConnection</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

933

a <a class="link" href="GDBusConnection.html" title="GDBusConnection">GDBusConnection</a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

934

[<acronym title="Don't free data after the code is done.">transfer none</acronym>]

935

</div>

936

Since 2.34

938

<hr>

939

940

<a name="g-application-get-dbus-object-path"></a><h3>g_application_get_dbus_object_path ()</h3>

941

<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *

941

<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *

942

g_application_get_dbus_object_path (<code><a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application</code>);</pre>

943

Gets the D-Bus object path being used by the application, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

943

Gets the D-Bus object path being used by the application, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

944

If <a class="link" href="GApplication.html" title="GApplication">GApplication</a> is using its D-Bus backend then this function will

945

return the D-Bus object path that <a class="link" href="GApplication.html" title="GApplication">GApplication</a> is using. If the

946

application is the primary instance then there is an object published

947

at this path. If the application is not the primary instance then

948

the result of this function is undefined.

949

If <a class="link" href="GApplication.html" title="GApplication">GApplication</a> is not using D-Bus then this function will return

950

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. This includes the situation where the D-Bus backend would

950

<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. This includes the situation where the D-Bus backend would

951

normally be in use but we were unable to connect to the bus.

952

This function must not be called before the application has been

953

968

</div>

969

970

<a name="id-1.4.22.2.11.13.9"></a><h4>Returns</h4>

971

the object path, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

971

the object path, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

972

973

</div>

974

Since 2.34

1006

</tr>

1007

<tr>

1008

<td class="parameter_name">action_group</td>

1009

<td class="parameter_description"> a <a class="link" href="GActionGroup.html" title="GActionGroup">GActionGroup</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1009

<td class="parameter_description"> a <a class="link" href="GActionGroup.html" title="GActionGroup">GActionGroup</a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1010

<td class="parameter_annotations">[<acronym title="NULL is OK, both for passing and for returning.">allow-none</acronym>]</td>

1011

</tr>

1012

</tbody>

1017

<hr>

1018

1019

<a name="g-application-get-is-registered"></a><h3>g_application_get_is_registered ()</h3>

1020

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

1020

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

1021

g_application_get_is_registered (<code><a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application</code>);</pre>

1022

Checks if <code>application</code>

1023

is registered.

1040

</div>

1041

1042

<a name="id-1.4.22.2.11.15.7"></a><h4>Returns</h4>

1043

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <code>application</code>

1043

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <code>application</code>

1044

is registered

1045

1046

</div>

1049

<hr>

1050

1051

<a name="g-application-get-is-remote"></a><h3>g_application_get_is_remote ()</h3>

1052

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

1052

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

1053

g_application_get_is_remote (<code><a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application</code>);</pre>

1054

Checks if <code>application</code>

1055

is remote.

1079

</div>

1080

1081

<a name="id-1.4.22.2.11.16.8"></a><h4>Returns</h4>

1082

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <code>application</code>

1082

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <code>application</code>

1083

is remote

1084

1085

</div>

1088

<hr>

1089

1090

<a name="g-application-register"></a><h3>g_application_register ()</h3>

1091

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

1091

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

1092

g_application_register (<code><a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application</code>,

1093

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

1094

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1094

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1095

Attempts registration of the application.

1096

This is the point at which the application discovers if it is the

1097

primary instance or merely acting as a remote for an already-existing

1104

dispatched at any time (even if a main loop is not running). For

1105

this reason, you must ensure that any object paths that you wish to

1106

1107

If the application has already been registered then <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> is

1107

If the application has already been registered then <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> is

1108

returned with no work performed.

1109

The <a class="link" href="GApplication.html#GApplication-startup" title="The “startup” signal">“startup”</a> signal is emitted if registration succeeds

1110

and <code>application</code>

1112

case).

1113

In the event of an error (such as <code>cancellable</code>

1114

being cancelled, or a

1115

failure to connect to the session bus), <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <code>error</code>

1115

failure to connect to the session bus), <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <code>error</code>

1116

1117

is set appropriately.

1118

Note: the return value of this function is not an indicator that this

1134

</tr>

1135

<tr>

1136

<td class="parameter_name">cancellable</td>

1137

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1137

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1138

<td class="parameter_annotations">[<acronym title="NULL is OK, both for passing and for returning.">allow-none</acronym>]</td>

1139

</tr>

1140

<tr>

1141

<td class="parameter_name">error</td>

1142

<td class="parameter_description">a pointer to a NULL <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></td>

1142

<td class="parameter_description">a pointer to a NULL <a href="../glib/glib-Error-Reporting.html#GError">GError</a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></td>

1143

1144

</tr>

1145

</tbody>

1147

</div>

1148

1149

<a name="id-1.4.22.2.11.17.13"></a><h4>Returns</h4>

1150

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if registration succeeded

1150

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if registration succeeded

1151

1152

</div>

1153

Since 2.28

1265

<pre class="programlisting">void

1266

g_application_open (<code><a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application</code>,

1267

<code><a class="link" href="GFile.html" title="GFile">GFile</a> **files</code>,

1268

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> n_files</code>,

1269

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *hint</code>);</pre>

1268

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> n_files</code>,

1269

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *hint</code>);</pre>

1270

Opens the given files.

1271

In essence, this results in the <a class="link" href="GApplication.html#GApplication-open" title="The “open” signal">“open”</a> signal being emitted

1272

in the primary instance.

1306

</tr>

1307

<tr>

1308

1309

<td class="parameter_description">a hint (or ""), but never <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></td>

1309

<td class="parameter_description">a hint (or ""), but never <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></td>

1310

1311

</tr>

1312

</tbody>

1319

<a name="g-application-send-notification"></a><h3>g_application_send_notification ()</h3>

1320

<pre class="programlisting">void

1321

g_application_send_notification (<code><a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application</code>,

1322

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *id</code>,

1322

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *id</code>,

1323

<code><a class="link" href="gio-GNotification.html#GNotification" title="GNotification">GNotification</a> *notification</code>);</pre>

1324

Sends a notification on behalf of <code>application</code>

1325

to the desktop shell.

1344

execution of the application, as long as <code>id</code>

1345

is the same string.

1346

1347

may be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, but it is impossible to replace or withdraw

1347

may be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, but it is impossible to replace or withdraw

1348

notifications without an id.

1349

If <code>notification</code>

1350

is no longer relevant, it can be withdrawn with

1365

</tr>

1366

<tr>

1367

1368

<td class="parameter_description"> id of the notification, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1368

<td class="parameter_description"> id of the notification, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1369

<td class="parameter_annotations">[<acronym title="NULL is OK, both for passing and for returning.">allow-none</acronym>]</td>

1370

</tr>

1371

<tr>

1383

<a name="g-application-withdraw-notification"></a><h3>g_application_withdraw_notification ()</h3>

1384

<pre class="programlisting">void

1385

g_application_withdraw_notification (<code><a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application</code>,

1386

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *id</code>);</pre>

1386

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *id</code>);</pre>

1387

Withdraws a notification that was sent with

1388

<a class="link" href="GApplication.html#g-application-send-notification" title="g_application_send_notification ()"><code class="function">g_application_send_notification()</code></a>.

1389

This call does nothing if a notification with <code>id</code>

1433

the <code>argc</code>

1434

, <code>argv</code>

1435

parameters from <code class="function">main()</code> to this function, it is possible

1436

to pass <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <code>argv</code>

1436

to pass <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <code>argv</code>

1437

is not available or commandline handling is not

1438

required. Note that on Windows, <code>argc</code>

1439

and <code>argv</code>

1440

are ignored, and

1441

<a href="http://library.gnome.org/devel/glib/unstable/glib-Windows-Compatibility-Functions.html#g-win32-get-command-line"><code class="function">g_win32_get_command_line()</code></a> is called internally (for proper support

1441

<a href="../glib/glib-Windows-Compatibility-Functions.html#g-win32-get-command-line"><code class="function">g_win32_get_command_line()</code></a> is called internally (for proper support

1442

of Unicode commandline arguments).

1443

<a class="link" href="GApplication.html" title="GApplication">GApplication</a> will attempt to parse the commandline arguments. You

1444

can add commandline flags to the list of recognised options by way of

1445

1446

<a class="link" href="GApplication.html#GApplication-handle-local-options" title="The “handle-local-options” signal">“handle-local-options”</a> signal is emitted, from which the

1447

application can inspect the values of its <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionEntry">GOptionEntrys</a>.

1447

application can inspect the values of its <a href="../glib/glib-Commandline-option-parser.html#GOptionEntry">GOptionEntrys</a>.

1448

<a class="link" href="GApplication.html#GApplication-handle-local-options" title="The “handle-local-options” signal">“handle-local-options”</a> is a good place to handle options

1449

such as <code class="literal">--version</code>, where an immediate reply from the local process is

1450

desired (instead of communicating with an already-running instance).

1463

If you are interested in doing more complicated local handling of the

1464

commandline then you should implement your own <a class="link" href="GApplication.html" title="GApplication">GApplication</a> subclass

1465

and override <code class="function">local_command_line()</code>. In this case, you most likely want

1466

to return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> from your <code class="function">local_command_line()</code> implementation to

1466

to return <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> from your <code class="function">local_command_line()</code> implementation to

1467

suppress the default handling. See

1468

gapplication-example-cmdline2.c

1469

for an example.

1477

if the use count falls to zero the application will exit immediately,

1478

except in the case that <a class="link" href="GApplication.html#g-application-set-inactivity-timeout" title="g_application_set_inactivity_timeout ()"><code class="function">g_application_set_inactivity_timeout()</code></a> is in

1479

use.

1480

This function sets the prgname (<a href="http://library.gnome.org/devel/glib/unstable/glib-Miscellaneous-Utility-Functions.html#g-set-prgname"><code class="function">g_set_prgname()</code></a>), if not already set,

1480

This function sets the prgname (<a href="../glib/glib-Miscellaneous-Utility-Functions.html#g-set-prgname"><code class="function">g_set_prgname()</code></a>), if not already set,

1481

to the basename of argv[0]. Since 2.38, if <a class="link" href="GApplication.html#G-APPLICATION-IS-SERVICE:CAPS"><code class="literal">G_APPLICATION_IS_SERVICE</code></a>

1482

is specified, the prgname is set to the application ID. The main

1483

impact of this is is that the wmclass of windows created by Gtk+ will

1516

<tr>

1517

1518

1519

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>)</td>

1519

is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>)</td>

1520

1521

</tr>

1522

<tr>

1523

1524

1524

1525

<td class="parameter_annotations">[<acronym title="Parameter points to an array of items.">array</acronym> length=argc][<acronym title="NULL is OK, both for passing and for returning.">allow-none</acronym>]</td>

1526

</tr>

1527

</tbody>

1539

<a name="g-application-add-main-option-entries"></a><h3>g_application_add_main_option_entries ()</h3>

1540

<pre class="programlisting">void

1541

g_application_add_main_option_entries (<code><a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application</code>,

1542

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionEntry">GOptionEntry</a> *entries</code>);</pre>

1542

<code>const <a href="../glib/glib-Commandline-option-parser.html#GOptionEntry">GOptionEntry</a> *entries</code>);</pre>

1543

Adds main option entries to be handled by <code>application</code>

1544

.

1545

This function is comparable to <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#g-option-context-add-main-entries"><code class="function">g_option_context_add_main_entries()</code></a>.

1545

This function is comparable to <a href="../glib/glib-Commandline-option-parser.html#g-option-context-add-main-entries"><code class="function">g_option_context_add_main_entries()</code></a>.

1546

After the commandline arguments are parsed, the

1547

1548

point, the application can inspect the values pointed to by <code>arg_data</code>

1549

1550

in the given <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionEntry">GOptionEntrys</a>.

1551

Unlike <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionContext">GOptionContext</a>, <a class="link" href="GApplication.html" title="GApplication">GApplication</a> supports giving a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

1550

in the given <a href="../glib/glib-Commandline-option-parser.html#GOptionEntry">GOptionEntrys</a>.

1551

Unlike <a href="../glib/glib-Commandline-option-parser.html#GOptionContext">GOptionContext</a>, <a class="link" href="GApplication.html" title="GApplication">GApplication</a> supports giving a <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

1552

1553

for a non-callback <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionEntry">GOptionEntry</a>. This results in the

1554

argument in question being packed into a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariantDict">GVariantDict</a> which is also

1553

for a non-callback <a href="../glib/glib-Commandline-option-parser.html#GOptionEntry">GOptionEntry</a>. This results in the

1554

argument in question being packed into a <a href="../glib/glib-GVariant.html#GVariantDict">GVariantDict</a> which is also

1555

passed to <a class="link" href="GApplication.html#GApplication-handle-local-options" title="The “handle-local-options” signal">“handle-local-options”</a>, where it can be

1556

inspected and modified. If <a class="link" href="GApplication.html#G-APPLICATION-HANDLES-COMMAND-LINE:CAPS"><code class="literal">G_APPLICATION_HANDLES_COMMAND_LINE</code></a> is

1557

set, then the resulting dictionary is sent to the primary instance,

1559

This "packing" is done according to the type of the argument --

1560

booleans for normal flags, strings for strings, bytestrings for

1561

filenames, etc. The packing only occurs if the flag is given (ie: we

1562

do not pack a "false" <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a> in the case that a flag is missing).

1562

do not pack a "false" <a href="../glib/glib-GVariant.html#GVariant">GVariant</a> in the case that a flag is missing).

1563

In general, it is recommended that all commandline arguments are

1564

parsed locally. The options dictionary should then be used to

1565

transmit the result of the parsing to the primary instance, where

1566

<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#g-variant-dict-lookup"><code class="function">g_variant_dict_lookup()</code></a> can be used. For local options, it is

1566

<a href="../glib/glib-GVariant.html#g-variant-dict-lookup"><code class="function">g_variant_dict_lookup()</code></a> can be used. For local options, it is

1567

possible to either use <code>arg_data</code>

1568

in the usual way, or to consult (and

1569

potentially remove) the option from the options dictionary.

1575

treated as errors. Unrecognised options have never been ignored when

1576

<a class="link" href="GApplication.html#G-APPLICATION-HANDLES-COMMAND-LINE:CAPS"><code class="literal">G_APPLICATION_HANDLES_COMMAND_LINE</code></a> is unset.

1577

If <a class="link" href="GApplication.html#GApplication-handle-local-options" title="The “handle-local-options” signal">“handle-local-options”</a> needs to see the list of

1578

filenames, then the use of <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#G-OPTION-REMAINING:CAPS"><code class="literal">G_OPTION_REMAINING</code></a> is recommended. If

1578

filenames, then the use of <a href="../glib/glib-Commandline-option-parser.html#G-OPTION-REMAINING:CAPS"><code class="literal">G_OPTION_REMAINING</code></a> is recommended. If

1579

1580

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#G-OPTION-REMAINING:CAPS"><code class="literal">G_OPTION_REMAINING</code></a> can be used as a key into

1581

the options dictionary. If you do use <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#G-OPTION-REMAINING:CAPS"><code class="literal">G_OPTION_REMAINING</code></a> then you

1580

is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then <a href="../glib/glib-Commandline-option-parser.html#G-OPTION-REMAINING:CAPS"><code class="literal">G_OPTION_REMAINING</code></a> can be used as a key into

1581

the options dictionary. If you do use <a href="../glib/glib-Commandline-option-parser.html#G-OPTION-REMAINING:CAPS"><code class="literal">G_OPTION_REMAINING</code></a> then you

1582

need to handle these arguments for yourself because once they are

1583

consumed, they will no longer be visible to the default handling

1584

(which treats them as filenames to be opened).

1599

<tr>

1600

<td class="parameter_name">entries</td>

1601

<td class="parameter_description">(array zero-terminated=1) (element-type GOptionEntry) a

1602

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated list of <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionEntry">GOptionEntrys</a></td>

1602

<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated list of <a href="../glib/glib-Commandline-option-parser.html#GOptionEntry">GOptionEntrys</a></td>

1603

1604

</tr>

1605

</tbody>

1614

g_application_add_main_option (<code><a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application</code>,

1615

<code>const char *long_name</code>,

1616

<code>char short_name</code>,

1617

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> flags</code>,

1618

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionArg">GOptionArg</a> arg</code>,

1617

<code><a href="../glib/glib-Commandline-option-parser.html#GOptionFlags">GOptionFlags</a> flags</code>,

1618

<code><a href="../glib/glib-Commandline-option-parser.html#GOptionArg">GOptionArg</a> arg</code>,

1619

<code>const char *description</code>,

1620

<code>const char *arg_description</code>);</pre>

1621

Add an option to be handled by <code>application</code>

1622

.

1623

Calling this function is the equivalent of calling

1624

<a class="link" href="GApplication.html#g-application-add-main-option-entries" title="g_application_add_main_option_entries ()"><code class="function">g_application_add_main_option_entries()</code></a> with a single <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionEntry">GOptionEntry</a>

1625

that has its arg_data member set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

1626

The parsed arguments will be packed into a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariantDict">GVariantDict</a> which

1624

<a class="link" href="GApplication.html#g-application-add-main-option-entries" title="g_application_add_main_option_entries ()"><code class="function">g_application_add_main_option_entries()</code></a> with a single <a href="../glib/glib-Commandline-option-parser.html#GOptionEntry">GOptionEntry</a>

1625

that has its arg_data member set to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

1626

The parsed arguments will be packed into a <a href="../glib/glib-GVariant.html#GVariantDict">GVariantDict</a> which

1627

is passed to <a class="link" href="GApplication.html#GApplication-handle-local-options" title="The “handle-local-options” signal">“handle-local-options”</a>. If

1628

<a class="link" href="GApplication.html#G-APPLICATION-HANDLES-COMMAND-LINE:CAPS"><code class="literal">G_APPLICATION_HANDLES_COMMAND_LINE</code></a> is set, then it will also

1629

be sent to the primary instance. See

1630

1631

See <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionEntry">GOptionEntry</a> for more documentation of the arguments.

1631

See <a href="../glib/glib-Commandline-option-parser.html#GOptionEntry">GOptionEntry</a> for more documentation of the arguments.

1632

1633

<a name="id-1.4.22.2.11.27.8"></a><h4>Parameters</h4>

1634

1655

</tr>

1656

<tr>

1657

<td class="parameter_name">flags</td>

1658

<td class="parameter_description">flags from <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionFlags">GOptionFlags</a></td>

1658

<td class="parameter_description">flags from <a href="../glib/glib-Commandline-option-parser.html#GOptionFlags">GOptionFlags</a></td>

1659

1660

</tr>

1661

<tr>

1662

1663

<td class="parameter_description">the type of the option, as a <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionArg">GOptionArg</a></td>

1663

<td class="parameter_description">the type of the option, as a <a href="../glib/glib-Commandline-option-parser.html#GOptionArg">GOptionArg</a></td>

1664

1665

</tr>

1666

<tr>

1684

<a name="g-application-add-option-group"></a><h3>g_application_add_option_group ()</h3>

1685

<pre class="programlisting">void

1686

g_application_add_option_group (<code><a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application</code>,

1687

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup">GOptionGroup</a> *group</code>);</pre>

1688

Adds a <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup">GOptionGroup</a> to the commandline handling of <code>application</code>

1687

<code><a href="../glib/glib-Commandline-option-parser.html#GOptionGroup">GOptionGroup</a> *group</code>);</pre>

1688

Adds a <a href="../glib/glib-Commandline-option-parser.html#GOptionGroup">GOptionGroup</a> to the commandline handling of <code>application</code>

1689

.

1690

This function is comparable to <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#g-option-context-add-group"><code class="function">g_option_context_add_group()</code></a>.

1690

This function is comparable to <a href="../glib/glib-Commandline-option-parser.html#g-option-context-add-group"><code class="function">g_option_context_add_group()</code></a>.

1691

Unlike <a class="link" href="GApplication.html#g-application-add-main-option-entries" title="g_application_add_main_option_entries ()"><code class="function">g_application_add_main_option_entries()</code></a>, this function does

1692

not deal with <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> <code>arg_data</code>

1692

not deal with <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> <code>arg_data</code>

1693

and never transmits options to the

1694

primary instance.

1695

The reason for that is because, by the time the options arrive at the

1699

In the case that this is not the first-running instance of the

1700

application, the existing instance may already have been running for

1701

a very long time.

1702

This means that the options from <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup">GOptionGroup</a> are only really usable

1702

This means that the options from <a href="../glib/glib-Commandline-option-parser.html#GOptionGroup">GOptionGroup</a> are only really usable

1703

in the case that the instance of the application being run is the

1704

first instance. Passing options like <code class="literal">--display=</code> or <code class="literal">--gdk-debug=</code>

1705

on future runs will have no effect on the existing primary instance.

1723

</tr>

1724

<tr>

1725

<td class="parameter_name">group</td>

1726

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup">GOptionGroup</a></td>

1726

<td class="parameter_description">a <a href="../glib/glib-Commandline-option-parser.html#GOptionGroup">GOptionGroup</a></td>

1727

1728

</tr>

1729

</tbody>

1742

. If

1743

<code>application</code>

1744

is destroyed then the default application will revert

1745

back to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

1745

back to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

1746

1747

<a name="id-1.4.22.2.11.29.6"></a><h4>Parameters</h4>

1748

1753

</colgroup>

1754

1755

<td class="parameter_name">application</td>

1756

<td class="parameter_description"> the application to set as default, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1756

<td class="parameter_description"> the application to set as default, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1757

<td class="parameter_annotations">[<acronym title="NULL is OK, both for passing and for returning.">allow-none</acronym>]</td>

1758

</tr></tbody>

1759

</table></div>

1769

Normally there is only one <a class="link" href="GApplication.html" title="GApplication">GApplication</a> per process and it becomes

1770

the default when it is created. You can exercise more control over

1771

this by using <a class="link" href="GApplication.html#g-application-set-default" title="g_application_set_default ()"><code class="function">g_application_set_default()</code></a>.

1772

If there is no default application then <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned.

1772

If there is no default application then <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned.

1773

1774

<a name="id-1.4.22.2.11.30.7"></a><h4>Returns</h4>

1775

the default application for this process, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

1775

the default application for this process, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

1776

[<acronym title="Don't free data after the code is done.">transfer none</acronym>]

1777

</div>

1778

Since 2.32

1995

bus, that need to exist before the application tries to own the bus name.

1996

The function is passed the <a class="link" href="GDBusConnection.html" title="GDBusConnection">GDBusConnection</a> to to session bus, and the

1997

object path that <a class="link" href="GApplication.html" title="GApplication">GApplication</a> will use to export is D-Bus API.

1998

If this function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, registration will proceed; otherwise

1998

If this function returns <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, registration will proceed; otherwise

1999

registration will abort. Since: 2.34</td>

2000

2001

</tr>

2118

<hr>

2119

2120

<a name="GApplication--application-id"></a><h3>The <code class="literal">“application-id”</code> property</h3>

2121

<pre class="programlisting"> “application-id” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *</pre>

2121

<pre class="programlisting"> “application-id” <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *</pre>

2122

The unique identifier for the application.

2123

Flags: Read / Write / Construct

2124

Default value: NULL

2133

<hr>

2134

2135

<a name="GApplication--inactivity-timeout"></a><h3>The <code class="literal">“inactivity-timeout”</code> property</h3>

2136

<pre class="programlisting"> “inactivity-timeout” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a></pre>

2136

<pre class="programlisting"> “inactivity-timeout” <a href="../glib/glib-Basic-Types.html#guint">guint</a></pre>

2137

Time (ms) to stay alive after becoming idle.

2138

Flags: Read / Write

2139

Default value: 0

2141

<hr>

2142

2143

<a name="GApplication--is-registered"></a><h3>The <code class="literal">“is-registered”</code> property</h3>

2144

<pre class="programlisting"> “is-registered” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a></pre>

2144

<pre class="programlisting"> “is-registered” <a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a></pre>

2145

If g_application_register() has been called.

2146

Flags: Read

2147

Default value: FALSE

2149

<hr>

2150

2151

<a name="GApplication--is-remote"></a><h3>The <code class="literal">“is-remote”</code> property</h3>

2152

<pre class="programlisting"> “is-remote” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a></pre>

2152

<pre class="programlisting"> “is-remote” <a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a></pre>

2153

If this application instance is remote.

2154

Flags: Read

2155

Default value: FALSE

2157

<hr>

2158

2159

<a name="GApplication--resource-base-path"></a><h3>The <code class="literal">“resource-base-path”</code> property</h3>

2160

<pre class="programlisting"> “resource-base-path” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *</pre>

2160

<pre class="programlisting"> “resource-base-path” <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *</pre>

2161

The base resource path for the application.

2162

Flags: Read / Write

2163

Default value: NULL

2169

<a name="GApplication-activate"></a><h3>The <code class="literal">“activate”</code> signal</h3>

2170

<pre class="programlisting">void

2171

user_function (<a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application,

2172

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data)</pre>

2172

<a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data)</pre>

2173

The ::activate signal is emitted on the primary instance when an

2174

activation occurs. See <a class="link" href="GApplication.html#g-application-activate" title="g_application_activate ()"><code class="function">g_application_activate()</code></a>.

2175

2199

<hr>

2200

2201

<a name="GApplication-command-line"></a><h3>The <code class="literal">“command-line”</code> signal</h3>

2202

2202

2203

user_function (<a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application,

2204

<a class="link" href="GApplicationCommandLine.html" title="GApplicationCommandLine">GApplicationCommandLine</a> *command_line,

2205

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data)</pre>

2205

<a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data)</pre>

2206

The ::command-line signal is emitted on the primary instance when

2207

a commandline is not handled locally. See <a class="link" href="GApplication.html#g-application-run" title="g_application_run ()"><code class="function">g_application_run()</code></a> and

2208

the <a class="link" href="GApplicationCommandLine.html" title="GApplicationCommandLine">GApplicationCommandLine</a> documentation for more information.

2245

<hr>

2246

2247

<a name="GApplication-handle-local-options"></a><h3>The <code class="literal">“handle-local-options”</code> signal</h3>

2248

2248

2249

user_function (<a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application,

2250

<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariantDict">GVariantDict</a> *options,

2251

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data)</pre>

2250

<a href="../glib/glib-GVariant.html#GVariantDict">GVariantDict</a> *options,

2251

<a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data)</pre>

2252

The ::handle-local-options signal is emitted on the local instance

2253

after the parsing of the commandline options has occurred.

2254

You can add options to be recognised during commandline option

2257

Signal handlers can inspect <code>options</code>

2258

(along with values pointed to

2259

from the <code>arg_data</code>

2260

of an installed <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionEntry">GOptionEntrys</a>) in order to

2260

of an installed <a href="../glib/glib-Commandline-option-parser.html#GOptionEntry">GOptionEntrys</a>) in order to

2261

decide to perform certain actions, including direct local handling

2262

(which may be useful for options like --version).

2263

If the options have been "handled" then a non-negative value should

2264

be returned. In this case, the return value is the exit status: 0

2265

for success and a positive value for failure. -1 means to continue

2266

normal processing.

2267

2263

In the event that the application is marked

2268

2264

<a class="link" href="GApplication.html#G-APPLICATION-HANDLES-COMMAND-LINE:CAPS"><code class="literal">G_APPLICATION_HANDLES_COMMAND_LINE</code></a> the "normal processing" will

2269

2265

send the <code>option</code>

2291

2287

capabilities than what is provided here, but this should not

2292

2288

normally be required.

2293

2289

2294

<a name="id-1.4.22.2.14.4.13"></a><h4>Parameters</h4>

2290

<a name="id-1.4.22.2.14.4.12"></a><h4>Parameters</h4>

2295

2291

2296

2292

2297

2293

2317

2313

</tbody>

2318

2314

</table></div>

2319

2315

</div>

2316

2317

<a name="id-1.4.22.2.14.4.13"></a><h4>Returns</h4>

2318

an exit code. If you have handled your options and want

2319

to exit the process, return a non-negative option, 0 for success,

2320

and a positive value for failure. To continue, return -1 to let

2321

the default option processing continue.

2322

2323

</div>

2320

2324

Flags: Run Last

2321

2325

Since 2.40

2322

2326

</div>

2325

2329

<a name="GApplication-open"></a><h3>The <code class="literal">“open”</code> signal</h3>

2326

2330

<pre class="programlisting">void

2327

2331

user_function (<a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application,

2328

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> files,

2329

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> n_files,

2330

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *hint,

2331

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data)</pre>

2332

<a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> files,

2333

<a href="../glib/glib-Basic-Types.html#gint">gint</a> n_files,

2334

<a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *hint,

2335

<a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data)</pre>

2332

2336

The ::open signal is emitted on the primary instance when there are

2333

2337

files to open. See <a class="link" href="GApplication.html#g-application-open" title="g_application_open ()"><code class="function">g_application_open()</code></a> for more information.

2334

2338

2376

2380

<a name="GApplication-shutdown"></a><h3>The <code class="literal">“shutdown”</code> signal</h3>

2377

2381

<pre class="programlisting">void

2378

2382

user_function (<a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application,

2379

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data)</pre>

2383

<a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data)</pre>

2380

2384

The ::shutdown signal is emitted only on the registered primary instance

2381

2385

immediately after the main loop terminates.

2382

2386

2408

2412

<a name="GApplication-startup"></a><h3>The <code class="literal">“startup”</code> signal</h3>

2409

2413

<pre class="programlisting">void

2410

2414

user_function (<a class="link" href="GApplication.html" title="GApplication">GApplication</a> *application,

2411

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data)</pre>

2415

<a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data)</pre>

2412

2416

The ::startup signal is emitted on the primary instance immediately

2413

2417

after registration. See <a class="link" href="GApplication.html#g-application-register" title="g_application_register ()"><code class="function">g_application_register()</code></a>.

2414

2418

Older »