diff options
author | Leo Tenenbaum <pommicket@gmail.com> | 2018-08-20 21:12:06 -0400 |
---|---|---|
committer | Leo Tenenbaum <pommicket@gmail.com> | 2018-08-20 21:12:06 -0400 |
commit | 63e87c2d0c9d263f14c77b68f85c67d46ece82a9 (patch) | |
tree | 6260365cbf7d24f37d27669e8538227fcb72e243 /gtk+-mingw/share/gtk-doc/html/atk/AtkAction.html | |
parent | a4460f6d9453bbd7e584937686449cef3e19f052 (diff) |
Diffstat (limited to 'gtk+-mingw/share/gtk-doc/html/atk/AtkAction.html')
-rw-r--r-- | gtk+-mingw/share/gtk-doc/html/atk/AtkAction.html | 330 |
1 files changed, 0 insertions, 330 deletions
diff --git a/gtk+-mingw/share/gtk-doc/html/atk/AtkAction.html b/gtk+-mingw/share/gtk-doc/html/atk/AtkAction.html deleted file mode 100644 index d586f51..0000000 --- a/gtk+-mingw/share/gtk-doc/html/atk/AtkAction.html +++ /dev/null @@ -1,330 +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>AtkAction</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="index.html" title="ATK - Accessibility Toolkit"> -<link rel="up" href="atk.html" title="ATK Library"> -<link rel="prev" href="atk.html" title="ATK Library"> -<link rel="next" href="AtkComponent.html" title="AtkComponent"> -<meta name="generator" content="GTK-Doc V1.18.1 (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="atk.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="atk.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">ATK - Accessibility Toolkit</th> -<td><a accesskey="n" href="AtkComponent.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#AtkAction.synopsis" class="shortcut">Top</a> - | - <a href="#AtkAction.description" class="shortcut">Description</a> - | - <a href="#AtkAction.object-hierarchy" class="shortcut">Object Hierarchy</a> - | - <a href="#AtkAction.implementations" class="shortcut">Known Implementations</a> -</td></tr> -</table> -<div class="refentry"> -<a name="AtkAction"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="AtkAction.top_of_page"></a>AtkAction</span></h2> -<p>AtkAction — The ATK interface provided by UI components which the user can -activate/interact with,</p> -</td> -<td valign="top" align="right"></td> -</tr></table></div> -<div class="refsynopsisdiv"> -<a name="AtkAction.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> <a class="link" href="AtkAction.html#AtkAction-struct" title="AtkAction">AtkAction</a>; -<span class="returnvalue">gboolean</span> <a class="link" href="AtkAction.html#atk-action-do-action" title="atk_action_do_action ()">atk_action_do_action</a> (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>, - <em class="parameter"><code><span class="type">gint</span> i</code></em>); -<span class="returnvalue">gint</span> <a class="link" href="AtkAction.html#atk-action-get-n-actions" title="atk_action_get_n_actions ()">atk_action_get_n_actions</a> (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>); -const <span class="returnvalue">gchar</span> * <a class="link" href="AtkAction.html#atk-action-get-description" title="atk_action_get_description ()">atk_action_get_description</a> (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>, - <em class="parameter"><code><span class="type">gint</span> i</code></em>); -const <span class="returnvalue">gchar</span> * <a class="link" href="AtkAction.html#atk-action-get-name" title="atk_action_get_name ()">atk_action_get_name</a> (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>, - <em class="parameter"><code><span class="type">gint</span> i</code></em>); -const <span class="returnvalue">gchar</span> * <a class="link" href="AtkAction.html#atk-action-get-localized-name" title="atk_action_get_localized_name ()">atk_action_get_localized_name</a> (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>, - <em class="parameter"><code><span class="type">gint</span> i</code></em>); -const <span class="returnvalue">gchar</span> * <a class="link" href="AtkAction.html#atk-action-get-keybinding" title="atk_action_get_keybinding ()">atk_action_get_keybinding</a> (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>, - <em class="parameter"><code><span class="type">gint</span> i</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="AtkAction.html#atk-action-set-description" title="atk_action_set_description ()">atk_action_set_description</a> (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>, - <em class="parameter"><code><span class="type">gint</span> i</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *desc</code></em>); -</pre> -</div> -<div class="refsect1"> -<a name="AtkAction.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="synopsis"> - GInterface - +----AtkAction -</pre> -</div> -<div class="refsect1"> -<a name="AtkAction.implementations"></a><h2>Known Implementations</h2> -<p> -AtkAction is implemented by - <a class="link" href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a> and <a class="link" href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>.</p> -</div> -<div class="refsect1"> -<a name="AtkAction.description"></a><h2>Description</h2> -<p> -<a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> should be implemented by instances of <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> classes with -which the user can interact directly, i.e. buttons, checkboxes, -scrollbars, e.g. components which are not "passive" -providers of UI information. -</p> -<p> -Exceptions: when the user interaction is already covered by -another appropriate interface such as <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> (insert/delete -text, etc.) or <a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> (set value) then these actions should not be -exposed by <a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> as well. -</p> -<p> -Also note that the <a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> API is limited in that parameters may not -be passed to the object being activated; thus the action must be -self-contained and specifiable via only a single "verb". Concrete -examples include "press", "release", "click" for buttons, "drag" -(meaning initiate drag) and "drop" for drag sources and drop targets, -etc. -</p> -<p> -Though most UI interactions on components should be invocable via -keyboard as well as mouse, there will generally be a close mapping -between "mouse actions" that are possible on a component and the -AtkActions. Where mouse and keyboard actions are redundant in effect, -<a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> should expose only one action rather than exposing redundant -actions if possible. By convention we have been using "mouse centric" -terminology for <a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> names. -</p> -</div> -<div class="refsect1"> -<a name="AtkAction.details"></a><h2>Details</h2> -<div class="refsect2"> -<a name="AtkAction-struct"></a><h3>AtkAction</h3> -<pre class="programlisting">typedef struct _AtkAction AtkAction;</pre> -<p> -The AtkAction structure does not contain any fields. -</p> -</div> -<hr> -<div class="refsect2"> -<a name="atk-action-do-action"></a><h3>atk_action_do_action ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> atk_action_do_action (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>, - <em class="parameter"><code><span class="type">gint</span> i</code></em>);</pre> -<p> -Perform the specified action on the object. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td> -<td>a <span class="type">GObject</span> instance that implements AtkActionIface</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td> -<td>the action index corresponding to the action to be performed</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> -<code class="literal">TRUE</code> if success, <code class="literal">FALSE</code> otherwise</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="atk-action-get-n-actions"></a><h3>atk_action_get_n_actions ()</h3> -<pre class="programlisting"><span class="returnvalue">gint</span> atk_action_get_n_actions (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>);</pre> -<p> -Gets the number of accessible actions available on the object. -If there are more than one, the first one is considered the -"default" action of the object. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td> -<td>a <span class="type">GObject</span> instance that implements AtkActionIface</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a the number of actions, or 0 if <em class="parameter"><code>action</code></em> does not -implement this interface.</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="atk-action-get-description"></a><h3>atk_action_get_description ()</h3> -<pre class="programlisting">const <span class="returnvalue">gchar</span> * atk_action_get_description (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>, - <em class="parameter"><code><span class="type">gint</span> i</code></em>);</pre> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td> -<td>a <span class="type">GObject</span> instance that implements AtkActionIface</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td> -<td>the action index corresponding to the action to be performed</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a description string, or <a href="/opt/gnome3/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> -if <em class="parameter"><code>action</code></em> does not implement this interface.</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="atk-action-get-name"></a><h3>atk_action_get_name ()</h3> -<pre class="programlisting">const <span class="returnvalue">gchar</span> * atk_action_get_name (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>, - <em class="parameter"><code><span class="type">gint</span> i</code></em>);</pre> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td> -<td>a <span class="type">GObject</span> instance that implements AtkActionIface</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td> -<td>the action index corresponding to the action to be performed</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a name string, or <a href="/opt/gnome3/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> -if <em class="parameter"><code>action</code></em> does not implement this interface.</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="atk-action-get-localized-name"></a><h3>atk_action_get_localized_name ()</h3> -<pre class="programlisting">const <span class="returnvalue">gchar</span> * atk_action_get_localized_name (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>, - <em class="parameter"><code><span class="type">gint</span> i</code></em>);</pre> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td> -<td>a <span class="type">GObject</span> instance that implements AtkActionIface</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td> -<td>the action index corresponding to the action to be performed</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a name string, or <a href="/opt/gnome3/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> -if <em class="parameter"><code>action</code></em> does not implement this interface.</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="atk-action-get-keybinding"></a><h3>atk_action_get_keybinding ()</h3> -<pre class="programlisting">const <span class="returnvalue">gchar</span> * atk_action_get_keybinding (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>, - <em class="parameter"><code><span class="type">gint</span> i</code></em>);</pre> -<p> -Gets the keybinding which can be used to activate this action, if one -exists. The string returned should contain localized, human-readable, -key sequences as they would appear when displayed on screen. It must -be in the format "mnemonic;sequence;shortcut". -</p> -<p> -</p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> -<li class="listitem"><p>The mnemonic key activates the object if it is presently enabled onscreen. - This typically corresponds to the underlined letter within the widget. - Example: "n" in a traditional "New..." menu item or the "a" in "Apply" for - a button.</p></li> -<li class="listitem"><p>The sequence is the full list of keys which invoke the action even if the - relevant element is not currently shown on screen. For instance, for a menu - item the sequence is the keybindings used to open the parent menus before - invoking. The sequence string is colon-delimited. Example: "Alt+F:N" in a - traditional "New..." menu item.</p></li> -<li class="listitem"><p>The shortcut, if it exists, will invoke the same action without showing - the component or its enclosing menus or dialogs. Example: "Ctrl+N" in a - traditional "New..." menu item.</p></li> -</ul></div> -<p> -</p> -<p> -Example: For a traditional "New..." menu item, the expected return value -would be: "N;Alt+F:N;Ctrl+N" for the English locale and "N;Alt+D:N;Strg+N" -for the German locale. If, hypothetically, this menu item lacked a mnemonic, -it would be represented by ";;Ctrl+N" and ";;Strg+N" respectively. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td> -<td>a <span class="type">GObject</span> instance that implements AtkActionIface</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td> -<td>the action index corresponding to the action to be performed</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the keybinding which can be used to activate this action, or <a href="/opt/gnome3/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> -if there is no keybinding for this action.</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="atk-action-set-description"></a><h3>atk_action_set_description ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> atk_action_set_description (<em class="parameter"><code><a class="link" href="AtkAction.html" title="AtkAction"><span class="type">AtkAction</span></a> *action</code></em>, - <em class="parameter"><code><span class="type">gint</span> i</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *desc</code></em>);</pre> -<p> -Sets a description of the specified action of the object. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td> -<td>a <span class="type">GObject</span> instance that implements AtkActionIface</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td> -<td>the action index corresponding to the action to be performed</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>desc</code></em> :</span></p></td> -<td>the description to be assigned to this action</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a gboolean representing if the description was successfully set;</td> -</tr> -</tbody> -</table></div> -</div> -</div> -</div> -<div class="footer"> -<hr> - Generated by GTK-Doc V1.18.1</div> -</body> -</html>
\ No newline at end of file |