docs/reference/gio/html/gio-GActionGroup-exporter.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GActionGroup exporter</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GIO Reference Manual">
   8 <link rel="up" href="application.html" title="Application support">
   9 <link rel="prev" href="GRemoteActionGroup.html" title="GRemoteActionGroup">
  10 <link rel="next" href="GDBusActionGroup.html" title="GDBusActionGroup">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="GRemoteActionGroup.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="application.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GIO Reference Manual</th>
  21 <td><a accesskey="n" href="GDBusActionGroup.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gio-GActionGroup-exporter.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gio-GActionGroup-exporter.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gio-GActionGroup-exporter"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gio-GActionGroup-exporter.top_of_page"></a>GActionGroup exporter</span></h2>
  34 <p>GActionGroup exporter — Export GActionGroups on D-Bus</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gio-GActionGroup-exporter.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis"><a href="./../glib/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gio-GActionGroup-exporter.html#g-dbus-connection-export-action-group" title="g_dbus_connection_export_action_group ()">g_dbus_connection_export_action_group</a>
  41                                                         (<em class="parameter"><code><a class="link" href="GDBusConnection.html" title="GDBusConnection"><span class="type">GDBusConnection</span></a> *connection</code></em>,
  42                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
  43                                                          <em class="parameter"><code><a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> *action_group</code></em>,
  44                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  45 <span class="returnvalue">void</span>                <a class="link" href="gio-GActionGroup-exporter.html#g-dbus-connection-unexport-action-group" title="g_dbus_connection_unexport_action_group ()">g_dbus_connection_unexport_action_group</a>
  46                                                         (<em class="parameter"><code><a class="link" href="GDBusConnection.html" title="GDBusConnection"><span class="type">GDBusConnection</span></a> *connection</code></em>,
  47                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> export_id</code></em>);
  48 </pre>
  49 </div>
  50 <div class="refsect1">
  51 <a name="gio-GActionGroup-exporter.description"></a><h2>Description</h2>
  52 <p>
  53 These functions support exporting a <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> on D-Bus.
  54 The D-Bus interface that is used is a private implementation
  55 detail.
  56 </p>
  57 <p>
  58 To access an exported <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> remotely, use
  59 <a class="link" href="GDBusActionGroup.html#g-dbus-action-group-get" title="g_dbus_action_group_get ()"><code class="function">g_dbus_action_group_get()</code></a> to obtain a <a class="link" href="GDBusActionGroup.html" title="GDBusActionGroup"><span class="type">GDBusActionGroup</span></a>.
  60 </p>
  61 </div>
  62 <div class="refsect1">
  63 <a name="gio-GActionGroup-exporter.details"></a><h2>Details</h2>
  64 <div class="refsect2">
  65 <a name="g-dbus-connection-export-action-group"></a><h3>g_dbus_connection_export_action_group ()</h3>
  66 <pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               g_dbus_connection_export_action_group
  67                                                         (<em class="parameter"><code><a class="link" href="GDBusConnection.html" title="GDBusConnection"><span class="type">GDBusConnection</span></a> *connection</code></em>,
  68                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
  69                                                          <em class="parameter"><code><a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> *action_group</code></em>,
  70                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
  71 <p>
  72 Exports <em class="parameter"><code>action_group</code></em> on <em class="parameter"><code>connection</code></em> at <em class="parameter"><code>object_path</code></em>.
  73 </p>
  74 <p>
  75 The implemented D-Bus API should be considered private.  It is
  76 subject to change in the future.
  77 </p>
  78 <p>
  79 A given object path can only have one action group exported on it.
  80 If this constraint is violated, the export will fail and 0 will be
  81 returned (with <em class="parameter"><code>error</code></em> set accordingly).
  82 </p>
  83 <p>
  84 You can unexport the action group using
  85 <a class="link" href="gio-GActionGroup-exporter.html#g-dbus-connection-unexport-action-group" title="g_dbus_connection_unexport_action_group ()"><code class="function">g_dbus_connection_unexport_action_group()</code></a> with the return value of
  86 this function.
  87 </p>
  88 <p>
  89 The thread default main context is taken at the time of this call.
  90 All incoming action activations and state change requests are
  91 reported from this context.  Any changes on the action group that
  92 cause it to emit signals must also come from this same context.
  93 Since incoming action activations and state change requests are
  94 rather likely to cause changes on the action group, this effectively
  95 limits a given action group to being exported from only one main
  96 context.
  97 </p>
  98 <div class="variablelist"><table border="0">
  99 <col align="left" valign="top">
 100 <tbody>
 101 <tr>
 102 <td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
 103 <td>a <a class="link" href="GDBusConnection.html" title="GDBusConnection"><span class="type">GDBusConnection</span></a>
 104 </td>
 105 </tr>
 106 <tr>
 107 <td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
 108 <td>a D-Bus object path</td>
 109 </tr>
 110 <tr>
 111 <td><p><span class="term"><em class="parameter"><code>action_group</code></em> :</span></p></td>
 112 <td>a <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a>
 113 </td>
 114 </tr>
 115 <tr>
 116 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 117 <td>a pointer to a <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> <a href="./../glib/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 118 </td>
 119 </tr>
 120 <tr>
 121 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 122 <td>the ID of the export (never zero), or 0 in case of failure</td>
 123 </tr>
 124 </tbody>
 125 </table></div>
 126 <p class="since">Since 2.32</p>
 127 </div>
 128 <hr>
 129 <div class="refsect2">
 130 <a name="g-dbus-connection-unexport-action-group"></a><h3>g_dbus_connection_unexport_action_group ()</h3>
 131 <pre class="programlisting"><span class="returnvalue">void</span>                g_dbus_connection_unexport_action_group
 132                                                         (<em class="parameter"><code><a class="link" href="GDBusConnection.html" title="GDBusConnection"><span class="type">GDBusConnection</span></a> *connection</code></em>,
 133                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> export_id</code></em>);</pre>
 134 <p>
 135 Reverses the effect of a previous call to
 136 <a class="link" href="gio-GActionGroup-exporter.html#g-dbus-connection-export-action-group" title="g_dbus_connection_export_action_group ()"><code class="function">g_dbus_connection_export_action_group()</code></a>.
 137 </p>
 138 <p>
 139 It is an error to call this function with an ID that wasn't returned
 140 from <a class="link" href="gio-GActionGroup-exporter.html#g-dbus-connection-export-action-group" title="g_dbus_connection_export_action_group ()"><code class="function">g_dbus_connection_export_action_group()</code></a> or to call it with the
 141 same ID more than once.
 142 </p>
 143 <div class="variablelist"><table border="0">
 144 <col align="left" valign="top">
 145 <tbody>
 146 <tr>
 147 <td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
 148 <td>a <a class="link" href="GDBusConnection.html" title="GDBusConnection"><span class="type">GDBusConnection</span></a>
 149 </td>
 150 </tr>
 151 <tr>
 152 <td><p><span class="term"><em class="parameter"><code>export_id</code></em> :</span></p></td>
 153 <td>the ID from <a class="link" href="gio-GActionGroup-exporter.html#g-dbus-connection-export-action-group" title="g_dbus_connection_export_action_group ()"><code class="function">g_dbus_connection_export_action_group()</code></a>
 154 </td>
 155 </tr>
 156 </tbody>
 157 </table></div>
 158 <p class="since">Since 2.32</p>
 159 </div>
 160 </div>
 161 <div class="refsect1">
 162 <a name="gio-GActionGroup-exporter.see-also"></a><h2>See Also</h2>
 163 <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a>, <a class="link" href="GDBusActionGroup.html" title="GDBusActionGroup"><span class="type">GDBusActionGroup</span></a>
 164 </div>
 165 </div>
 166 <div class="footer">
 167 <hr>
 168           Generated by GTK-Doc V1.18</div>
 169 </body>
 170 </html>