<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>atkmm: Atk::Action Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.2 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="namespaceAtk.html">Atk</a> </li>
<li><a class="el" href="classAtk_1_1Action.html">Action</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#related">Related Functions</a> </div>
<div class="headertitle">
<h1>Atk::Action Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Atk::Action" --><!-- doxytag: inherits="Glib::Interface" -->
<p>The ATK interface provided by UI components which the user can activate/interact with, This should be implemented by instances of <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Atk::Object</a> classes with which the user can interact directly, i.e. <a href="#_details">More...</a></p>
<p><code>#include <atkmm/action.h></code></p>
<!-- startSectionHeader --><div class="dynheader">
Inheritance diagram for Atk::Action:<!-- endSectionHeader --></div>
<!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent">
<div class="center"><img src="classAtk_1_1Action__inherit__graph.png" border="0" usemap="#Atk_1_1Action_inherit__map" alt="Inheritance graph"/></div>
<map name="Atk_1_1Action_inherit__map" id="Atk_1_1Action_inherit__map">
<area shape="rect" id="node9" href="classAtk_1_1Hyperlink.html" title="Encapsulates a link or set of links in a hypertext document." alt="" coords="5,315,115,344"/><area shape="rect" id="node11" href="classAtk_1_1NoOpObject.html" title="An Atk::NoOpObject is an Atk::Object which purports to implement all ATK interfaces." alt="" coords="139,315,267,344"/><area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="76,160,185,189"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="68,83,193,112"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="73,5,188,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
<p><a href="classAtk_1_1Action-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a922d5d2a5c8af62cdea07810b229094e"></a><!-- doxytag: member="Atk::Action::gobj" ref="a922d5d2a5c8af62cdea07810b229094e" args="()" -->
AtkAction* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#a922d5d2a5c8af62cdea07810b229094e">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2372fab551e83919d6d55010f881044f"></a><!-- doxytag: member="Atk::Action::gobj" ref="a2372fab551e83919d6d55010f881044f" args="() const " -->
const AtkAction* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#a2372fab551e83919d6d55010f881044f">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#a41aa7ecc13346d8f9a826d9d9cf88a57">do_action</a> (int i)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform the specified action on the object. <a href="#a41aa7ecc13346d8f9a826d9d9cf88a57"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#aa698f3d737de395afd3759c850cebba1">get_n_actions</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of accessible actions available on the object. <a href="#aa698f3d737de395afd3759c850cebba1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#a57dc505bf074239c89b31681e957ab83">get_description</a> (int i) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a description of the specified action of the object. <a href="#a57dc505bf074239c89b31681e957ab83"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#ae8bb8b740952594f5169b983a45e2b23">get_name</a> (int i) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the specified action of the object. <a href="#ae8bb8b740952594f5169b983a45e2b23"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#a4acdb52d10250f647be0c063cf21293f">get_keybinding</a> (int i)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a keybinding associated with this action, if one exists. <a href="#a4acdb52d10250f647be0c063cf21293f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#af157b00d0904b8dfde07048ec7980c77">set_description</a> (int i, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& desc)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a description of the specified action of the object. <a href="#af157b00d0904b8dfde07048ec7980c77"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#a346497af2820bd9d0db1c2944ac779cf">get_localized_name</a> (int i)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the localized name of the specified action of the object. <a href="#a346497af2820bd9d0db1c2944ac779cf"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1Action.html">Atk::Action</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#a7fec8f013e04cd52a8bb16a68ce3b6ff">wrap</a> (AtkAction* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a7fec8f013e04cd52a8bb16a68ce3b6ff"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The ATK interface provided by UI components which the user can activate/interact with, This should be implemented by instances of <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Atk::Object</a> classes with which the user can interact directly, i.e. </p>
<p>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 Atk::EditableText (insert/delete test, etc.) or <a class="el" href="classAtk_1_1Value.html" title="The ATK interface implemented by valuators and components which display or select a value from a boun...">Atk::Value</a> (set value) then these actions should not be exposed by <a class="el" href="classAtk_1_1Action.html" title="The ATK interface provided by UI components which the user can activate/interact with, This should be implemented by instances of Atk::Object classes with which the user can interact directly, i.e.">Atk::Action</a> as well.</p>
<p>Also note that the <a class="el" href="classAtk_1_1Action.html" title="The ATK interface provided by UI components which the user can activate/interact with, This should be implemented by instances of Atk::Object classes with which the user can interact directly, i.e.">Atk::Action</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 Atk::Actions. Where mouse and keyboard actions are redundant in effect, <a class="el" href="classAtk_1_1Action.html" title="The ATK interface provided by UI components which the user can activate/interact with, This should be implemented by instances of Atk::Object classes with which the user can interact directly, i.e.">Atk::Action</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="el" href="classAtk_1_1Action.html" title="The ATK interface provided by UI components which the user can activate/interact with, This should be implemented by instances of Atk::Object classes with which the user can interact directly, i.e.">Atk::Action</a> names. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a41aa7ecc13346d8f9a826d9d9cf88a57"></a><!-- doxytag: member="Atk::Action::do_action" ref="a41aa7ecc13346d8f9a826d9d9cf88a57" args="(int i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Atk::Action::do_action </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Perform the specified action on the object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>The action index corresponding to the action to be performed. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if success, <code>false</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a57dc505bf074239c89b31681e957ab83"></a><!-- doxytag: member="Atk::Action::get_description" ref="a57dc505bf074239c89b31681e957ab83" args="(int i) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Atk::Action::get_description </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em> )</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a description of the specified action of the object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>The action index corresponding to the action to be performed. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A description string, or <code>0</code> if <em>action</em> does not implement this interface. </dd></dl>
</div>
</div>
<a class="anchor" id="a4acdb52d10250f647be0c063cf21293f"></a><!-- doxytag: member="Atk::Action::get_keybinding" ref="a4acdb52d10250f647be0c063cf21293f" args="(int i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Atk::Action::get_keybinding </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a keybinding associated with this action, if one exists. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>The action index corresponding to the action to be performed. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A string representing the keybinding, or an empty string if there is no keybinding for this action. </dd></dl>
</div>
</div>
<a class="anchor" id="a346497af2820bd9d0db1c2944ac779cf"></a><!-- doxytag: member="Atk::Action::get_localized_name" ref="a346497af2820bd9d0db1c2944ac779cf" args="(int i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Atk::Action::get_localized_name </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the localized name of the specified action of the object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>The action index corresponding to the action to be performed. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A name string, or an empty string if <em>action</em> does not implement this interface. </dd></dl>
</div>
</div>
<a class="anchor" id="aa698f3d737de395afd3759c850cebba1"></a><!-- doxytag: member="Atk::Action::get_n_actions" ref="aa698f3d737de395afd3759c850cebba1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Atk::Action::get_n_actions </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the number of accessible actions available on the object. </p>
<p>If there are more than one, the first one is considered the "default" action of the object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A the number of actions, or 0 if <em>action</em> does not implement this interface. </dd></dl>
</div>
</div>
<a class="anchor" id="ae8bb8b740952594f5169b983a45e2b23"></a><!-- doxytag: member="Atk::Action::get_name" ref="ae8bb8b740952594f5169b983a45e2b23" args="(int i) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Atk::Action::get_name </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em> )</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the name of the specified action of the object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>The action index corresponding to the action to be performed. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A name string, or an empty string if <em>action</em> does not implement this interface. </dd></dl>
</div>
</div>
<a class="anchor" id="af157b00d0904b8dfde07048ec7980c77"></a><!-- doxytag: member="Atk::Action::set_description" ref="af157b00d0904b8dfde07048ec7980c77" args="(int i, const Glib::ustring &desc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Atk::Action::set_description </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>desc</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets a description of the specified action of the object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>The action index corresponding to the action to be performed. </td></tr>
<tr><td class="paramname">desc</td><td>The description to be assigned to this action. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <code>bool</code> representing if the description was successfully set;. </dd></dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a7fec8f013e04cd52a8bb16a68ce3b6ff"></a><!-- doxytag: member="Atk::Action::wrap" ref="a7fec8f013e04cd52a8bb16a68ce3b6ff" args="(AtkAction *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1Action.html">Atk::Action</a> > wrap </td>
<td>(</td>
<td class="paramtype">AtkAction * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_copy</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
<tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Mar 30 2011 09:27:41 for atkmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
</body>
</html>
