<!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::Value 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_1Value.html">Value</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::Value Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Atk::Value" --><!-- doxytag: inherits="Glib::Interface" -->
<p>The ATK interface implemented by valuators and components which display or select a value from a bounded range of values. <a href="#_details">More...</a></p>
<p><code>#include <atkmm/value.h></code></p>
<!-- startSectionHeader --><div class="dynheader">
Inheritance diagram for Atk::Value:<!-- endSectionHeader --></div>
<!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent">
<div class="center"><img src="classAtk_1_1Value__inherit__graph.png" border="0" usemap="#Atk_1_1Value_inherit__map" alt="Inheritance graph"/></div>
<map name="Atk_1_1Value_inherit__map" id="Atk_1_1Value_inherit__map">
<area shape="rect" id="node9" href="classAtk_1_1NoOpObject.html" title="An Atk::NoOpObject is an Atk::Object which purports to implement all ATK interfaces." alt="" coords="5,315,133,344"/><area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="15,160,124,189"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="7,83,132,112"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,5,127,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
<p><a href="classAtk_1_1Value-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="a1d492104dfbc24ca3586889e1c9dd122"></a><!-- doxytag: member="Atk::Value::gobj" ref="a1d492104dfbc24ca3586889e1c9dd122" args="()" -->
AtkValue* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Value.html#a1d492104dfbc24ca3586889e1c9dd122">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="a1e9774208afa33f5536d0af2f1542724"></a><!-- doxytag: member="Atk::Value::gobj" ref="a1e9774208afa33f5536d0af2f1542724" args="() const " -->
const AtkValue* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Value.html#a1e9774208afa33f5536d0af2f1542724">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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Value.html#a413b3aa759306e5453c52c3cc633bbdd">get_current_value</a> (<a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ValueBase.html">Glib::ValueBase</a>&<a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01191.html#ga1c9e781d8d15a3814a601f471797c825">value</a>) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the value of this object. <a href="#a413b3aa759306e5453c52c3cc633bbdd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Value.html#a05900879b78b99af2f608f8aa6225043">get_maximum_value</a> (<a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ValueBase.html">Glib::ValueBase</a>&<a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01191.html#ga1c9e781d8d15a3814a601f471797c825">value</a>) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the maximum value of this object. <a href="#a05900879b78b99af2f608f8aa6225043"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Value.html#aa846b94c5afd243ad9b6488f3c882b30">get_minimum_value</a> (<a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ValueBase.html">Glib::ValueBase</a>&<a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01191.html#ga1c9e781d8d15a3814a601f471797c825">value</a>) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the minimum value of this object. <a href="#aa846b94c5afd243ad9b6488f3c882b30"></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_1Value.html#a5f68e4192b070a56f2f5dbdc29d18ef1">set_current_value</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ValueBase.html">Glib::ValueBase</a>&<a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01191.html#ga1c9e781d8d15a3814a601f471797c825">value</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the value of this object. <a href="#a5f68e4192b070a56f2f5dbdc29d18ef1"></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_1Value.html">Atk::Value</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Value.html#a68a42fa970f6678863e0d5163fc58439">wrap</a> (AtkValue* 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="#a68a42fa970f6678863e0d5163fc58439"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The ATK interface implemented by valuators and components which display or select a value from a bounded range of values. </p>
<p>This should be implemented for components which either display a value from a bounded range, or which allow the user to specify a value from a bounded range, or both. For instance, most sliders and range controls, as well as dials, should have <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Atk::Object</a> representations which implement <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> on the component's behalf. Atk::Values may be read-only, in which case attempts to alter the value return false to indicate failure. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a413b3aa759306e5453c52c3cc633bbdd"></a><!-- doxytag: member="Atk::Value::get_current_value" ref="a413b3aa759306e5453c52c3cc633bbdd" args="(Glib::ValueBase &value) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Atk::Value::get_current_value </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ValueBase.html">Glib::ValueBase</a> & </td>
<td class="paramname"> <em>value</em> )</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the value of this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>A <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...">Value</a> representing the current accessible value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a05900879b78b99af2f608f8aa6225043"></a><!-- doxytag: member="Atk::Value::get_maximum_value" ref="a05900879b78b99af2f608f8aa6225043" args="(Glib::ValueBase &value) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Atk::Value::get_maximum_value </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ValueBase.html">Glib::ValueBase</a> & </td>
<td class="paramname"> <em>value</em> )</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the maximum value of this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>A <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...">Value</a> representing the maximum accessible value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa846b94c5afd243ad9b6488f3c882b30"></a><!-- doxytag: member="Atk::Value::get_minimum_value" ref="aa846b94c5afd243ad9b6488f3c882b30" args="(Glib::ValueBase &value) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Atk::Value::get_minimum_value </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ValueBase.html">Glib::ValueBase</a> & </td>
<td class="paramname"> <em>value</em> )</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the minimum value of this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>A <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...">Value</a> representing the minimum accessible value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5f68e4192b070a56f2f5dbdc29d18ef1"></a><!-- doxytag: member="Atk::Value::set_current_value" ref="a5f68e4192b070a56f2f5dbdc29d18ef1" args="(const Glib::ValueBase &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Atk::Value::set_current_value </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ValueBase.html">Glib::ValueBase</a> & </td>
<td class="paramname"> <em>value</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the value of this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>A <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...">Value</a> which is the desired new accessible value. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if new value is successfully set, <code>false</code> otherwise. </dd></dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a68a42fa970f6678863e0d5163fc58439"></a><!-- doxytag: member="Atk::Value::wrap" ref="a68a42fa970f6678863e0d5163fc58439" args="(AtkValue *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_1Value.html">Atk::Value</a> > wrap </td>
<td>(</td>
<td class="paramtype">AtkValue * </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>
