Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 643

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Interface XAccessibleValue</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XAccessibleValue-xref.html" class="navimain">Use</a></td>
<td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Accessibility/XAccessibleValue" class="navimain">Devguide</a></td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub">Attributes' Summary</td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Details</td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">accessibility</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XAccessibleValue</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>Implement this interface to give access to a single numerical value.

 </dd>
<dd><p>The <a href="XAccessibleValue.html">XAccessibleValue</a> interface represents a single
 numerical value and should be implemented by any class that supports
 numerical value like scroll bars and spin boxes. This interface lets
 you access the value and its upper and lower bounds.</p>

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 1.1.2</dd>
</dl>
<a name="devmanual"> </a><dl>
<dt><b>Developers Guide</b></dt>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Accessibility/XAccessibleValue">Accessibility - XAccessibleValue</a></dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getCurrentValue">getCurrentValue</a></td>
<td class="imsum_right">Returns the value of this object as a number.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setCurrentValue">setCurrentValue</a></td>
<td class="imsum_right">Sets the value of this object to the given number.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getMaximumValue">getMaximumValue</a></td>
<td class="imsum_right">Returns the maximal value that can be represented by this object.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getMinimumValue">getMinimumValue</a></td>
<td class="imsum_right">Returns the minimal value that can be represented by this object.
 
 &nbsp;</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="getCurrentValue" class="membertitle">getCurrentValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">any</td>
</tr>
<tr>
<td valign="top"><b>getCurrentValue</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns the value of this object as a number.
 
 </dd>
<dd><p>The exact return type is implementation dependent. Typical types
 are long and double.</p>
 
 </dd>
<dt><b>Returns</b></dt>
<dd>Returns the current value represented by this object.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setCurrentValue" class="membertitle">setCurrentValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">boolean</td>
</tr>
<tr>
<td valign="top"><b>setCurrentValue</b>(</td>
<td valign="top">[in] any</td>
<td valign="bottom">&nbsp;aNumber );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Sets the value of this object to the given number.
 
 </dd>
<dd><p>The argument is clipped to the valid interval whose upper and
 lower bounds are returned by the methods
 <a href="#getMaximumAccessibleValue">getMaximumAccessibleValue</a> and
 <a href="#getMinimumAccessibleValue">getMinimumAccessibleValue</a>, i.e. if it is lower than
 the minimum value the new value will be the minimum and if it is
 greater than the maximum then the new value will be the maximum.</p>
 
 </dd>
<dt><b>Parameter aNumber</b></dt>
<dd>The new value represented by this object. The set of admissible
 types for this argument is implementation dependent.
 
 </dd>
<dt><b>Returns</b></dt>
<dd>Returns <b>true</b> if the new value could successfully be set and
 <b>false</b> otherwise.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getMaximumValue" class="membertitle">getMaximumValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">any</td>
</tr>
<tr>
<td valign="top"><b>getMaximumValue</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns the maximal value that can be represented by this object.
 
 </dd>
<dd><p>The type of the returned value is implementation dependent. It
 does not have to be the same type as that returned by
 <a href="#getCurrentAccessibleValue">getCurrentAccessibleValue</a>.</p>
 
 </dd>
<dt><b>Returns</b></dt>
<dd>Returns the maximal value in an implementation dependent type.
 If this object has no upper bound then an empty object is
 returned.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getMinimumValue" class="membertitle">getMinimumValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">any</td>
</tr>
<tr>
<td valign="top"><b>getMinimumValue</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns the minimal value that can be represented by this object.
 
 </dd>
<dd><p>The type of the returned value is implementation dependent. It
 does not have to be the same type as that returned by
 <a href="#getCurrentAccessibleValue">getCurrentAccessibleValue</a>.</p>
 
 </dd>
<dt><b>Returns</b></dt>
<dd>Returns the minimal value in an implementation dependent type.
 If this object has no upper bound then an empty object is
 returned.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>