<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>gtkmm 2.4: Atk::Action Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%">
<tr>
<td width="10%" height="40"><img src="../../images/gtkmm_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td>
<td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td>
</tr>
</table>
<center>
<a class="qindex" href="../../index.html">Main Page</a>
<a href="group__Widgets.html">Widgets</a>
<a class="qindex" href="namespaces.html"> Namespaces</a>
<a href="../../tutorial/html/index.html"> Book</a>
</center>
<hr width="100%"/>
<!-- begin main content -->
<div id="content">
<!-- Generated by Doxygen 1.5.1 -->
<div class="nav">
<a class="el" href="namespaceAtk.html">Atk</a>::<a class="el" href="classAtk_1_1Action.html">Action</a></div>
<h1>Atk::Action Class Reference</h1><!-- doxytag: class="Atk::Action" --><!-- doxytag: inherits="Glib::Interface" -->Inheritance diagram for Atk::Action:<p><center><img src="classAtk_1_1Action__inherit__graph.png" border="0" usemap="#Atk_1_1Action__inherit__map" alt="Inheritance graph"></center>
<map name="Atk_1_1Action__inherit__map">
<area href="classAtk_1_1Hyperlink.html" shape="rect" coords="5,316,115,342" alt="">
<area href="classAtk_1_1NoOpObject.html" shape="rect" coords="139,316,267,342" alt="">
<area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1Interface.html" shape="rect" coords="76,161,185,188" alt="">
<area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ObjectBase.html" shape="rect" coords="68,84,193,110" alt="">
<area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classsigc_1_1trackable.html" shape="rect" coords="75,6,187,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classAtk_1_1Action-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
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">Atk::Object</a> classes with which the user can interact directly, i.e.
<p>
buttons, checkboxes, scrollbars, e.g. components which are not "passive" providers of UI information.<p>
Exceptions: when the user interaction is already covered by another appropriate interface such as <a class="el" href="classAtk_1_1EditableText.html">Atk::EditableText</a> (insert/delete test, etc.) or <a class="el" href="classAtk_1_1Value.html">Atk::Value</a> (set value) then these actions should not be exposed by <a class="el" href="classAtk_1_1Action.html">Atk::Action</a> as well.<p>
Also note that the <a class="el" href="classAtk_1_1Action.html">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>
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">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">Atk::Action</a> names.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#41aa7ecc13346d8f9a826d9d9cf88a57">do_action</a> (int i)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform the specified action on the object. <a href="#41aa7ecc13346d8f9a826d9d9cf88a57"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#af1bd0979aaa968ca3e06e1407193aa3">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="#af1bd0979aaa968ca3e06e1407193aa3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#4acdb52d10250f647be0c063cf21293f">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="#4acdb52d10250f647be0c063cf21293f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#346497af2820bd9d0db1c2944ac779cf">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="#346497af2820bd9d0db1c2944ac779cf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#1f9658e7b05e7692be9f5342d66f198a">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="#1f9658e7b05e7692be9f5342d66f198a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#3deb64744279c101e34d1ac4da9682e7">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="#3deb64744279c101e34d1ac4da9682e7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const AtkAction* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#fcc02b91985956b86f074f645a75bbbb">gobj</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#fcc02b91985956b86f074f645a75bbbb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">AtkAction* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#922d5d2a5c8af62cdea07810b229094e">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#922d5d2a5c8af62cdea07810b229094e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#f157b00d0904b8dfde07048ec7980c77">set_description</a> (int i, const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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="#f157b00d0904b8dfde07048ec7980c77"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#09983d16957cd2aca30af1ab58aafd57">~Action</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#2e7470667a8a5a98a1a199111e80bc35">add_interface</a> (GType gtype_implementer)</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#13d4c4e640ce5583e806f0d9dcefd437">do_action_vfunc</a> (int i)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#f5fc9631006e7f516e7cc75e1b9c0bf0">get_description_vfunc</a> (int i) const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#bb427d9c80799348fa717f41ed8a9e5a">get_keybinding_vfunc</a> (int i) const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#191f1250c5c3d4cf894c14b01eb29d65">get_n_actions_vfunc</a> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#d6f527150747788bbedeccccf3b8adb9">get_name_vfunc</a> (int i) const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Action.html#94c613c958a84eac9610ca84bc78d0be">set_description_vfunc</a> (int i, const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& desc)</td></tr>
<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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#7fec8f013e04cd52a8bb16a68ce3b6ff">wrap</a> (AtkAction* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#7fec8f013e04cd52a8bb16a68ce3b6ff"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="09983d16957cd2aca30af1ab58aafd57"></a><!-- doxytag: member="Atk::Action::~Action" ref="09983d16957cd2aca30af1ab58aafd57" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Atk::Action::~Action </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2e7470667a8a5a98a1a199111e80bc35"></a><!-- doxytag: member="Atk::Action::add_interface" ref="2e7470667a8a5a98a1a199111e80bc35" args="(GType gtype_implementer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void Atk::Action::add_interface </td>
<td>(</td>
<td class="paramtype">GType </td>
<td class="paramname"> <em>gtype_implementer</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="41aa7ecc13346d8f9a826d9d9cf88a57"></a><!-- doxytag: member="Atk::Action::do_action" ref="41aa7ecc13346d8f9a826d9d9cf88a57" 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>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Perform the specified action on the object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>The action index corresponding to the action to be performed. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if success, <code>false</code> otherwise. </dd></dl>
</div>
</div><p>
<a class="anchor" name="13d4c4e640ce5583e806f0d9dcefd437"></a><!-- doxytag: member="Atk::Action::do_action_vfunc" ref="13d4c4e640ce5583e806f0d9dcefd437" args="(int i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool Atk::Action::do_action_vfunc </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em> </td>
<td> ) </td>
<td width="100%"><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="af1bd0979aaa968ca3e06e1407193aa3"></a><!-- doxytag: member="Atk::Action::get_description" ref="af1bd0979aaa968ca3e06e1407193aa3" args="(int i) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a description of the specified action of the object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>The action index corresponding to the action to be performed. </td></tr>
</table>
</dl>
<dl class="return" compact><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><p>
<a class="anchor" name="f5fc9631006e7f516e7cc75e1b9c0bf0"></a><!-- doxytag: member="Atk::Action::get_description_vfunc" ref="f5fc9631006e7f516e7cc75e1b9c0bf0" args="(int i) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* Atk::Action::get_description_vfunc </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em> </td>
<td> ) </td>
<td width="100%"> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="4acdb52d10250f647be0c063cf21293f"></a><!-- doxytag: member="Atk::Action::get_keybinding" ref="4acdb52d10250f647be0c063cf21293f" args="(int i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a keybinding associated with this action, if one exists.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>The action index corresponding to the action to be performed. </td></tr>
</table>
</dl>
<dl class="return" compact><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><p>
<a class="anchor" name="bb427d9c80799348fa717f41ed8a9e5a"></a><!-- doxytag: member="Atk::Action::get_keybinding_vfunc" ref="bb427d9c80799348fa717f41ed8a9e5a" args="(int i) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* Atk::Action::get_keybinding_vfunc </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em> </td>
<td> ) </td>
<td width="100%"> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="346497af2820bd9d0db1c2944ac779cf"></a><!-- doxytag: member="Atk::Action::get_localized_name" ref="346497af2820bd9d0db1c2944ac779cf" args="(int i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the localized name of the specified action of the object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>The action index corresponding to the action to be performed. </td></tr>
</table>
</dl>
<dl class="return" compact><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><p>
<a class="anchor" name="1f9658e7b05e7692be9f5342d66f198a"></a><!-- doxytag: member="Atk::Action::get_n_actions" ref="1f9658e7b05e7692be9f5342d66f198a" 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> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the number of accessible actions available on the object.
<p>
If there are more than one, the first one is considered the "default" action of the object. <dl class="return" compact><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><p>
<a class="anchor" name="191f1250c5c3d4cf894c14b01eb29d65"></a><!-- doxytag: member="Atk::Action::get_n_actions_vfunc" ref="191f1250c5c3d4cf894c14b01eb29d65" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int Atk::Action::get_n_actions_vfunc </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="3deb64744279c101e34d1ac4da9682e7"></a><!-- doxytag: member="Atk::Action::get_name" ref="3deb64744279c101e34d1ac4da9682e7" args="(int i) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the name of the specified action of the object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>The action index corresponding to the action to be performed. </td></tr>
</table>
</dl>
<dl class="return" compact><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><p>
<a class="anchor" name="d6f527150747788bbedeccccf3b8adb9"></a><!-- doxytag: member="Atk::Action::get_name_vfunc" ref="d6f527150747788bbedeccccf3b8adb9" args="(int i) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* Atk::Action::get_name_vfunc </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em> </td>
<td> ) </td>
<td width="100%"> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="fcc02b91985956b86f074f645a75bbbb"></a><!-- doxytag: member="Atk::Action::gobj" ref="fcc02b91985956b86f074f645a75bbbb" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const AtkAction* Atk::Action::gobj </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C GObject.
<p>
<p>
Reimplemented from <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1Interface.html#4737c92fa9930b4f006ab8b3c9487504">Glib::Interface</a>.
<p>
Reimplemented in <a class="el" href="classAtk_1_1Hyperlink.html#6d50582abfbd5d22208432b8ea067483">Atk::Hyperlink</a>, and <a class="el" href="classAtk_1_1NoOpObject.html#c568dcb09803b94280462f1f9b94a889">Atk::NoOpObject</a>.
</div>
</div><p>
<a class="anchor" name="922d5d2a5c8af62cdea07810b229094e"></a><!-- doxytag: member="Atk::Action::gobj" ref="922d5d2a5c8af62cdea07810b229094e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AtkAction* Atk::Action::gobj </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C GObject.
<p>
<p>
Reimplemented from <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1Interface.html#969e9396f75132a9577428f4fa932d42">Glib::Interface</a>.
<p>
Reimplemented in <a class="el" href="classAtk_1_1Hyperlink.html#99f2d77401d7707606714aaa2299a0b6">Atk::Hyperlink</a>, and <a class="el" href="classAtk_1_1NoOpObject.html#aad07a3a8ce4dea968c53f0098498836">Atk::NoOpObject</a>.
</div>
</div><p>
<a class="anchor" name="f157b00d0904b8dfde07048ec7980c77"></a><!-- doxytag: member="Atk::Action::set_description" ref="f157b00d0904b8dfde07048ec7980c77" 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" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>desc</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets a description of the specified action of the object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>The action index corresponding to the action to be performed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>desc</em> </td><td>The description to be assigned to this action. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A <code>bool</code> representing if the description was successfully set;. </dd></dl>
</div>
</div><p>
<a class="anchor" name="94c613c958a84eac9610ca84bc78d0be"></a><!-- doxytag: member="Atk::Action::set_description_vfunc" ref="94c613c958a84eac9610ca84bc78d0be" args="(int i, const Glib::ustring &desc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool Atk::Action::set_description_vfunc </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" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>desc</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="7fec8f013e04cd52a8bb16a68ce3b6ff"></a><!-- doxytag: member="Atk::Action::wrap" ref="7fec8f013e04cd52a8bb16a68ce3b6ff" args="(AtkAction *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>take_copy</em> </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>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="atk_2atkmm_2action_8h.html">atk/atkmm/action.h</a></ul>
</div>
<!-- end main content -->
<hr><address><small>
Generated for gtkmm 2.4 by <a href="http://www.doxygen.org/index.html">
Doxygen</a> 1.5.1 © 1997-2001</small></address>
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
9411cff4bc6d4e61b29ae81cd24665af
>
files
>
63
