Google Git
Sign in
apache / openoffice-org / refs/heads/main / . / content / udk / cpp / ref / names / cppu / c-OPropertyArrayHelper.html
blob: 54e7026d45b8c79378128987e11ec6e83539cf86 [file] [log] [blame]
<html>
<head>
<title>class OPropertyArrayHelper</title>
<style> h1 { font-size:20pt; margin-top:3pt; margin-bottom:7pt; }
h2 { font-family:"Arial"; font-size:16pt; margin-top:3pt; margin-bottom:5pt; }
h3 { font-size:13pt; margin-top:2pt; margin-bottom:3pt; }
h4 { font-size:10pt; font-weight:bold; margin-top:2pt; margin-bottom:1pt; }
dl { margin-top:1pt; margin-bottom:1pt; }
dl.member { margin-top:1pt; margin-bottom:1pt; background-color:#eeeeff; }
dt { font-size:10pt; font-weight:bold; margin-top:2pt; margin-bottom:1pt; }
dt.member { font-size:13pt; font-weight:bold; margin-top:2pt; margin-bottom:1pt; }
dt.simple { font-size:10pt; font-weight:normal; margin-top:2pt; margin-bottom:1pt; }
dd { font-size:10pt; margin-top:1pt; margin-bottom:1pt; }
dd.member { font-size:10pt; margin-top:1pt; margin-bottom:1pt; background-color:#ffffff; }
p { font-size:10pt; margin-top:3pt; margin-bottom:1pt; }
pre { font-family: Times, serif; font-size:10pt; margin-top:1pt; margin-bottom:1pt; }
tr { font-size:10pt; }
td { font-size:10pt; }
</style>
<meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
</head>
<body bgcolor="#ffffff">
<a name="_top_"> </a>
<table border="0" cellpadding="1" cellspacing="0">
<tr align="center" valign="top">
<td bgcolor="#eeeeff">&nbsp;<a href="../../index.html" alt><font family="Arial" color="#000000" size="+1"><b>Overview</b></font></a>&nbsp;</td>
<td bgcolor="#eeeeff">&nbsp;<a href="index.html" alt><font family="Arial" color="#000000" size="+1"><b>Namespace</b></font></a>&nbsp;</td>
<td bgcolor="#2222ad">&nbsp;<font family="Arial" color="#ffffff" size="+1"><b>Class</b></font>&nbsp;</td>
<td bgcolor="#eeeeff">&nbsp;<a href="../../index-files/index-1.html" alt><font family="Arial" color="#000000" size="+1"><b>Index</b></font></a>&nbsp;</td>
<td bgcolor="#eeeeff">&nbsp;<a href="../../help.html" alt><font family="Arial" color="#000000" size="+1"><b>Help</b></font></a>&nbsp;</td>
</tr>
</table>
<table cellpadding="0" cellspacing="3">
<tr>
<td width="20%"><font size="-2">PUBLIC MEMBERS:</font></td>
<td>
&nbsp;<font size="-2">CLASSES</font>
|&nbsp;<font size="-2">STRUCTS</font>
|&nbsp;<font size="-2">UNIONS</font>
|&nbsp;<font size="-2">ENUMS</font>
|&nbsp;<font size="-2">TYPEDEFS</font>
|&nbsp;<a href="#publ_ops"><font size="-2"><b>METHODS</b></font></a>
|&nbsp;<font size="-2">STATIC METHODS</font>
|&nbsp;<font size="-2">DATA</font>
|&nbsp;<font size="-2">STATIC DATA</font></td>
</tr>
<tr>
<td width="20%"><font size="-2">PROTECTED MEMBERS:</font></td>
<td>
&nbsp;<font size="-2">CLASSES</font>
|&nbsp;<font size="-2">STRUCTS</font>
|&nbsp;<font size="-2">UNIONS</font>
|&nbsp;<font size="-2">ENUMS</font>
|&nbsp;<font size="-2">TYPEDEFS</font>
|&nbsp;<font size="-2">METHODS</font>
|&nbsp;<font size="-2">STATIC METHODS</font>
|&nbsp;<a href="#prot_vars"><font size="-2"><b>DATA</b></font></a>
|&nbsp;<font size="-2">STATIC DATA</font></td>
</tr>
<tr>
<td width="20%"><font size="-2">PRIVATE MEMBERS:</font></td>
<td>
&nbsp;<font size="-2">CLASSES</font>
|&nbsp;<font size="-2">STRUCTS</font>
|&nbsp;<font size="-2">UNIONS</font>
|&nbsp;<font size="-2">ENUMS</font>
|&nbsp;<font size="-2">TYPEDEFS</font>
|&nbsp;<a href="#priv_ops"><font size="-2"><b>METHODS</b></font></a>
|&nbsp;<font size="-2">STATIC METHODS</font>
|&nbsp;<a href="#priv_vars"><font size="-2"><b>DATA</b></font></a>
|&nbsp;<font size="-2">STATIC DATA</font></td>
</tr>
</table>
<hr>
<a href="../../names/index.html" alt="Global Namespace in C++"><font size="+1"><b>::</b></font></a> <a href="index.html" alt="namespace"><font size="+1"><b>cppu</b></font></a><font size="+1"> :: </font><div align="center" style="background-color:#ccccff; line-height:26pt;"><h2>class OPropertyArrayHelper</h2>
</div><hr>
<dl>
<dt>Base Classes</dt>
<dd><pre style="font-family:monospace;">
<span style="color:#33ff33;"><a href="c-IPropertyArrayHelper.html">IPropertyArrayHelper</a> (public)</span>
|
+--<strong>OPropertyArrayHelper</strong>
</pre></dd>
</dl>
<dl>
<dt>Known Derived Classes</dt>
<dd>None.</dd>
</dl>
<br>
<table border cellspacing="0">
<tr>
<td bgcolor="#eeeeff" width="25%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td>
<td bgcolor="#eeeeff" width="25%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td>
<td bgcolor="#eeeeff" width="25%" style="font-family:Arial; font-size:8pt; font-weight:bold;">interface</td>
<td bgcolor="#eeeeff" width="25%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td>
</tr>
<tr>
<td style="font-family:Arial; font-size:8pt; font-weight:bold;">YES</td>
<td style="font-family:Arial; font-size:8pt;">NO</td>
<td style="font-family:Arial; font-size:8pt;">NO</td>
<td style="font-family:Arial; font-size:8pt;">NO</td>
</tr>
</table>
<dl>
<dt>Summary</dt>
<dd>You can use this helper class to map a XPropertySet-Interface to a XFast-
or a XMultiPropertySet interface.
</dd>
</dl>
<dl>
<dt>File</dt>
<dd>propshlp.hxx</dd>
</dl>
<hr>
<dl>
<dt bgcolor="#CCCCFF"><a name="publ_"><h3>Public Members</h3>
</a>
</dt>
<dd><a name="publ_ops"> </a>
<table cellpadding="5" cellspacing="0" width="100%">
<tr bgcolor="#CCCCFF">
<td colspan="2"><h4>Methods</h4>
</td>
</tr>
<tr>
<td> <br>
<a href="OPropertyArrayHelper/o.html#OPropertyArrayHelper-977">OPropertyArrayHelper</a>( ::com::sun::star::beans::Property * pProps, sal_Int32 nElements, sal_Bool bSorted = sal_True ) throw( );</td>
<td width="50%"> Create an object which supports the common property interfaces.
</td>
</tr>
<tr>
<td> <br>
<a href="OPropertyArrayHelper/o.html#OPropertyArrayHelper-978">OPropertyArrayHelper</a>( const ::com::sun::star::uno::Sequence&lt; ::com::sun::star::beans::Property &gt; &amp; aProps, sal_Bool bSorted = sal_True ) throw( );</td>
<td width="50%"> Create an object which supports the common property interfaces.
</td>
</tr>
<tr>
<td>sal_Int32 <br>
<a href="OPropertyArrayHelper/o.html#getCount-5">getCount</a>( ) const throw( );</td>
<td width="50%"> Return the number of properties.
</td>
</tr>
<tr>
<td>virtual sal_Bool <br>
<a href="OPropertyArrayHelper/o.html#fillPropertyMembersByHandle-979">fillPropertyMembersByHandle</a>( ::rtl::OUString * pPropName, sal_Int16 * pAttributes, sal_Int32 nHandle );</td>
<td width="50%"> Return the property members Name and Attribute from the handle nHandle.
</td>
</tr>
<tr>
<td>virtual ::com::sun::star::uno::Sequence&lt; ::com::sun::star::beans::Property &gt; <br>
<a href="OPropertyArrayHelper/o.html#getProperties-980">getProperties</a>( void );</td>
<td width="50%"> Return the sequence of properties. The sequence is sorted by name.
</td>
</tr>
<tr>
<td>virtual ::com::sun::star::beans::Property <br>
<a href="OPropertyArrayHelper/o.html#getPropertyByName-981">getPropertyByName</a>( const ::rtl::OUString &amp; rPropertyName ) throw( ::com::sun::star::beans::UnknownPropertyException );</td>
<td width="50%"> Return the property with the name rPropertyName.
</td>
</tr>
<tr>
<td>virtual sal_Bool <br>
<a href="OPropertyArrayHelper/o.html#hasPropertyByName-981">hasPropertyByName</a>( const ::rtl::OUString &amp; rPropertyName );</td>
<td width="50%"> Return true if the property with the name rPropertyName exist, otherwise false.
</td>
</tr>
<tr>
<td>virtual sal_Int32 <br>
<a href="OPropertyArrayHelper/o.html#getHandleByName-981">getHandleByName</a>( const ::rtl::OUString &amp; rPropertyName );</td>
<td width="50%"> Return the handle of the property with the name rPropertyName.
If the property does not exist -1 is returned.
</td>
</tr>
<tr>
<td>virtual sal_Int32 <br>
<a href="OPropertyArrayHelper/o.html#fillHandles-982">fillHandles</a>( sal_Int32 * pHandles, const ::com::sun::star::uno::Sequence&lt; ::rtl::OUString &gt; &amp; rPropNames );</td>
<td width="50%"> Fill the array with the handles of the properties.
</td>
</tr>
</table>
<hr>
</dd>
</dl>
<dl>
<dt bgcolor="#CCCCFF"><a name="prot_"><h3>Protected Members</h3>
</a>
</dt>
<dd><a name="prot_vars"> </a>
<table cellpadding="5" cellspacing="0" width="100%">
<tr bgcolor="#CCCCFF">
<td colspan="2"><h4>Data</h4>
</td>
</tr>
<tr bgcolor="white">
<td>void * <a href="OPropertyArrayHelper/d.html#m_pReserved"><strong>m_pReserved;</strong></a></td>
<td>reserved for future use. do not use.
</td>
</tr>
</table>
<hr>
</dd>
</dl>
<dl>
<dt bgcolor="#CCCCFF"><a name="priv_"><h3>Private Members</h3>
</a>
</dt>
<dd><a name="priv_ops"> </a>
<table cellpadding="5" cellspacing="0" width="100%">
<tr bgcolor="#CCCCFF">
<td colspan="2"><h4>Methods</h4>
</td>
</tr>
<tr>
<td>void <br>
<a href="OPropertyArrayHelper/o.html#init-983">init</a>( sal_Bool bSorted ) throw( );</td>
<td width="50%"> </td>
</tr>
</table>
<hr>
<a name="priv_vars"> </a>
<table cellpadding="5" cellspacing="0" width="100%">
<tr bgcolor="#CCCCFF">
<td colspan="2"><h4>Data</h4>
</td>
</tr>
<tr bgcolor="white">
<td>::com::sun::star::uno::<a href="../com/sun/star/uno/c-Sequence.html">Sequence</a>&lt; ::com::sun::star::beans::Property &gt; <a href="OPropertyArrayHelper/d.html#aInfos"><strong>aInfos;</strong></a></td>
<td>The sequence generstet from the pProperties array. </td>
</tr>
<tr bgcolor="white">
<td><a href="../t-sal_Bool.html">sal_Bool</a> <a href="OPropertyArrayHelper/d.html#bRightOrdered"><strong>bRightOrdered;</strong></a></td>
<td>True, If the values of the handles are sorted in the same way as the names
and the highest handle value is getCount() -1, otherwise false.
</td>
</tr>
</table>
<hr>
</dd>
</dl>
<a href="#_top_" class="objchapter">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright 2002 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.</p>
</body>