Sophie

Sophie

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

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

<html>
<head>
<title>Interface XContainerQuery</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="XContainerQuery-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</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">container</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XContainerQuery</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>supports simple query feature on a container

 </dd>
<dd><p>
 This interface makes it possible to create sub sets of container items
 which serve specified search criterion.
 <p>
 </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="#createSubSetEnumerationByQuery">createSubSetEnumerationByQuery</a></td>
<td class="imsum_right">creates a sub set of container items which match given query command

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#createSubSetEnumerationByProperties">createSubSetEnumerationByProperties</a></td>
<td class="imsum_right">creates a sub set of container items which supports searched properties as minimum

 &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="createSubSetEnumerationByQuery" class="membertitle">createSubSetEnumerationByQuery</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"><a href="XEnumeration.html">XEnumeration</a></td>
</tr>
<tr>
<td valign="top"><b>createSubSetEnumerationByQuery</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;Query );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>creates a sub set of container items which match given query command

 </dd>
<dd><p>
 Items of this sub set must match used query string. Format of query depends
 from real implementation. Using of "param=value" pairs isn't neccessary.
 So it's possible to combine different parameters as one simple command
 string.
 <p>

 </dd>
<dt><b>Parameter Query</b></dt>
<dd>items of sub set must match to this query<br>
 example:<br>
 (1)<br>
 query as parameter sequence to return all elements wich match
 the name pattern and supports a special feature; sort it ascending<br>
 "name=*myname_??_;sort=ascending;feature=VISIBLE"<br>
 (2)<br>
 query as command to return all elements which support special feature
 and match by name pattern;ascending sort is the default<br>
 "getAllVisible(*myname_??_)"<br>

 </dd>
<dt><b>Returns</b></dt>
<dd>an sub set of container items as an enumeration.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="createSubSetEnumerationByProperties" class="membertitle">createSubSetEnumerationByProperties</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"><a href="XEnumeration.html">XEnumeration</a></td>
</tr>
<tr>
<td valign="top"><b>createSubSetEnumerationByProperties</b>(</td>
<td valign="top">[in] sequence&lt; ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/NamedValue.html">NamedValue</a> &gt;</td>
<td valign="bottom">&nbsp;Properties );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>creates a sub set of container items which supports searched properties as minimum

 </dd>
<dd><p>
 It's not possible to use special commands or search specific parameters here.
 You can match by properties only. Enumerated elements must provide queried
 properties as minimum. Not specified properties willn't be used for searching.
 <p>

 </dd>
<dt><b>Parameter Properties</b></dt>
<dd>items of sub set must support given properties as minimum<br>
 example:<br>
 (supported)<br>
 search for items wich match the name pattern and supports the VISIBLE feature<br>
 Parameters[0].Name = "name"<br>
 Parameters[0].Value = "*myname_??_"<br>
 Parameters[1].Name = "feature"<br>
 Parameters[1].Value = "VISIBLE"<br>
 ...<br>
 (unsupported)<br>
 "sort" isn't a property of a container item!
 Parameters[0].Name = "sort"<br>
 Parameters[0].Value = "ascending"<br>
 ...<br>

 </dd>
<dt><b>Returns</b></dt>
<dd>an sub set of container items as an enumeration.
 </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>