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

« back to all changes in this revision

Viewing changes to docs/reference/gio/html/GActionMap.html

  • Committer: Package Import Robot
  • Author(s): Iain Lane
  • Date: 2014-09-23 10:12:15 UTC
  • mfrom: (1.66.20)
  • Revision ID: package-import@ubuntu.com-20140923101215-3vlqvooralbmzq8t
Tags: 2.42.0-1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
102
102
</div>
103
103
<div class="refsect1">
104
104
<a name="GActionMap.object-hierarchy"></a><h2>Object Hierarchy</h2>
105
 
<pre class="screen">    GInterface
 
105
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
106
106
    <span class="lineart">╰──</span> GActionMap
107
107
</pre>
108
108
</div>
110
110
<a name="GActionMap.prerequisites"></a><h2>Prerequisites</h2>
111
111
<p>
112
112
GActionMap requires
113
 
 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
 
113
 <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
114
114
</div>
115
115
<div class="refsect1">
116
116
<a name="GActionMap.implementations"></a><h2>Known Implementations</h2>
140
140
<a name="g-action-map-lookup-action"></a><h3>g_action_map_lookup_action ()</h3>
141
141
<pre class="programlisting"><a class="link" href="GAction.html" title="GAction"><span class="returnvalue">GAction</span></a> *
142
142
g_action_map_lookup_action (<em class="parameter"><code><a class="link" href="GActionMap.html" title="GActionMap"><span class="type">GActionMap</span></a> *action_map</code></em>,
143
 
                            <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>);</pre>
 
143
                            <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>);</pre>
144
144
<p>Looks up the action with the name <em class="parameter"><code>action_name</code></em>
145
145
 in <em class="parameter"><code>action_map</code></em>
146
146
.</p>
147
 
<p>If no such action exists, returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
 
147
<p>If no such action exists, returns <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
148
148
<div class="refsect3">
149
149
<a name="id-1.4.22.5.10.2.6"></a><h4>Parameters</h4>
150
150
<div class="informaltable"><table width="100%" border="0">
169
169
</div>
170
170
<div class="refsect3">
171
171
<a name="id-1.4.22.5.10.2.7"></a><h4>Returns</h4>
172
 
<p> a <a class="link" href="GAction.html" title="GAction"><span class="type">GAction</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
 
172
<p> a <a class="link" href="GAction.html" title="GAction"><span class="type">GAction</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
173
173
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
174
174
</div>
175
175
<p class="since">Since 2.32</p>
180
180
<pre class="programlisting"><span class="returnvalue">void</span>
181
181
g_action_map_add_action_entries (<em class="parameter"><code><a class="link" href="GActionMap.html" title="GActionMap"><span class="type">GActionMap</span></a> *action_map</code></em>,
182
182
                                 <em class="parameter"><code>const <a class="link" href="GActionMap.html#GActionEntry" title="struct GActionEntry"><span class="type">GActionEntry</span></a> *entries</code></em>,
183
 
                                 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_entries</code></em>,
184
 
                                 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
 
183
                                 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_entries</code></em>,
 
184
                                 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
185
185
<p>A convenience function for creating multiple <a class="link" href="GSimpleAction.html" title="GSimpleAction"><span class="type">GSimpleAction</span></a> instances
186
186
and adding them to a <a class="link" href="GActionMap.html" title="GActionMap"><span class="type">GActionMap</span></a>.</p>
187
187
<p>Each action is constructed as per one <a class="link" href="GActionMap.html#GActionEntry" title="struct GActionEntry"><span class="type">GActionEntry</span></a>.</p>
219
219
28
220
220
29
221
221
30</pre></td>
222
 
        <td class="listing_code"><pre class="programlisting"><span class="keyword">static</span><span class="normal"> </span><span class="type">void</span>
223
 
<span class="function">activate_quit</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">GSimpleAction</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">simple</span><span class="symbol">,</span>
224
 
<span class="normal">               </span><span class="usertype">GVariant</span><span class="normal">      </span><span class="symbol">*</span><span class="normal">parameter</span><span class="symbol">,</span>
225
 
<span class="normal">               </span><span class="usertype">gpointer</span><span class="normal">       user_data</span><span class="symbol">)</span>
226
 
