Sophie

Sophie

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

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

<html>
<head>
<title>Service FillProperties</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="FillProperties-xref.html" class="navimain">Use</a></td>
<td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Drawings/General_Drawing_Properties" 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">Included Services</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 FillProperties</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>This is a set of properties to describe the style for rendering an area.
 </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/General_Drawing_Properties">Drawings - General Drawing Properties</a></dd>
</dl>
</td>
</tr>
</table>
<hr>
<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"><a href="FillStyle.html">FillStyle</a><br>
<a href="#FillStyle">FillStyle</a></td>
<td class="imsum_right">This enumeration selects the style with which the area will be filled.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a><br>
<a href="#FillColor">FillColor</a></td>
<td class="imsum_right">If the <a href="FillStyle.html">FillStyle</a> is set to <b>FillStyle::SOLID</b>,
 this is the color used.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">short<br>
<a href="#FillTransparence">FillTransparence</a></td>
<td class="imsum_right">This is the transparence of the filled area.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#FillTransparenceGradientName">FillTransparenceGradientName</a></td>
<td class="imsum_right">If a gradient is used for transparency, this is the name of the
 used transparence gradient style or it is empty. If you set the name
 of a transparence gradient style contained in the document, this
 style used.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Gradient.html">Gradient</a><br>
<a href="#FillTransparenceGradient">FillTransparenceGradient</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>This describes the transparency of the fill area as a gradient.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#FillGradientName">FillGradientName</a></td>
<td class="imsum_right">If the <a href="FillStyle.html">FillStyle</a> is set to <b>FillStyle::GRADIENT</b>, this
 is the name of the used fill gradient style.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Gradient.html">Gradient</a><br>
<a href="#FillGradient">FillGradient</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>If the <a href="FillStyle.html">FillStyle</a> is set to <b>FillStyle::GRADIENT</b>, this
 describes the gradient used.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#FillHatchName">FillHatchName</a></td>
<td class="imsum_right">If the <a href="FillStyle.html">FillStyle</a> is set to <b>FillStyle::GRADIENT</b>, this
 is the name of the used fill hatch style.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="Hatch.html">Hatch</a><br>
<a href="#FillHatch">FillHatch</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>If the <a href="FillStyle.html">FillStyle</a> is set to <b>FillStyle::HATCH</b>, this
 describes the hatch used.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#FillBitmapName">FillBitmapName</a></td>
<td class="imsum_right">If the <a href="FillStyle.html">FillStyle</a> is set to <b>FillStyle::BITMAP</b>, this is
 the name of the used fill bitmap style.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XBitmap.html">XBitmap</a><br>
<a href="#FillBitmap">FillBitmap</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>If the <a href="FillStyle.html">FillStyle</a> is set to <b>FillStyle::BITMAP</b>, this is
 the bitmap used.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#FillBitmapURL">FillBitmapURL</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>If the <a href="FillStyle.html">FillStyle</a> is set to <b>FillStyle::BITMAP</b>, this is
 a URL to the bitmap used.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">short<br>
<a href="#FillBitmapOffsetX">FillBitmapOffsetX</a></td>
<td class="imsum_right">This is the horizontal offset where the tile starts.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">short<br>
<a href="#FillBitmapOffsetY">FillBitmapOffsetY</a></td>
<td class="imsum_right">This is the vertical offset where the tile starts.
 
 It is given in percent in relation to the width of the bitmap.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">short<br>
<a href="#FillBitmapPositionOffsetX">FillBitmapPositionOffsetX</a></td>
<td class="imsum_right">Every second line of tiles is moved the given percent of the
 witdh of the bitmap.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">short<br>
<a href="#FillBitmapPositionOffsetY">FillBitmapPositionOffsetY</a></td>
<td class="imsum_right">Every second row of tiles is moved the given percent of the
 width of the bitmap.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="RectanglePoint.html">RectanglePoint</a><br>
<a href="#FillBitmapRectanglePoint">FillBitmapRectanglePoint</a></td>
<td class="imsum_right">The RectanglePoint specifies the position inside of the bitmap to
 use as the top left position for rendering.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#FillBitmapLogicalSize">FillBitmapLogicalSize</a></td>
<td class="imsum_right">specifies if the size is given in percentage or
 as an absolute value.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">long<br>
<a href="#FillBitmapSizeX">FillBitmapSizeX</a></td>
<td class="imsum_right">This is the width of the tile for filling. 
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">long<br>
<a href="#FillBitmapSizeY">FillBitmapSizeY</a></td>
<td class="imsum_right">This is the height of the tile for filling. 
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="BitmapMode.html">BitmapMode</a><br>
<a href="#FillBitmapMode">FillBitmapMode</a></td>
<td class="imsum_right">this enum selects how a area is filled with a single bitmap.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#FillBackground">FillBackground</a></td>
<td class="imsum_right">if this is <b>true</b>, the transparent background of a
 hatch filled area is drawn in the current background color
 &nbsp;</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="FillStyle" class="membertitle">FillStyle</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><a href="FillStyle.html">FillStyle</a> <b>FillStyle</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>This enumeration selects the style with which the area will be filled.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FillColor" class="membertitle">FillColor</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="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a> <b>FillColor</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>If the <a href="FillStyle.html">FillStyle</a> is set to <b>FillStyle::SOLID</b>,
 this is the color used.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FillTransparence" class="membertitle">FillTransparence</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>short <b>FillTransparence</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>This is the transparence of the filled area.
 
 </dd>
