<html> <head> <title>Service Shape</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="Shape-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Drawings/Shape_Types" 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">Services' Summary</td> <td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub">Services' Details</td> <td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</a></td> <td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' Details</a></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">service Shape</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>This abstract service specifies the general characteristics of all <a href="Shape.html">Shape</a>s. </dd> <dt><b/></dt> <dd/><dt><b/></dt> <dd/><dt><b/></dt> <dd/><dt><b/></dt> <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/Shape_Types">Drawings - Shape Types</a></dd> </dl> </td> </tr> </table> <hr> <a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td> <td class="imsum_right"><p>handles all the properties of this instance. </p> </td> </tr> <tr> <td class="imsum_left"><a href="XShape.html">XShape</a></td> <td class="imsum_right"><p>This gives you the size and position of this <a href="Shape.html">Shape</a> and lets you change it. You can use <a href="Shape.html#getShapeType">getShapeType</a> to determine what kind of shape this is. </p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a></td> <td class="imsum_right"><p>is used for lifetime control of this <a href="Shape.html">Shape</a>. </p> </td> </tr> <tr> <td class="imsum_left"><a href="XShapeDescriptor.html">XShapeDescriptor</a></td> <td class="imsum_right"><p>The <a href="XShapeDescriptor.html">XShapeDescriptor</a> tells you what kind of <a href="Shape.html">Shape</a> this instance is. </p> </td> </tr> <tr> <td class="imsum_left"><a href="XGluePointsSupplier.html">XGluePointsSupplier</a></td> <td class="imsum_right"><p>This interfaces gives access to an optional container of glue points. To have unique ids you should query the returned interface for ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIdentifierContainer.html">XIdentifierContainer</a>. (<a href="#XGluePointsSupplier">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XTolerantMultiPropertySet.html">XTolerantMultiPropertySet</a></td> <td class="imsum_right"/></tr> </table> <a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Properties' Summary</td> </tr> <tr> <td class="imsum_left">long<br> <a href="#ZOrder">ZOrder</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>is used to query or change the ZOrder of this <a href="Shape.html">Shape</a>. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#LayerID">LayerID</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This is the ID of the <a href="Layer.html">Layer</a> to which this <a href="Shape.html">Shape</a> is attached. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#LayerName">LayerName</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This is the name of the <a href="Layer.html">Layer</a> to which this <a href="Shape.html">Shape</a> is attached. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Printable">Printable</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>If this is <b>false</b>, the <a href="Shape.html">Shape</a> is not visible on printer outputs. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#MoveProtect">MoveProtect</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>With this set to <b>true</b>, this <a href="Shape.html">Shape</a> cannot be moved interactively in the user interface. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Name">Name</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>This is the name of this <a href="Shape.html">Shape</a>. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#SizeProtect">SizeProtect</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>With this set to <b>true</b>, this <a href="Shape.html">Shape</a> may not be sized interactively in the user interface. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../style/module-ix.html">style</a>::<a href="../style/XStyle.html">XStyle</a><br> <a href="#Style">Style</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>this property lets you get and set a style for this shape. </td> </tr> <tr> <td class="imsum_left"><a href="HomogenMatrix3.html">HomogenMatrix3</a><br> <a href="#Transformation">Transformation</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>this property lets you get and set the transformation matrix for this shape. The transformation is a 3x3 homogen matrix and can contain translation, rotation, shearing and scaling. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameContainer.html">XNameContainer</a><br> <a href="#ShapeUserDefinedAttributes">ShapeUserDefinedAttributes</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>this property stores xml attributes. They will be saved to and restored from automatic styles inside xml files. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#NavigationOrder">NavigationOrder</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>this property stores the navigation order of this shape. If this value is negative, the navigation order for this shapes page is equal to the z-order. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Hyperlink">Hyperlink</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>this property lets you get and set a hyperlink for this shape. </td> </tr> </table> <a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="XPropertySet" class="membertitle">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>handles all the properties of this instance. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XShape" class="membertitle"><a href="XShape.html">XShape</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>This gives you the size and position of this <a href="Shape.html">Shape</a> and lets you change it. You can use <a href="Shape.html#getShapeType">getShapeType</a> to determine what kind of shape this is. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XComponent" class="membertitle">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>is used for lifetime control of this <a href="Shape.html">Shape</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XShapeDescriptor" class="membertitle"><a href="XShapeDescriptor.html">XShapeDescriptor</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>The <a href="XShapeDescriptor.html">XShapeDescriptor</a> tells you what kind of <a href="Shape.html">Shape</a> this instance is. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XGluePointsSupplier" class="membertitle"><a href="XGluePointsSupplier.html">XGluePointsSupplier</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This interfaces gives access to an optional container of glue points. To have unique ids you should query the returned interface for ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIdentifierContainer.html">XIdentifierContainer</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XTolerantMultiPropertySet" class="membertitle">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XTolerantMultiPropertySet.html">XTolerantMultiPropertySet</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Properties' Details</td> </tr> <tr> <td class="imdetail"><a name="ZOrder" class="membertitle">ZOrder</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>ZOrder</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>is used to query or change the ZOrder of this <a href="Shape.html">Shape</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="LayerID" class="membertitle">LayerID</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>LayerID</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This is the ID of the <a href="Layer.html">Layer</a> to which this <a href="Shape.html">Shape</a> is attached. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="LayerName" class="membertitle">LayerName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>LayerName</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This is the name of the <a href="Layer.html">Layer</a> to which this <a href="Shape.html">Shape</a> is attached. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Printable" class="membertitle">Printable</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Printable</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>If this is <b>false</b>, the <a href="Shape.html">Shape</a> is not visible on printer outputs. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MoveProtect" class="membertitle">MoveProtect</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>MoveProtect</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>With this set to <b>true</b>, this <a href="Shape.html">Shape</a> cannot be moved interactively in the user interface. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Name" class="membertitle">Name</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Name</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>This is the name of this <a href="Shape.html">Shape</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SizeProtect" class="membertitle">SizeProtect</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>SizeProtect</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>With this set to <b>true</b>, this <a href="Shape.html">Shape</a> may not be sized interactively in the user interface. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Style" class="membertitle">Style</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../style/module-ix.html">style</a>::<a href="../style/XStyle.html">XStyle</a> <b>Style</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>this property lets you get and set a style for this shape. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Transformation" class="membertitle">Transformation</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="HomogenMatrix3.html">HomogenMatrix3</a> <b>Transformation</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>this property lets you get and set the transformation matrix for this shape. The transformation is a 3x3 homogen matrix and can contain translation, rotation, shearing and scaling. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ShapeUserDefinedAttributes" class="membertitle">ShapeUserDefinedAttributes</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameContainer.html">XNameContainer</a> <b>ShapeUserDefinedAttributes</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>this property stores xml attributes. They will be saved to and restored from automatic styles inside xml files. </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="NavigationOrder" class="membertitle">NavigationOrder</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>NavigationOrder</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>this property stores the navigation order of this shape. If this value is negative, the navigation order for this shapes page is equal to the z-order. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Hyperlink" class="membertitle">Hyperlink</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Hyperlink</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>this property lets you get and set a hyperlink for this shape. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2009 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>