<html> <head> <title>Service CaptionShape</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="CaptionShape-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="#IncludedServices" class="navisub">Included Services</a></td> <td class="navisub">Exported Interfaces</td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</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 CaptionShape</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>The <a href="CaptionShape.html">CaptionShape</a> represents a rectangular drawing shape with an additional set of lines. It can be used as a description for a fixed point inside a drawing. </dd> </dl> </td> </tr> </table> <hr> <a name="IncludedServices"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services</td> </tr> <tr> <td class="imsum_left"><a href="Shape.html">Shape</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>the position and size is only used for the caption area </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="FillProperties.html">FillProperties</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>This is a set of properties to describe the style for rendering an area. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="LineProperties.html">LineProperties</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>This is a set of properties to describe the style for rendering a Line. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="ShadowProperties.html">ShadowProperties</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>This is a set of properties to describe the style for rendering a shadow. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="Text.html">Text</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>This abstract service specifies the general characteristics of an optional text inside a <a href="Shape.html">Shape</a>. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="RotationDescriptor.html">RotationDescriptor</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>This abstract service specifies the general characteristics of an optional rotation and shearing for a <a href="Shape.html">Shape</a>. This service is depricated, instead please use the <code>Transformation</code> property of the service <a href="Shape.html">Shape</a>. </dd> </dl> </td> </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="#CornerRadius">CornerRadius</a></td> <td class="imsum_right">This is the radius of the caption area corners. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Point.html">Point</a><br> <a href="#CaptionPoint">CaptionPoint</a></td> <td class="imsum_right">The caption point property specify the position of the point that is captioned. A set of lines are rendered from the caption area. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#CaptionType">CaptionType</a></td> <td class="imsum_right">This property specifies the geometry of the line of a caption. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#CaptionIsFixedAngle">CaptionIsFixedAngle</a></td> <td class="imsum_right">This property specifies if the escape angle of the line of a caption is fixed or free. If this is set to <b>false</b>, the application can choose the best possible angle. If not, the value in <code>CaptionAngle</code> is used. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#CaptionAngle">CaptionAngle</a></td> <td class="imsum_right">This property specifies the escape angle of the line of a caption. It is only used if <code>CaptionIsFixedAngle</code> is set to <b>true</b> </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#CaptionGap">CaptionGap</a></td> <td class="imsum_right">This property specifies the distance between the text area of the caption and the start of the line. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#CaptionEscapeDirection">CaptionEscapeDirection</a></td> <td class="imsum_right">This property specifies the escape direction for the line of a caption. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#CaptionIsEscapeRelative">CaptionIsEscapeRelative</a></td> <td class="imsum_right">If this property is <b>true</b>, the property <code>CaptionEscapeRelative</code> is used, else the property <code>CaptionEscapeAbsolute</code> is used. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#CaptionEscapeRelative">CaptionEscapeRelative</a></td> <td class="imsum_right">This property specifies the relativ escape distance for the line of a caption. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#CaptionEscapeAbsolute">CaptionEscapeAbsolute</a></td> <td class="imsum_right">This property specifies the absolut escape distance for the line of a caption. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#CaptionLineLength">CaptionLineLength</a></td> <td class="imsum_right">This property specifies the length of the caption line. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#CaptionIsFitLineLength">CaptionIsFitLineLength</a></td> <td class="imsum_right">If this property is <b>true</b>, the application determines the best possible length for the caption line. </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="CornerRadius" class="membertitle">CornerRadius</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>CornerRadius</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This is the radius of the caption area corners. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CaptionPoint" class="membertitle">CaptionPoint</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="../awt/module-ix.html">awt</a>::<a href="../awt/Point.html">Point</a> <b>CaptionPoint</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The caption point property specify the position of the point that is captioned. A set of lines are rendered from the caption area. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CaptionType" class="membertitle">CaptionType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>CaptionType</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property specifies the geometry of the line of a caption. </dd> <dt><b>See also</b></dt> <dd><a href="CaptionType.html">CaptionType</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CaptionIsFixedAngle" class="membertitle">CaptionIsFixedAngle</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>CaptionIsFixedAngle</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property specifies if the escape angle of the line of a caption is fixed or free. If this is set to <b>false</b>, the application can choose the best possible angle. If not, the value in <code>CaptionAngle</code> is used. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CaptionAngle" class="membertitle">CaptionAngle</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>CaptionAngle</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property specifies the escape angle of the line of a caption. It is only used if <code>CaptionIsFixedAngle</code> is set to <b>true</b> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CaptionGap" class="membertitle">CaptionGap</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>CaptionGap</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property specifies the distance between the text area of the caption and the start of the line. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CaptionEscapeDirection" class="membertitle">CaptionEscapeDirection</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>CaptionEscapeDirection</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property specifies the escape direction for the line of a caption. </dd> <dt><b>See also</b></dt> <dd><a href="CaptionEscapeDirection.html">CaptionEscapeDirection</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CaptionIsEscapeRelative" class="membertitle">CaptionIsEscapeRelative</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>CaptionIsEscapeRelative</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>If this property is <b>true</b>, the property <code>CaptionEscapeRelative</code> is used, else the property <code>CaptionEscapeAbsolute</code> is used. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CaptionEscapeRelative" class="membertitle">CaptionEscapeRelative</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>CaptionEscapeRelative</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property specifies the relativ escape distance for the line of a caption. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CaptionEscapeAbsolute" class="membertitle">CaptionEscapeAbsolute</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>CaptionEscapeAbsolute</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property specifies the absolut escape distance for the line of a caption. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CaptionLineLength" class="membertitle">CaptionLineLength</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>CaptionLineLength</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This property specifies the length of the caption line. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CaptionIsFitLineLength" class="membertitle">CaptionIsFitLineLength</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>CaptionIsFitLineLength</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>If this property is <b>true</b>, the application determines the best possible length for the caption line. </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 © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>