Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 7721

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Interface XSortable</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="XSortable-xref.html" class="navimain">Use</a></td>
<td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Text/Sorting_Text" 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"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Summary</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">util</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XSortable</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>makes it possible to sort the contents of this object.

 </dd>
<dd><p>The available properties describing the sort criterias are 
 defined in the sort descriptor implemented by the object that
 implements this interface.</p>

 <p>There are older deprecated sort descriptors:</p>
 <ul>
 <li>com::sun::star::util::SortDescriptor</li>
 <li>com::sun::star::table::TableSortDescriptor</li>
 <li>com::sun::star::text::TextSortDescriptor</li>
 </ul>
 
 <p>And a new set of sort descriptors:</p>
 <ul>
 <li>com::sun::star::util::SortDescriptor2</li>
 <li>com::sun::star::table::TableSortDescriptor2</li>
 <li>com::sun::star::text::TextSortDescriptor2</li>
 </ul>

 <p>Both types may be implemented by the same object.
 When calling the sort method however properties from different
 descriptors must not be mixed.</p>
 </dd>
</dl>
<a name="devmanual"> </a><dl>
<dt><b>Developers Guide</b></dt>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Text/Sorting_Text">Text - Sorting Text</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="#createSortDescriptor">createSortDescriptor</a></td>
<td class="imsum_right">&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#sort">sort</a></td>
<td class="imsum_right">sorts the contents of the object according to the specified
 properties.

 &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="createSortDescriptor" class="membertitle">createSortDescriptor</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">sequence&lt; ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> &gt;</td>
</tr>
<tr>
<td valign="top"><b>createSortDescriptor</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Returns</b></dt>
<dd>a sequence of properties which allows to specify/modify the 
 sort criteria.

 <p>The set of properties is specific to the type of object that 
 implements this interface. Therefore they can usually be used
 only for objects of that same type.</p>

 </dd>
<dt><b>See also</b></dt>
<dd><a href="SortDescriptor.html">SortDescriptor</a>, ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/TableSortDescriptor.html">TableSortDescriptor</a>, ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/TextSortDescriptor.html">TextSortDescriptor</a>, <a href="SortDescriptor2.html">SortDescriptor2</a>, ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/TableSortDescriptor2.html">TableSortDescriptor2</a>, ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/TextSortDescriptor2.html">TextSortDescriptor2</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="sort" class="membertitle">sort</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">void</td>
</tr>
<tr>
<td valign="top"><b>sort</b>(</td>
<td valign="top">[in] sequence&lt; ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> &gt;</td>
<td valign="bottom">&nbsp;xDescriptor );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>sorts the contents of the object according to the specified
 properties.

 </dd>
<dd><p>The specified properties are usually the same or a subset of 
 those obtained by calling <a href="#createSortDescriptor">createSortDescriptor</a> 
 on the same type of object.<p>

 </dd>
<dt><b>See also</b></dt>
<dd><a href="SortDescriptor.html">SortDescriptor</a>, ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/TableSortDescriptor.html">TableSortDescriptor</a>, ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/TextSortDescriptor.html">TextSortDescriptor</a>, <a href="SortDescriptor2.html">SortDescriptor2</a>, ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/TableSortDescriptor2.html">TableSortDescriptor2</a>, ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/TextSortDescriptor2.html">TextSortDescriptor2</a></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; 2008 Sun Microsystems, Inc.</p>

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

</html>