diff options
Diffstat (limited to 'gtk+-mingw/share/gtk-doc/html/gio/GActionMap.html')
| -rw-r--r-- | gtk+-mingw/share/gtk-doc/html/gio/GActionMap.html | 385 |
1 files changed, 0 insertions, 385 deletions
diff --git a/gtk+-mingw/share/gtk-doc/html/gio/GActionMap.html b/gtk+-mingw/share/gtk-doc/html/gio/GActionMap.html deleted file mode 100644 index e209e87..0000000 --- a/gtk+-mingw/share/gtk-doc/html/gio/GActionMap.html +++ /dev/null @@ -1,385 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>GActionMap</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="index.html" title="GIO Reference Manual"> -<link rel="up" href="application.html" title="Application support"> -<link rel="prev" href="GActionGroup.html" title="GActionGroup"> -<link rel="next" href="GSimpleActionGroup.html" title="GSimpleActionGroup"> -<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> -<link rel="stylesheet" href="style.css" type="text/css"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> -<tr valign="middle"> -<td><a accesskey="p" href="GActionGroup.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="application.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> -<th width="100%" align="center">GIO Reference Manual</th> -<td><a accesskey="n" href="GSimpleActionGroup.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#GActionMap.synopsis" class="shortcut">Top</a> - | - <a href="#GActionMap.description" class="shortcut">Description</a> - | - <a href="#GActionMap.object-hierarchy" class="shortcut">Object Hierarchy</a> - | - <a href="#GActionMap.prerequisites" class="shortcut">Prerequisites</a> - | - <a href="#GActionMap.implementations" class="shortcut">Known Implementations</a> -</td></tr> -</table> -<div class="refentry"> -<a name="GActionMap"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="GActionMap.top_of_page"></a>GActionMap</span></h2> -<p>GActionMap — Interface for action containers</p> -</td> -<td valign="top" align="right"></td> -</tr></table></div> -<div class="refsynopsisdiv"> -<a name="GActionMap.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> <a class="link" href="GActionMap.html#GActionMap-struct" title="GActionMap">GActionMap</a>; -struct <a class="link" href="GActionMap.html#GActionMapInterface" title="struct GActionMapInterface">GActionMapInterface</a>; -<a class="link" href="GAction.html" title="GAction"><span class="returnvalue">GAction</span></a> * <a class="link" href="GActionMap.html#g-action-map-lookup-action" title="g_action_map_lookup_action ()">g_action_map_lookup_action</a> (<em class="parameter"><code><a class="link" href="GActionMap.html" title="GActionMap"><span class="type">GActionMap</span></a> *action_map</code></em>, - <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>); -struct <a class="link" href="GActionMap.html#GActionEntry" title="struct GActionEntry">GActionEntry</a>; -<span class="returnvalue">void</span> <a class="link" href="GActionMap.html#g-action-map-add-action-entries" title="g_action_map_add_action_entries ()">g_action_map_add_action_entries</a> (<em class="parameter"><code><a class="link" href="GActionMap.html" title="GActionMap"><span class="type">GActionMap</span></a> *action_map</code></em>, - <em class="parameter"><code>const <a class="link" href="GActionMap.html#GActionEntry" title="struct GActionEntry"><span class="type">GActionEntry</span></a> *entries</code></em>, - <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_entries</code></em>, - <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>); -<span class="returnvalue">void</span> <a class="link" href="GActionMap.html#g-action-map-add-action" title="g_action_map_add_action ()">g_action_map_add_action</a> (<em class="parameter"><code><a class="link" href="GActionMap.html" title="GActionMap"><span class="type">GActionMap</span></a> *action_map</code></em>, - <em class="parameter"><code><a class="link" href="GAction.html" title="GAction"><span class="type">GAction</span></a> *action</code></em>); -<span class="returnvalue">void</span> <a class="link" href="GActionMap.html#g-action-map-remove-action" title="g_action_map_remove_action ()">g_action_map_remove_action</a> (<em class="parameter"><code><a class="link" href="GActionMap.html" title="GActionMap"><span class="type">GActionMap</span></a> *action_map</code></em>, - <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>); -</pre> -</div> -<div class="refsect1"> -<a name="GActionMap.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="synopsis"> - GInterface - +----GActionMap -</pre> -</div> -<div class="refsect1"> -<a name="GActionMap.prerequisites"></a><h2>Prerequisites</h2> -<p> -GActionMap requires - <a class="link" href="GActionGroup.html" title="GActionGroup">GActionGroup</a> and <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p> -</div> -<div class="refsect1"> -<a name="GActionMap.implementations"></a><h2>Known Implementations</h2> -<p> -GActionMap is implemented by - <a class="link" href="GApplication.html" title="GApplication">GApplication</a> and <a class="link" href="GSimpleActionGroup.html" title="GSimpleActionGroup">GSimpleActionGroup</a>.</p> -</div> -<div class="refsect1"> -<a name="GActionMap.description"></a><h2>Description</h2> -<p> -The GActionMap interface is implemented by <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> -implementations that operate by containing a number of -named <a class="link" href="GAction.html" title="GAction"><span class="type">GAction</span></a> instances, such as <a class="link" href="GSimpleActionGroup.html" title="GSimpleActionGroup"><span class="type">GSimpleActionGroup</span></a>. -</p> -<p> -One useful application of this interface is to map the -names of actions from various action groups to unique, -prefixed names (e.g. by prepending "app." or "win."). -This is the motivation for the 'Map' part of the interface -name. -</p> -</div> -<div class="refsect1"> -<a name="GActionMap.details"></a><h2>Details</h2> -<div class="refsect2"> -<a name="GActionMap-struct"></a><h3>GActionMap</h3> -<pre class="programlisting">typedef struct _GActionMap GActionMap;</pre> -</div> -<hr> -<div class="refsect2"> -<a name="GActionMapInterface"></a><h3>struct GActionMapInterface</h3> -<pre class="programlisting">struct GActionMapInterface { - GTypeInterface g_iface; - - GAction * (* lookup_action) (GActionMap *action_map, - const gchar *action_name); - void (* add_action) (GActionMap *action_map, - GAction *action); - void (* remove_action) (GActionMap *action_map, - const gchar *action_name); -}; -</pre> -<p> -The virtual function table for <a class="link" href="GActionMap.html" title="GActionMap"><span class="type">GActionMap</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><a href="./../gobject/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>;</span></p></td> -<td></td> -</tr> -<tr> -<td><p><span class="term"><em class="structfield"><code><a name="GActionMapInterface.lookup-action"></a>lookup_action</code></em> ()</span></p></td> -<td>the virtual function pointer for <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> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="structfield"><code><a name="GActionMapInterface.add-action"></a>add_action</code></em> ()</span></p></td> -<td>the virtual function pointer for <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> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="structfield"><code><a name="GActionMapInterface.remove-action"></a>remove_action</code></em> ()</span></p></td> -<td>the virtual function pointer for <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> -</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="g-action-map-lookup-action"></a><h3>g_action_map_lookup_action ()</h3> -<pre class="programlisting"><a class="link" href="GAction.html" title="GAction"><span class="returnvalue">GAction</span></a> * 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>, - <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>);</pre> -<p> -Looks up the action with the name <em class="parameter"><code>action_name</code></em> in <em class="parameter"><code>action_map</code></em>. -</p> -<p> -If no such action exists, returns <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>action_map</code></em> :</span></p></td> -<td>a <a class="link" href="GActionMap.html" title="GActionMap"><span class="type">GActionMap</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>action_name</code></em> :</span></p></td> -<td>the name of an action</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a <a class="link" href="GAction.html" title="GAction"><span class="type">GAction</span></a>, or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> -</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="GActionEntry"></a><h3>struct GActionEntry</h3> -<pre class="programlisting">struct GActionEntry { - const gchar *name; - - void (* activate) (GSimpleAction *action, - GVariant *parameter, - gpointer user_data); - - const gchar *parameter_type; - - const gchar *state; - - void (* change_state) (GSimpleAction *action, - GVariant *value, - gpointer user_data); -}; -</pre> -<p> -This struct defines a single action. It is for use with -<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> -<p> -The order of the items in the structure are intended to reflect -frequency of use. It is permissible to use an incomplete initialiser -in order to leave some of the later values as <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. All values -after <em class="parameter"><code>name</code></em> are optional. Additional optional fields may be added in -the future. -</p> -<p> -See <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> for an example. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term">const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GActionEntry.name"></a>name</code></em>;</span></p></td> -<td>the name of the action</td> -</tr> -<tr> -<td><p><span class="term"><em class="structfield"><code><a name="GActionEntry.activate"></a>activate</code></em> ()</span></p></td> -<td>the callback to connect to the "activate" signal of the -action</td> -</tr> -<tr> -<td><p><span class="term">const <a href="./../glib/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>;</span></p></td> -<td>the type of the parameter that must be passed to the -activate function for this action, given as a single -GVariant type string (or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for no parameter)</td> -</tr> -<tr> -<td><p><span class="term">const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GActionEntry.state"></a>state</code></em>;</span></p></td> -<td>the initial state for this action, given in GVariant text -format. The state is parsed with no extra type information, -so type tags must be added to the string if they are -necessary.</td> -</tr> -<tr> -<td><p><span class="term"><em class="structfield"><code><a name="GActionEntry.change-state"></a>change_state</code></em> ()</span></p></td> -<td>the callback to connect to the "change-state" signal -of the action</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="g-action-map-add-action-entries"></a><h3>g_action_map_add_action_entries ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> 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>, - <em class="parameter"><code>const <a class="link" href="GActionMap.html#GActionEntry" title="struct GActionEntry"><span class="type">GActionEntry</span></a> *entries</code></em>, - <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_entries</code></em>, - <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> -<p> -A convenience function for creating multiple <a class="link" href="GSimpleAction.html" title="GSimpleAction"><span class="type">GSimpleAction</span></a> instances -and adding them to a <a class="link" href="GActionMap.html" title="GActionMap"><span class="type">GActionMap</span></a>. -</p> -<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> -<p> -</p> -<div class="example"> -<a name="idp66458112"></a><p class="title"><b>Example 21. Using <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></b></p> -<div class="example-contents"><pre class="programlisting"> -static void -activate_quit (GSimpleAction *simple, - GVariant *parameter, - gpointer user_data) -{ - exit (0); -} - -static void -activate_print_string (GSimpleAction *simple, - GVariant *parameter, - gpointer user_data) -{ - g_print ("%s\n", g_variant_get_string (parameter, NULL)); -} - -static GActionGroup * -create_action_group (void) -{ - const GActionEntry entries[] = { - { "quit", activate_quit }, - { "print-string", activate_print_string, "s" } - }; - GSimpleActionGroup *group; - - group = g_simple_action_group_new (); - g_action_map_add_action_entries (G_ACTION_MAP (group), entries, G_N_ELEMENTS (entries), NULL); - - return G_ACTION_GROUP (group); -} -</pre></div> -</div> -<p><br class="example-break"> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>action_map</code></em> :</span></p></td> -<td>a <a class="link" href="GActionMap.html" title="GActionMap"><span class="type">GActionMap</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>entries</code></em> :</span></p></td> -<td>a pointer to the first item in an array of <a class="link" href="GActionMap.html#GActionEntry" title="struct GActionEntry"><span class="type">GActionEntry</span></a> -structs</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>n_entries</code></em> :</span></p></td> -<td>the length of <em class="parameter"><code>entries</code></em>, or -1 if <em class="parameter"><code>entries</code></em> is <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> -<td>the user data for signal connections</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="g-action-map-add-action"></a><h3>g_action_map_add_action ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> g_action_map_add_action (<em class="parameter"><code><a class="link" href="GActionMap.html" title="GActionMap"><span class="type">GActionMap</span></a> *action_map</code></em>, - <em class="parameter"><code><a class="link" href="GAction.html" title="GAction"><span class="type">GAction</span></a> *action</code></em>);</pre> -<p> -Adds an action to the <em class="parameter"><code>action_map</code></em>. -</p> -<p> -If the action map already contains an action with the same name -as <em class="parameter"><code>action</code></em> then the old action is dropped from the action map. -</p> -<p> -The action map takes its own reference on <em class="parameter"><code>action</code></em>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>action_map</code></em> :</span></p></td> -<td>a <a class="link" href="GActionMap.html" title="GActionMap"><span class="type">GActionMap</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td> -<td>a <a class="link" href="GAction.html" title="GAction"><span class="type">GAction</span></a> -</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="g-action-map-remove-action"></a><h3>g_action_map_remove_action ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> 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>, - <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>);</pre> -<p> -Removes the named action from the action map. -</p> -<p> -If no action of this name is in the map then nothing happens. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>action_map</code></em> :</span></p></td> -<td>a <a class="link" href="GActionMap.html" title="GActionMap"><span class="type">GActionMap</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>action_name</code></em> :</span></p></td> -<td>the name of the action</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.32</p> -</div> -</div> -</div> -<div class="footer"> -<hr> - Generated by GTK-Doc V1.18</div> -</body> -</html>
\ No newline at end of file |