docs/reference/gio/html/GSimpleActionGroup.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>GSimpleActionGroup: GIO Reference Manual</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.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="GActionMap.html" title="GActionMap">
  10 <link rel="next" href="GAction.html" title="GAction">
  11 <meta name="generator" content="GTK-Doc V1.25.1 (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="5"><tr valign="middle">
  16 <td width="100%" align="left" class="shortcuts">
  17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span>
  18                   <a href="#GSimpleActionGroup.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span>
  19                   <a href="#GSimpleActionGroup.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span>
  20                   <a href="#GSimpleActionGroup.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span>
  21 </td>
  22 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  23 <td><a accesskey="u" href="application.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  24 <td><a accesskey="p" href="GActionMap.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  25 <td><a accesskey="n" href="GAction.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  26 </tr></table>
  27 <div class="refentry">
  28 <a name="GSimpleActionGroup"></a><div class="titlepage"></div>
  29 <div class="refnamediv"><table width="100%"><tr>
  30 <td valign="top">
  31 <h2><span class="refentrytitle"><a name="GSimpleActionGroup.top_of_page"></a>GSimpleActionGroup</span></h2>
  32 <p>GSimpleActionGroup — A simple GActionGroup implementation</p>
  33 </td>
  34 <td class="gallery_image" valign="top" align="right"></td>
  35 </tr></table></div>
  36 <div class="refsect1">
  37 <a name="GSimpleActionGroup.functions"></a><h2>Functions</h2>
  38 <div class="informaltable"><table class="informaltable" width="100%" border="0">
  39 <colgroup>
  40 <col width="150px" class="functions_return">
  41 <col class="functions_name">
  42 </colgroup>
  43 <tbody>
  44 <tr>
  45 <td class="function_type">
  46 <a class="link" href="GSimpleActionGroup.html" title="GSimpleActionGroup"><span class="returnvalue">GSimpleActionGroup</span></a> *
  47 </td>
  48 <td class="function_name">
  49 <a class="link" href="GSimpleActionGroup.html#g-simple-action-group-new" title="g_simple_action_group_new ()">g_simple_action_group_new</a> <span class="c_punctuation">()</span>
  50 </td>
  51 </tr>
  52 <tr>
  53 <td class="function_type">
  54 <a class="link" href="GAction.html" title="GAction"><span class="returnvalue">GAction</span></a> *
  55 </td>
  56 <td class="function_name">
  57 <a class="link" href="GSimpleActionGroup.html#g-simple-action-group-lookup" title="g_simple_action_group_lookup ()">g_simple_action_group_lookup</a> <span class="c_punctuation">()</span>
  58 </td>
  59 </tr>
  60 <tr>
  61 <td class="function_type">
  62 <span class="returnvalue">void</span>
  63 </td>
  64 <td class="function_name">
  65 <a class="link" href="GSimpleActionGroup.html#g-simple-action-group-insert" title="g_simple_action_group_insert ()">g_simple_action_group_insert</a> <span class="c_punctuation">()</span>
  66 </td>
  67 </tr>
  68 <tr>
  69 <td class="function_type">
  70 <span class="returnvalue">void</span>
  71 </td>
  72 <td class="function_name">
  73 <a class="link" href="GSimpleActionGroup.html#g-simple-action-group-remove" title="g_simple_action_group_remove ()">g_simple_action_group_remove</a> <span class="c_punctuation">()</span>
  74 </td>
  75 </tr>
  76 <tr>
  77 <td class="function_type">
  78 <span class="returnvalue">void</span>
  79 </td>
  80 <td class="function_name">
  81 <a class="link" href="GSimpleActionGroup.html#g-simple-action-group-add-entries" title="g_simple_action_group_add_entries ()">g_simple_action_group_add_entries</a> <span class="c_punctuation">()</span>
  82 </td>
  83 </tr>
  84 </tbody>
  85 </table></div>
  86 </div>
  87 <div class="refsect1">
  88 <a name="GSimpleActionGroup.other"></a><h2>Types and Values</h2>
  89 <div class="informaltable"><table class="informaltable" width="100%" border="0">
  90 <colgroup>
  91 <col width="150px" class="name">
  92 <col class="description">
  93 </colgroup>
  94 <tbody><tr>
  95 <td class="datatype_keyword"> </td>
  96 <td class="function_name"><a class="link" href="GSimpleActionGroup.html#GSimpleActionGroup-struct" title="GSimpleActionGroup">GSimpleActionGroup</a></td>
  97 </tr></tbody>
  98 </table></div>
  99 </div>
 100 <div class="refsect1">
 101 <a name="GSimpleActionGroup.object-hierarchy"></a><h2>Object Hierarchy</h2>
 102 <pre class="screen">    <a href="../gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
 103     <span class="lineart">╰──</span> GSimpleActionGroup
 104 </pre>
 105 </div>
 106 <div class="refsect1">
 107 <a name="GSimpleActionGroup.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 108 <p>
 109 GSimpleActionGroup implements
 110  <a class="link" href="GActionGroup.html" title="GActionGroup">GActionGroup</a> and  <a class="link" href="GActionMap.html" title="GActionMap">GActionMap</a>.</p>
 111 </div>
 112 <div class="refsect1">
 113 <a name="GSimpleActionGroup.includes"></a><h2>Includes</h2>
 114 <pre class="synopsis">#include &lt;gio/gio.h&gt;
 115 </pre>
 116 </div>
 117 <div class="refsect1">
 118 <a name="GSimpleActionGroup.description"></a><h2>Description</h2>
 119 <p><a class="link" href="GSimpleActionGroup.html" title="GSimpleActionGroup"><span class="type">GSimpleActionGroup</span></a> is a hash table filled with <a class="link" href="GAction.html" title="GAction"><span class="type">GAction</span></a> objects,
 120 implementing the <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> and <a class="link" href="GActionMap.html" title="GActionMap"><span class="type">GActionMap</span></a> interfaces.</p>
 121 </div>
 122 <div class="refsect1">
 123 <a name="GSimpleActionGroup.functions_details"></a><h2>Functions</h2>
 124 <div class="refsect2">
 125 <a name="g-simple-action-group-new"></a><h3>g_simple_action_group_new ()</h3>
 126 <pre class="programlisting"><a class="link" href="GSimpleActionGroup.html" title="GSimpleActionGroup"><span class="returnvalue">GSimpleActionGroup</span></a> *
 127 g_simple_action_group_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 128 <p>Creates a new, empty, <a class="link" href="GSimpleActionGroup.html" title="GSimpleActionGroup"><span class="type">GSimpleActionGroup</span></a>.</p>
 129 <div class="refsect3">
 130 <a name="g-simple-action-group-new.returns"></a><h4>Returns</h4>
 131 <p> a new <a class="link" href="GSimpleActionGroup.html" title="GSimpleActionGroup"><span class="type">GSimpleActionGroup</span></a></p>
 132 </div>
 133 <p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
 134 </div>
 135 <hr>
 136 <div class="refsect2">
 137 <a name="g-simple-action-group-lookup"></a><h3>g_simple_action_group_lookup ()</h3>
 138 <pre class="programlisting"><a class="link" href="GAction.html" title="GAction"><span class="returnvalue">GAction</span></a> *
 139 g_simple_action_group_lookup (<em class="parameter"><code><a class="link" href="GSimpleActionGroup.html" title="GSimpleActionGroup"><span class="type">GSimpleActionGroup</span></a> *simple</code></em>,
 140                               <em class="parameter"><code>const <a href="../glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>);</pre>
 141 <div class="warning">
 142 <p><code class="literal">g_simple_action_group_lookup</code> has been deprecated since version 2.38 and should not be used in newly-written code.</p>
 143 <p>Use <a class="link" href="GActionMap.html#g-action-map-lookup-action" title="g_action_map_lookup_action ()"><code class="function">g_action_map_lookup_action()</code></a></p>
 144 </div>
 145 <p>Looks up the action with the name <em class="parameter"><code>action_name</code></em>
 146  in the group.</p>
 147 <p>If no such action exists, returns <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
 148 <div class="refsect3">
 149 <a name="g-simple-action-group-lookup.parameters"></a><h4>Parameters</h4>
 150 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 151 <colgroup>
 152 <col width="150px" class="parameters_name">
 153 <col class="parameters_description">
 154 <col width="200px" class="parameters_annotations">
 155 </colgroup>
 156 <tbody>
 157 <tr>
 158 <td class="parameter_name"><p>simple</p></td>
 159 <td class="parameter_description"><p>a <a class="link" href="GSimpleActionGroup.html" title="GSimpleActionGroup"><span class="type">GSimpleActionGroup</span></a></p></td>
 160 <td class="parameter_annotations"> </td>
 161 </tr>
 162 <tr>
 163 <td class="parameter_name"><p>action_name</p></td>
 164 <td class="parameter_description"><p>the name of an action</p></td>
 165 <td class="parameter_annotations"> </td>
 166 </tr>
 167 </tbody>
 168 </table></div>
 169 </div>
 170 <div class="refsect3">
 171 <a name="g-simple-action-group-lookup.returns"></a><h4>Returns</h4>
 172 <p> a <a class="link" href="GAction.html" title="GAction"><span class="type">GAction</span></a>, or <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
 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 </div>
 175 <p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
 176 </div>
 177 <hr>
 178 <div class="refsect2">
 179 <a name="g-simple-action-group-insert"></a><h3>g_simple_action_group_insert ()</h3>
 180 <pre class="programlisting"><span class="returnvalue">void</span>
 181 g_simple_action_group_insert (<em class="parameter"><code><a class="link" href="GSimpleActionGroup.html" title="GSimpleActionGroup"><span class="type">GSimpleActionGroup</span></a> *simple</code></em>,
 182                               <em class="parameter"><code><a class="link" href="GAction.html" title="GAction"><span class="type">GAction</span></a> *action</code></em>);</pre>
 183 <div class="warning">
 184 <p><code class="literal">g_simple_action_group_insert</code> has been deprecated since version 2.38 and should not be used in newly-written code.</p>
 185 <p>Use <a class="link" href="GActionMap.html#g-action-map-add-action" title="g_action_map_add_action ()"><code class="function">g_action_map_add_action()</code></a></p>
 186 </div>
 187 <p>Adds an action to the action group.</p>
 188 <p>If the action group already contains an action with the same name as
 189 <em class="parameter"><code>action</code></em>
 190  then the old action is dropped from the group.</p>
 191 <p>The action group takes its own reference on <em class="parameter"><code>action</code></em>
 192 .</p>
 193 <div class="refsect3">
 194 <a name="g-simple-action-group-insert.parameters"></a><h4>Parameters</h4>
 195 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 196 <colgroup>
 197 <col width="150px" class="parameters_name">
 198 <col class="parameters_description">
 199 <col width="200px" class="parameters_annotations">
 200 </colgroup>
 201 <tbody>
 202 <tr>
 203 <td class="parameter_name"><p>simple</p></td>
 204 <td class="parameter_description"><p>a <a class="link" href="GSimpleActionGroup.html" title="GSimpleActionGroup"><span class="type">GSimpleActionGroup</span></a></p></td>
 205 <td class="parameter_annotations"> </td>
 206 </tr>
 207 <tr>
 208 <td class="parameter_name"><p>action</p></td>
 209 <td class="parameter_description"><p>a <a class="link" href="GAction.html" title="GAction"><span class="type">GAction</span></a></p></td>
 210 <td class="parameter_annotations"> </td>
 211 </tr>
 212 </tbody>
 213 </table></div>
 214 </div>
 215 <p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
 216 </div>
 217 <hr>
 218 <div class="refsect2">
 219 <a name="g-simple-action-group-remove"></a><h3>g_simple_action_group_remove ()</h3>
 220 <pre class="programlisting"><span class="returnvalue">void</span>
 221 g_simple_action_group_remove (<em class="parameter"><code><a class="link" href="GSimpleActionGroup.html" title="GSimpleActionGroup"><span class="type">GSimpleActionGroup</span></a> *simple</code></em>,
 222                               <em class="parameter"><code>const <a href="../glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>);</pre>
 223 <div class="warning">
 224 <p><code class="literal">g_simple_action_group_remove</code> has been deprecated since version 2.38 and should not be used in newly-written code.</p>
 225 <p>Use <a class="link" href="GActionMap.html#g-action-map-remove-action" title="g_action_map_remove_action ()"><code class="function">g_action_map_remove_action()</code></a></p>
 226 </div>
 227 <p>Removes the named action from the action group.</p>
 228 <p>If no action of this name is in the group then nothing happens.</p>
 229 <div class="refsect3">
 230 <a name="g-simple-action-group-remove.parameters"></a><h4>Parameters</h4>
 231 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 232 <colgroup>
 233 <col width="150px" class="parameters_name">
 234 <col class="parameters_description">
 235 <col width="200px" class="parameters_annotations">
 236 </colgroup>
 237 <tbody>
 238 <tr>
 239 <td class="parameter_name"><p>simple</p></td>
 240 <td class="parameter_description"><p>a <a class="link" href="GSimpleActionGroup.html" title="GSimpleActionGroup"><span class="type">GSimpleActionGroup</span></a></p></td>
 241 <td class="parameter_annotations"> </td>
 242 </tr>
 243 <tr>
 244 <td class="parameter_name"><p>action_name</p></td>
 245 <td class="parameter_description"><p>the name of the action</p></td>
 246 <td class="parameter_annotations"> </td>
 247 </tr>
 248 </tbody>
 249 </table></div>
 250 </div>
 251 <p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
 252 </div>
 253 <hr>
 254 <div class="refsect2">
 255 <a name="g-simple-action-group-add-entries"></a><h3>g_simple_action_group_add_entries ()</h3>
 256 <pre class="programlisting"><span class="returnvalue">void</span>
 257 g_simple_action_group_add_entries (<em class="parameter"><code><a class="link" href="GSimpleActionGroup.html" title="GSimpleActionGroup"><span class="type">GSimpleActionGroup</span></a> *simple</code></em>,
 258                                    <em class="parameter"><code>const <a class="link" href="GActionMap.html#GActionEntry" title="struct GActionEntry"><span class="type">GActionEntry</span></a> *entries</code></em>,
 259                                    <em class="parameter"><code><a href="../glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_entries</code></em>,
 260                                    <em class="parameter"><code><a href="../glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
 261 <div class="warning">
 262 <p><code class="literal">g_simple_action_group_add_entries</code> has been deprecated since version 2.38 and should not be used in newly-written code.</p>
 263 <p>Use <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>
 264 </div>
 265 <p>A convenience function for creating multiple <a class="link" href="GSimpleAction.html" title="GSimpleAction"><span class="type">GSimpleAction</span></a> instances
 266 and adding them to the action group.</p>
 267 <div class="refsect3">
 268 <a name="g-simple-action-group-add-entries.parameters"></a><h4>Parameters</h4>
 269 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 270 <colgroup>
 271 <col width="150px" class="parameters_name">
 272 <col class="parameters_description">
 273 <col width="200px" class="parameters_annotations">
 274 </colgroup>
 275 <tbody>
 276 <tr>
 277 <td class="parameter_name"><p>simple</p></td>
 278 <td class="parameter_description"><p>a <a class="link" href="GSimpleActionGroup.html" title="GSimpleActionGroup"><span class="type">GSimpleActionGroup</span></a></p></td>
 279 <td class="parameter_annotations"> </td>
 280 </tr>
 281 <tr>
 282 <td class="parameter_name"><p>entries</p></td>
 283 <td class="parameter_description"><p> a pointer to the first item in
 284 an array of <a class="link" href="GActionMap.html#GActionEntry" title="struct GActionEntry"><span class="type">GActionEntry</span></a> structs. </p></td>
 285 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_entries]</span></td>
 286 </tr>
 287 <tr>
 288 <td class="parameter_name"><p>n_entries</p></td>
 289 <td class="parameter_description"><p>the length of <em class="parameter"><code>entries</code></em>
 290 , or -1</p></td>
 291 <td class="parameter_annotations"> </td>
 292 </tr>
 293 <tr>
 294 <td class="parameter_name"><p>user_data</p></td>
 295 <td class="parameter_description"><p>the user data for signal connections</p></td>
 296 <td class="parameter_annotations"> </td>
 297 </tr>
 298 </tbody>
 299 </table></div>
 300 </div>
 301 <p class="since">Since: <a class="link" href="api-index-2-30.html#api-index-2.30">2.30</a></p>
 302 </div>
 303 </div>
 304 <div class="refsect1">
 305 <a name="GSimpleActionGroup.other_details"></a><h2>Types and Values</h2>
 306 <div class="refsect2">
 307 <a name="GSimpleActionGroup-struct"></a><h3>GSimpleActionGroup</h3>
 308 <pre class="programlisting">typedef struct _GSimpleActionGroup GSimpleActionGroup;</pre>
 309 <p>The <a class="link" href="GSimpleActionGroup.html" title="GSimpleActionGroup"><span class="type">GSimpleActionGroup</span></a> structure contains private data and should only be accessed using the provided API.</p>
 310 <p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
 311 </div>
 312 </div>
 313 </div>
 314 <div class="footer">
 315 <hr>Generated by GTK-Doc V1.25.1</div>
 316 </body>
 317 </html>