<span class="cbracket">{</span>
227
 
<span class="normal">  </span><span class="function">exit</span><span class="normal"> </span><span class="symbol">(</span><span class="number">0</span><span class="symbol">);</span>
228
 
<span class="cbracket">}</span>
229
 
 
230
 
<span class="keyword">static</span><span class="normal"> </span><span class="type">void</span>
231
 
<span class="function">activate_print_string</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">GSimpleAction</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">simple</span><span class="symbol">,</span>
232
 
<span class="normal">                       </span><span class="usertype">GVariant</span><span class="normal">      </span><span class="symbol">*</span><span class="normal">parameter</span><span class="symbol">,</span>
233
 
<span class="normal">                       </span><span class="usertype">gpointer</span><span class="normal">       user_data</span><span class="symbol">)</span>
234
 
<span class="cbracket">{</span>
235
 
<span class="normal">  </span><span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-Warnings-and-Assertions.html#g-print">g_print</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"%s</span><span class="specialchar">\n</span><span class="string">"</span><span class="symbol">,</span><span class="normal"> </span><span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#g-variant-get-string">g_variant_get_string</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">parameter</span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">));</span>
236
 
<span class="cbracket">}</span>
237
 
 
238
 
<span class="keyword">static</span><span class="normal"> <a href="GActionGroup.html">GActionGroup</a> </span><span class="symbol">*</span>
239
 
<span class="function">create_action_group</span><span class="normal"> </span><span class="symbol">(</span><span class="type">void</span><span class="symbol">)</span>
240
 
<span class="cbracket">{</span>
241
 
<span class="normal">  </span><span class="keyword">const</span><span class="normal"> </span><span class="usertype">GActionEntry</span><span class="normal"> entries</span><span class="symbol">[]</span><span class="normal"> </span><span class="symbol">=</span><span class="normal"> </span><span class="cbracket">{</span>
242
 
<span class="normal">    </span><span class="cbracket">{</span><span class="normal"> </span><span class="string">"quit"</span><span class="symbol">,</span><span class="normal">         activate_quit              </span><span class="cbracket">}</span><span class="symbol">,</span>
243
 
<span class="normal">    </span><span class="cbracket">{</span><span class="normal"> </span><span class="string">"print-string"</span><span class="symbol">,</span><span class="normal"> activate_print_string</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"s"</span><span class="normal"> </span><span class="cbracket">}</span>
244
 
<span class="normal">  </span><span class="cbracket">}</span><span class="symbol">;</span>
245
 
<span class="normal">  </span><span class="usertype">GSimpleActionGroup</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">group</span><span class="symbol">;</span>
246
 
 
247
 
<span class="normal">  group </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GSimpleActionGroup.html#g-simple-action-group-new">g_simple_action_group_new</a></span><span class="normal"> </span><span class="symbol">();</span>
248
 
<span class="normal">  </span><span class="function"><a href="GActionMap.html#g-action-map-add-action-entries">g_action_map_add_action_entries</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">G_ACTION_MAP</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">group</span><span class="symbol">),</span><span class="normal"> entries</span><span class="symbol">,</span><span class="normal"> </span><span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#G-N-ELEMENTS:CAPS">G_N_ELEMENTS</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">entries</span><span class="symbol">),</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
249
 
 
250
 
<span class="normal">  </span><span class="keyword">return</span><span class="normal"> </span><span class="function">G_ACTION_GROUP</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">group</span><span class="symbol">);</span>
251
 
<span class="cbracket">}</span></pre></td>
 
222
        <td class="listing_code"><pre class="programlisting"><span class="gtkdoc kwb">static void</span>
 
223
<span class="function">activate_quit</span> <span class="gtkdoc opt">(</span>GSimpleAction <span class="gtkdoc opt">*</span>simple<span class="gtkdoc opt">,</span>
 
224
               GVariant      <span class="gtkdoc opt">*</span>parameter<span class="gtkdoc opt">,</span>
 
225
               gpointer       user_data<span class="gtkdoc opt">)</span>
 
