Sophie

Sophie

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

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

<html>
<head>
<title>Interface XShapeGrouper</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="XShapeGrouper-xref.html" class="navimain">Use</a></td>
<td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Drawings/Grouping%2C_Combining_and_Binding" 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">drawing</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XShapeGrouper</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>specifies the group/ungroup functionality.
 </dd>
</dl>
<a name="devmanual"> </a><dl>
<dt><b>Developers Guide</b></dt>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Drawings/Grouping%2C_Combining_and_Binding">Drawings - Grouping, Combining and Binding</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="#group">group</a></td>
<td class="imsum_right">groups the <a href="Shape.html">Shape</a>s inside a collection.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#ungroup">ungroup</a></td>
<td class="imsum_right">ungroups a given <a href="GroupShape.html">GroupShape</a>.

 &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="group" class="membertitle">group</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="XShapeGroup.html">XShapeGroup</a></td>
</tr>
<tr>
<td valign="top"><b>group</b>(</td>
<td valign="top">[in] <a href="XShapes.html">XShapes</a></td>
<td valign="bottom">&nbsp;xShapes );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>groups the <a href="Shape.html">Shape</a>s inside a collection.

 </dd>
<dd><p>Grouping of objects in text documents works only if none
 of the objects has an anchor of type 
 <a href="#AS_CHARACTER">AS_CHARACTER</a>
 </p>.

 </dd>
<dt><b>Parameter xShapes</b></dt>
<dd>the <a href="Shape.html">Shape</a>s that will be grouped. They
 must all be inserted into the same <a href="GenericDrawPage.html">GenericDrawPage</a>.

 </dd>
<dt><b>Returns</b></dt>
<dd>a newly created <a href="GroupShape.html">GroupShape</a> that contains all
 <a href="Shape.html">Shape</a>s from xShapes and is also added to the
 <a href="GenericDrawPage.html">GenericDrawPage</a> of the <a href="Shape.html">Shape</a>s
 in xShapes.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="ungroup" class="membertitle">ungroup</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>ungroup</b>(</td>
<td valign="top">[in] <a href="XShapeGroup.html">XShapeGroup</a></td>
<td valign="bottom">&nbsp;aGroup );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>ungroups a given <a href="GroupShape.html">GroupShape</a>.

 </dd>
<dt><b>Parameter aGroup</b></dt>
<dd>moves all <a href="Shape.html">Shape</a>s from this <a href="GroupShape.html">GroupShape</a>
 to the parent <a href="XShapes.html">XShapes</a> of the <a href="GroupShape.html">GroupShape</a>.
 The <a href="GroupShape.html">GroupShape</a> is than removed from the 
 <a href="GenericDrawPage.html">GenericDrawPage</a> and disposed.
 </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>