<dd><p>This property is only valid if <a href="FillStyle.html">FillStyle</a> is set to
 <b>FillStyle::SOLID</b>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FillTransparenceGradientName" class="membertitle">FillTransparenceGradientName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>FillTransparenceGradientName</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>If a gradient is used for transparency, this is the name of the
 used transparence gradient style or it is empty. If you set the name
 of a transparence gradient style contained in the document, this
 style used.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FillTransparenceGradient" class="membertitle">FillTransparenceGradient</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/Gradient.html">Gradient</a> <b>FillTransparenceGradient</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>This describes the transparency of the fill area as a gradient.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FillGradientName" class="membertitle">FillGradientName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>FillGradientName</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>If the <a href="FillStyle.html">FillStyle</a> is set to <b>FillStyle::GRADIENT</b>, this
 is the name of the used fill gradient style.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FillGradient" class="membertitle">FillGradient</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/Gradient.html">Gradient</a> <b>FillGradient</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>If the <a href="FillStyle.html">FillStyle</a> is set to <b>FillStyle::GRADIENT</b>, this
 describes the gradient used.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FillHatchName" class="membertitle">FillHatchName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>FillHatchName</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>If the <a href="FillStyle.html">FillStyle</a> is set to <b>FillStyle::GRADIENT</b>, this
 is the name of the used fill hatch style.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FillHatch" class="membertitle">FillHatch</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><a href="Hatch.html">Hatch</a> <b>FillHatch</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>If the <a href="FillStyle.html">FillStyle</a> is set to <b>FillStyle::HATCH</b>, this
 describes the hatch used.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FillBitmapName" class="membertitle">FillBitmapName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>FillBitmapName</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>If the <a href="FillStyle.html">FillStyle</a> is set to <b>FillStyle::BITMAP</b>, this is
 the name of the used fill bitmap style.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FillBitmap" class="membertitle">FillBitmap</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/XBitmap.html">XBitmap</a> <b>FillBitmap</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>If the <a href="FillStyle.html">FillStyle</a> is set to <b>FillStyle::BITMAP</b>, this is
 the bitmap used.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FillBitmapURL" class="membertitle">FillBitmapURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>FillBitmapURL</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>If the <a href="FillStyle.html">FillStyle</a> is set to <b>FillStyle::BITMAP</b>, this is
 a URL to the bitmap used.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FillBitmapOffsetX" class="membertitle">FillBitmapOffsetX</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>short <b>FillBitmapOffsetX</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>This is the horizontal offset where the tile starts.
 
 </dd>
<dd><p>It is given in percent in relation to the width of the bitmap.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FillBitmapOffsetY" class="membertitle">FillBitmapOffsetY</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>short <b>FillBitmapOffsetY</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>This is the vertical offset where the tile starts.
 
 It is given in percent in relation to the width of the bitmap.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FillBitmapPositionOffsetX" class="membertitle">FillBitmapPositionOffsetX</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>short <b>FillBitmapPositionOffsetX</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Every second line of tiles is moved the given percent of the
 witdh of the bitmap.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FillBitmapPositionOffsetY" class="membertitle">FillBitmapPositionOffsetY</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>short <b>FillBitmapPositionOffsetY</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Every second row of tiles is moved the given percent of the
 width of the bitmap.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FillBitmapRectanglePoint" class="membertitle">FillBitmapRectanglePoint</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><a href="RectanglePoint.html">RectanglePoint</a> <b>FillBitmapRectanglePoint</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The RectanglePoint specifies the position inside of the bitmap to
 use as the top left position for rendering.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FillBitmapLogicalSize" class="membertitle">FillBitmapLogicalSize</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>FillBitmapLogicalSize</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>specifies if the size is given in percentage or
 as an absolute value.
 
 </dd>
<dd><p>If this is <b>true</b>, the properties FillBitmapSizeX
 and FillBitmapSizeY contain the size of the tile in percent 
 of the size of the original bitmap. If this
 is <b>false</b>, the size of the tile is specified
 with 1/100th mm.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FillBitmapSizeX" class="membertitle">FillBitmapSizeX</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>long <b>FillBitmapSizeX</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>This is the width of the tile for filling. 
 
 </dd>
<dd><p>Depending on the property FillBitmapLogicalSize, this is 
 either relative or absolute.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FillBitmapSizeY" class="membertitle">FillBitmapSizeY</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>long <b>FillBitmapSizeY</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>This is the height of the tile for filling. 
 
 </dd>
<dd><p>Depending on the property FillBitmapLogicalSize, this 
 is either relative or absolute.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FillBitmapMode" class="membertitle">FillBitmapMode</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><a href="BitmapMode.html">BitmapMode</a> <b>FillBitmapMode</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>this enum selects how a area is filled with a single bitmap.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FillBackground" class="membertitle">FillBackground</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>FillBackground</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>if this is <b>true</b>, the transparent background of a
 hatch filled area is drawn in the current background color
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<br>&nbsp;<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>