226
<span class="gtkdoc opt">{</span>
 
227
  <span class="function">exit</span> <span class="gtkdoc opt">(</span><span class="number">0</span><span class="gtkdoc opt">);</span>
 
228
<span class="gtkdoc opt">}</span>
 
229
 
 
230
<span class="gtkdoc kwb">static void</span>
 
231
<span class="function">activate_print_string</span> <span class="gtkdoc opt">(</span>GSimpleAction <span class="gtkdoc opt">*</span>simple<span class="gtkdoc opt">,</span>
 
232
                       GVariant      <span class="gtkdoc opt">*</span>parameter<span class="gtkdoc opt">,</span>
 
233
                       gpointer       user_data<span class="gtkdoc opt">)</span>
 
234
<span class="gtkdoc opt">{</span>
 
235
  <span class="function"><a href="../glib/glib-Warnings-and-Assertions.html#g-print">g_print</a></span> <span class="gtkdoc opt">(</span><span class="string">&quot;%s</span><span class="gtkdoc esc">\n</span><span class="string">&quot;</span><span class="gtkdoc opt">,</span> <span class="function"><a href="../glib/glib-GVariant.html#g-variant-get-string">g_variant_get_string</a></span> <span class="gtkdoc opt">(</span>parameter<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">));</span>
 
236
<span class="gtkdoc opt">}</span>
 
237
 
 
238
<span class="gtkdoc kwb">static</span> GActionGroup <span class="gtkdoc opt">*</span>
 
239
<span class="function">create_action_group</span> <span class="gtkdoc opt">(</span><span class="gtkdoc kwb">void</span><span class="gtkdoc opt">)</span>
 
240
<span class="gtkdoc opt">{</span>
 
241
  <span class="gtkdoc kwb">const</span> GActionEntry entries<span class="gtkdoc opt">[] = {</span>
 
242
    <span class="gtkdoc opt">{</span> <span class="string">&quot;quit&quot;</span><span class="gtkdoc opt">,</span>         activate_quit              <span class="gtkdoc opt">},</span>
 
243
    <span class="gtkdoc opt">{</span> <span class="string">&quot;print-string&quot;</span><span class="gtkdoc opt">,</span> activate_print_string<span class="gtkdoc opt">,</span> <span class="string">&quot;s&quot;</span> <span class="gtkdoc opt">}</span>
 
244
  <span class="gtkdoc opt">};</span>
 
245
  GSimpleActionGroup <span class="gtkdoc opt">*</span>group<span class="gtkdoc opt">;</span>
 
246
 
 
247
  group <span class="gtkdoc opt">=</span> <span class="function"><a href="GSimpleActionGroup.html#g-simple-action-group-new">g_simple_action_group_new</a></span> <span class="gtkdoc opt">();</span>
 
248
  <span class="function"><a href="GActionMap.html#g-action-map-add-action-entries">g_action_map_add_action_entries</a></span> <span class="gtkdoc opt">(</span><span class="function">G_ACTION_MAP</span> <span class="gtkdoc opt">(</span>group<span class="gtkdoc opt">),</span> entries<span class="gtkdoc opt">,</span> <span class="function"><a href="../glib/glib-Standard-Macros.html#G-N-ELEMENTS:CAPS">G_N_ELEMENTS</a></span> <span class="gtkdoc opt">(</span>entries<span class="gtkdoc opt">),</span> NULL<span class="gtkdoc opt">);</span>
 
249
 
 
250
  <span class="keyword">return</span> <span class="function">G_ACTION_GROUP</span> <span class="gtkdoc opt">(</span>group<span class="gtkdoc opt">);</span>
 
251
<span class="gtkdoc opt">}</span></pre></td>
252
252
      </tr>
253
253
    </tbody>
254
254
  </table>
279
279
<td class="parameter_name"><p>n_entries</p></td>
280
280
<td class="parameter_description"><p>the length of <em class="parameter"><code>entries</code></em>
281
281
, or -1 if <em class="parameter"><code>entries</code></em>
282
 
is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated</p></td>
 
282
is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated</p></td>
283
283
<td class="parameter_annotations"> </td>
284
284
</tr>
285
285
<tr>
334
334
<a name="g-action-map-remove-action"></a><h3>g_action_map_remove_action ()</h3>
335
335
<pre class="programlisting"><span class="returnvalue">void</span>
336
336
g_action_map_remove_action (<em class="parameter"><code><a class="link" href="GActionMap.html" title="GActionMap"><span class="type">GActionMap</span></a> *action_map</code></em>,
337
 
                            <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>);</pre>
 
337
                            <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>);</pre>
338
338
<p>Removes the named action from the action map.</p>
339
339
<p>If no action of this name is in the map then nothing happens.</p>
340
340
<div class="refsect3">
393
393
</colgroup>
394
394
<tbody>
395
395
<tr>
396
 
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GActionMapInterface.g-iface"></a>g_iface</code></em>;</p></td>
 
396
<td class="struct_member_name"><p><a href="../gobject/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GActionMapInterface.g-iface"></a>g_iface</code></em>;</p></td>
397
397
<td> </td>
398
398
<td> </td>
399
399
</tr>
440
440
<a class="link" href="GActionMap.html#g-action-map-add-action-entries" title="g_action_map_add_action_entries ()"><code class="function">g_action_map_add_action_entries()</code></a>.</p>
441
441
<p>The order of the items in the structure are intended to reflect
442
442
frequency of use.  It is permissible to use an incomplete initialiser
443
 
in order to leave some of the later values as <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.  All values
 
443
in order to leave some of the later values as <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.  All values
444
444
after <em class="parameter"><code>name</code></em>
445
445
 are optional.  Additional optional fields may be added in
446
446
the future.</p>
455
455
</colgroup>
456
456
<tbody>
457
457
<tr>
458
 
<td class="struct_member_name"><p>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GActionEntry.name"></a>name</code></em>;</p></td>
 
458
<td class="struct_member_name"><p>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GActionEntry.name"></a>name</code></em>;</p></td>
459
459
<td class="struct_member_description"><p>the name of the action</p></td>
460
460
<td class="struct_member_annotations"> </td>
461
461
</tr>
462
462
<tr>
463
463
<td class="struct_member_name"><p><em class="structfield"><code><a name="GActionEntry.activate"></a>activate</code></em> ()</p></td>
464
464
<td class="struct_member_description"><p>the callback to connect to the "activate" signal of the
465
 
action.  Since GLib 2.40, this can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for stateful
 
465
action.  Since GLib 2.40, this can be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for stateful
466
466
actions, in which case the default handler is used.  For
467
467
boolean-stated actions with no parameter, this is a
468
468
toggle.  For other state types (and parameter type equal
472
472
<td class="struct_member_annotations"> </td>
473
473
</tr>
474
474
<tr>
475
 
<td class="struct_member_name"><p>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GActionEntry.parameter-type"></a>parameter_type</code></em>;</p></td>
 
475
<td class="struct_member_name"><p>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GActionEntry.parameter-type"></a>parameter_type</code></em>;</p></td>
476
476
<td class="struct_member_description"><p>the type of the parameter that must be passed to the
477
477
activate function for this action, given as a single
478
 
GVariant type string (or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for no parameter)</p></td>
 
478
GVariant type string (or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for no parameter)</p></td>
479
479
<td class="struct_member_annotations"> </td>
480
480
</tr>
481
481
<tr>
482
 
<td class="struct_member_name"><p>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GActionEntry.state"></a>state</code></em>;</p></td>
 
482
<td class="struct_member_name"><p>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GActionEntry.state"></a>state</code></em>;</p></td>
483
483
<td class="struct_member_description"><p>the initial state for this action, given in
484
 
<a href="http://library.gnome.org/devel/glib/unstable/gvariant-text.html">GVariant text format</a>.  The state is parsed
 
484
<a href="../glib/gvariant-text.html">GVariant text format</a>.  The state is parsed
485
485
with no extra type information, so type tags must be added to
486
486
the string if they are necessary.  Stateless actions should
487
 
give <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> here.</p></td>
 
487
give <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> here.</p></td>
488
488
<td class="struct_member_annotations"> </td>
489
489
</tr>
490
490
<tr>