<!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>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%"/> <!-- Generated by Doxygen 1.3-rc1 --> <h1>Atk::Action Class Reference</h1>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_1NoOpObject.html" shape="rect" coords="7,225,119,243" alt=""> <area href="classGlib_1_1Interface.html" shape="rect" coords="16,86,109,105" alt=""> <area href="classGlib_1_1ObjectBase.html" shape="rect" coords="8,17,117,35" 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><table border=0 cellpadding=0 cellspacing=0> <tr><td></td></tr> <tr><td colspan=2><br><h2>Public Methods</h2></td></tr> <tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classAtk_1_1Action.html#a0">~Action</a> ()</td></tr> <tr><td nowrap align=right valign=top>AtkAction* </td><td valign=bottom><a class="el" href="classAtk_1_1Action.html#a1">gobj</a> ()</td></tr> <tr><td nowrap align=right valign=top>const AtkAction* </td><td valign=bottom><a class="el" href="classAtk_1_1Action.html#a2">gobj</a> () const</td></tr> <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classAtk_1_1Action.html#a3">do_action</a> (int i)</td></tr> <tr><td> </td><td><font size=-1><em>Perform the specified action on the object.</em> <a href="#a3"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classAtk_1_1Action.html#a4">get_n_actions</a> () const</td></tr> <tr><td> </td><td><font size=-1><em>Gets the number of accessible actions available on the object.</em> <a href="#a4"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top><a class="el" href="classGlib_1_1ustring.html">Glib::ustring</a> </td><td valign=bottom><a class="el" href="classAtk_1_1Action.html#a5">get_description</a> (int i) const</td></tr> <tr><td> </td><td><font size=-1><em>Returns a description of the specified action of the object.</em> <a href="#a5"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top><a class="el" href="classGlib_1_1ustring.html">Glib::ustring</a> </td><td valign=bottom><a class="el" href="classAtk_1_1Action.html#a6">get_name</a> (int i) const</td></tr> <tr><td> </td><td><font size=-1><em>Returns the name of the specified action of the object.</em> <a href="#a6"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top><a class="el" href="classGlib_1_1ustring.html">Glib::ustring</a> </td><td valign=bottom><a class="el" href="classAtk_1_1Action.html#a7">get_keybinding</a> (int i)</td></tr> <tr><td> </td><td><font size=-1><em>Returns a keybinding associated with this action, if one exists.</em> <a href="#a7"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classAtk_1_1Action.html#a8">set_description</a> (int i, const <a class="el" href="classGlib_1_1ustring.html">Glib::ustring</a>& desc)</td></tr> <tr><td> </td><td><font size=-1><em>Sets a description of the specified action of the object.</em> <a href="#a8"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top><a class="el" href="classGlib_1_1ustring.html">Glib::ustring</a> </td><td valign=bottom><a class="el" href="classAtk_1_1Action.html#a9">get_localized_name</a> (int i)</td></tr> <tr><td> </td><td><font size=-1><em>Returns the localized name of the specified action of the object.</em> <a href="#a9"></a><em></em></font><br><br></td></tr> <tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classAtk_1_1Action.html#d0">add_interface</a> (GType gtype_implementer)</td></tr> <tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> <tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classAtk_1_1Action.html#b0">do_action_vfunc</a> (int i)</td></tr> <tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="classAtk_1_1Action.html#b1">get_n_actions_vfunc</a> ()</td></tr> <tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="classAtk_1_1Action.html#b2">get_description_vfunc</a> (int i)</td></tr> <tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="classAtk_1_1Action.html#b3">get_name_vfunc</a> (int i)</td></tr> <tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="classAtk_1_1Action.html#b4">get_keybinding_vfunc</a> (int i)</td></tr> <tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classAtk_1_1Action.html#b5">set_description_vfunc</a> (int i, const <a class="el" href="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 nowrap align=right valign=top><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><Atk::Action> </td><td valign=bottom><a class="el" href="classAtk_1_1Action.html#k0">wrap</a> (AtkAction* object, bool take_copy=false)</td></tr> </table> <hr><h2>Constructor & Destructor Documentation</h2> <a name="a0" doxytag="Atk::Action::~Action"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual Atk::Action::~Action </td> <td class="md" valign="top">(</td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <hr><h2>Member Function Documentation</h2> <a name="d0" doxytag="Atk::Action::add_interface"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Atk::Action::add_interface </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top">GType </td> <td class="mdname1" valign="top" nowrap> <em>gtype_implementer</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [static]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a3" doxytag="Atk::Action::do_action"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool Atk::Action::do_action </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top">int </td> <td class="mdname1" valign="top" nowrap> <em>i</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <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><em>i</em> </td><td>The action index corresponding to the action to be performed. </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if success, <code>false</code> otherwise. </dd></dl> </td> </tr> </table> <a name="b0" doxytag="Atk::Action::do_action_vfunc"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual bool Atk::Action::do_action_vfunc </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top">int </td> <td class="mdname1" valign="top" nowrap> <em>i</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [protected, virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a5" doxytag="Atk::Action::get_description"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classGlib_1_1ustring.html">Glib::ustring</a> Atk::Action::get_description </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top">int </td> <td class="mdname1" valign="top" nowrap> <em>i</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap> const</td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <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><em>i</em> </td><td>The action index corresponding to the action to be performed. </td></tr> </table> </dl> <dl 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> </td> </tr> </table> <a name="b2" doxytag="Atk::Action::get_description_vfunc"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual const char* Atk::Action::get_description_vfunc </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top">int </td> <td class="mdname1" valign="top" nowrap> <em>i</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [protected, virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a7" doxytag="Atk::Action::get_keybinding"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classGlib_1_1ustring.html">Glib::ustring</a> Atk::Action::get_keybinding </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top">int </td> <td class="mdname1" valign="top" nowrap> <em>i</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <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><em>i</em> </td><td>The action index corresponding to the action to be performed. </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>A string representing the keybinding, or <code>0</code> if there is no keybinding for this action. </dd></dl> </td> </tr> </table> <a name="b4" doxytag="Atk::Action::get_keybinding_vfunc"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual const char* Atk::Action::get_keybinding_vfunc </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top">int </td> <td class="mdname1" valign="top" nowrap> <em>i</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [protected, virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a9" doxytag="Atk::Action::get_localized_name"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classGlib_1_1ustring.html">Glib::ustring</a> Atk::Action::get_localized_name </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top">int </td> <td class="mdname1" valign="top" nowrap> <em>i</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <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><em>i</em> </td><td>The action index corresponding to the action to be performed. </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>A name string, or <code>0</code> if <em>action</em> does not implement this interface. </dd></dl> </td> </tr> </table> <a name="a4" doxytag="Atk::Action::get_n_actions"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int Atk::Action::get_n_actions </td> <td class="md" valign="top">(</td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap> const</td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <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 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> </td> </tr> </table> <a name="b1" doxytag="Atk::Action::get_n_actions_vfunc"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual int Atk::Action::get_n_actions_vfunc </td> <td class="md" valign="top">(</td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [protected, virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a6" doxytag="Atk::Action::get_name"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classGlib_1_1ustring.html">Glib::ustring</a> Atk::Action::get_name </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top">int </td> <td class="mdname1" valign="top" nowrap> <em>i</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap> const</td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <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><em>i</em> </td><td>The action index corresponding to the action to be performed. </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>A name string, or <code>0</code> if <em>action</em> does not implement this interface. </dd></dl> </td> </tr> </table> <a name="b3" doxytag="Atk::Action::get_name_vfunc"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual const char* Atk::Action::get_name_vfunc </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top">int </td> <td class="mdname1" valign="top" nowrap> <em>i</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [protected, virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a2" doxytag="Atk::Action::gobj"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> const AtkAction* Atk::Action::gobj </td> <td class="md" valign="top">(</td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap> const<code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <p> Reimplemented from <a class="el" href="classGlib_1_1Interface.html#a4">Glib::Interface</a>. <p> Reimplemented in <a class="el" href="classAtk_1_1NoOpObject.html#a2">Atk::NoOpObject</a>. </td> </tr> </table> <a name="a1" doxytag="Atk::Action::gobj"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> AtkAction* Atk::Action::gobj </td> <td class="md" valign="top">(</td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <p> Reimplemented from <a class="el" href="classGlib_1_1Interface.html#a3">Glib::Interface</a>. <p> Reimplemented in <a class="el" href="classAtk_1_1NoOpObject.html#a1">Atk::NoOpObject</a>. </td> </tr> </table> <a name="a8" doxytag="Atk::Action::set_description"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool Atk::Action::set_description </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top">int </td> <td class="mdname" nowrap> <em>i</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="classGlib_1_1ustring.html">Glib::ustring</a>& </td> <td class="mdname" nowrap> <em>desc</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <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><em>i</em> </td><td>The action index corresponding to the action to be performed. </td></tr> <tr><td valign=top><em>desc</em> </td><td>The description to be assigned to this action. </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>A <code>bool</code> representing if the description was successfully set;. </dd></dl> </td> </tr> </table> <a name="b5" doxytag="Atk::Action::set_description_vfunc"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual bool Atk::Action::set_description_vfunc </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top">int </td> <td class="mdname" nowrap> <em>i</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="classGlib_1_1ustring.html">Glib::ustring</a>& </td> <td class="mdname" nowrap> <em>desc</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [protected, virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <hr><h2>Friends And Related Function Documentation</h2> <a name="k0" doxytag="Atk::Action::wrap"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><Atk::Action> wrap </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top">AtkAction* </td> <td class="mdname" nowrap> <em>object</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>bool </td> <td class="mdname" nowrap> <em>take_copy</em> = false</td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [related]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="action_8h.html">action.h</a></ul> <hr><address><small> Generated for gtkmm by <a href="http://www.doxygen.org/index.html"> Doxygen</a> 1.3-rc1 © 1997-2001</small></address> </body> </html>