incubator-ooo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ksch...@apache.org
Subject svn commit: r1206299 [18/19] - in /incubator/ooo/ooo-site/trunk/content/gsl: canvas/ canvas/api/ canvas/api/geometry/ canvas/api/index-files/ canvas/api/rendering/ psprint/ vcl/ vcl/plugins/
Date Fri, 25 Nov 2011 20:07:51 GMT
Added: incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSimpleCanvas.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSimpleCanvas.html?rev=1206299&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSimpleCanvas.html (added)
+++ incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSimpleCanvas.html Fri Nov 25 20:06:37 2011
@@ -0,0 +1,829 @@
+<html>
+<head>
+<title>Interface XSimpleCanvas</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="XSimpleCanvas-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="#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">rendering</a> :: </p>
+</td>
+</tr>
+<tr>
+<td class="title"><table class="title-table" width="99%">
+<tr>
+<td width="25%" class="title2">unpublished </td>
+<td width="50%" class="title">interface XSimpleCanvas</td>
+<td width="*"/></tr>
+</table>
+</td>
+</tr>
+<tr>
+<td><dl>
+<dt><b>Base Interfaces</b></dt>
+<dd><pre style="font-family:monospace;"><strong>XSimpleCanvas</strong>
+&#x2517 ::com::sun::star::uno::XInterface
+
+</pre></dd>
+<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
+<tr>
+<td class="imsum_left">::com::sun::star::uno::XInterface</td>
+<td class="imsum_right"><dl></dl>
+</td>
+</tr>
+</table>
+</dd>
+</dl>
+</td>
+</tr>
+<tr>
+<td><dl>
+<dt><b>Description</b></dt>
+<dd>Provides the basic graphical output operations for a canvas. </dd>
+<dd><p>
+
+This interface is a simplified version of the <a href="XCanvas.html">XCanvas</a> 
+interface. It holds explicit state, i.e. the pen and fill color, 
+the current transformation, clip and font are persistently 
+remembered. <p>
+
+In contrast to the <a href="XCanvas.html">XCanvas</a> interface, XSimpleCanvas 
+does not distinguish between stroke and fill operations; instead, 
+switching between stroke and fill (or taking both) works by 
+setting appropriate pen and fill colors. <p>
+</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="#selectFont">selectFont</a></td>
+<td class="imsum_right">Select a font. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#setPenColor">setPenColor</a></td>
+<td class="imsum_right">Sets the color used by line and text operations. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#setFillColor">setFillColor</a></td>
+<td class="imsum_right">Sets the fill color. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#setRectClip">setRectClip</a></td>
+<td class="imsum_right">Sets the clip to the specified rectangle. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#setTransformation">setTransformation</a></td>
+<td class="imsum_right">Set the current transform matrix. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#drawPixel">drawPixel</a></td>
+<td class="imsum_right">Sets a single pixel on the canvas. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#drawLine">drawLine</a></td>
+<td class="imsum_right">Draws a line on the canvas. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#drawRect">drawRect</a></td>
+<td class="imsum_right">Draws a rectangle on the canvas. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#drawPolyPolygon">drawPolyPolygon</a></td>
+<td class="imsum_right">Draws a poly-polygon on the canvas. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#drawText">drawText</a></td>
+<td class="imsum_right">Draws text on the canvas. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#drawBitmap">drawBitmap</a></td>
+<td class="imsum_right">Draws the bitmap on the canvas. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#getDevice">getDevice</a></td>
+<td class="imsum_right">Request the associated graphic device for this canvas. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#getCanvas">getCanvas</a></td>
+<td class="imsum_right">Query the underlying <a href="XCanvas.html">XCanvas</a> . &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#getFontMetrics">getFontMetrics</a></td>
+<td class="imsum_right">Request the font metrics of the current font. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#getCurrentFont">getCurrentFont</a></td>
+<td class="imsum_right">Retrieve currently selected font. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#getCurrentPenColor">getCurrentPenColor</a></td>
+<td class="imsum_right">Retrieve color currently used for lines. 
+&nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#getCurrentFillColor">getCurrentFillColor</a></td>
+<td class="imsum_right">Retrieve color currently used for fills 
+&nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#getCurrentClipRect">getCurrentClipRect</a></td>
+<td class="imsum_right">Retrieve current clip rect 
+&nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#getCurrentTransformation">getCurrentTransformation</a></td>
+<td class="imsum_right">Retrieve current transformation matrix 
+&nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#getCurrentViewState">getCurrentViewState</a></td>
+<td class="imsum_right">Retrieve view state. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#getCurrentRenderState">getCurrentRenderState</a></td>
+<td class="imsum_right">Retrieve render state. &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="selectFont" class="membertitle">selectFont</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>selectFont</b>(</td>
+<td valign="top">[in] string</td>
+<td valign="bottom">&nbsp;sFontName,</td>
+</tr>
+<tr>
+<td/><td valign="top">[in] double</td>
+<td valign="bottom">&nbsp;size,</td>
+</tr>
+<tr>
+<td/><td valign="top">[in] bool</td>
+<td valign="bottom">&nbsp;bold,</td>
+</tr>
+<tr>
+<td/><td valign="top">[in] bool</td>
+<td valign="bottom">&nbsp;italic );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Select a font. </dd>
+<dd><p>
+
+This method selects the specified font (or a close substitute) 
+as the current font for text output. <p>
+
+</dd>
+<dt><b>Parameter sFontName</b></dt>
+<dd>The name of the font (like e.g. Arial) 
+
+</dd>
+<dt><b>Parameter size</b></dt>
+<dd>The size of the font (note that this is not the usual points 
+unit, but in the same coordinate system as the other rendering 
+operations - usually, device pixel). 
+
+</dd>
+<dt><b>Parameter bold</b></dt>
+<dd>When true, selected font is bold. 
+
+</dd>
+<dt><b>Parameter italic</b></dt>
+<dd>When true, selected font is italic 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="setPenColor" class="membertitle">setPenColor</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>setPenColor</b>(</td>
+<td valign="top">[in] ::com::sun::star::util::Color</td>
+<td valign="bottom">&nbsp;nsRgbaColor );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Sets the color used by line and text operations. </dd>
+<dd><p>
+
+To disable stroking, simply set this color to something with 
+zero alpha (i.e. fully transparent). <p>
+
+</dd>
+<dt><b>Parameter nsRgbaColor</b></dt>
+<dd>RGBA color tuple, interpreted in the sRGB color space. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="setFillColor" class="membertitle">setFillColor</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>setFillColor</b>(</td>
+<td valign="top">[in] ::com::sun::star::util::Color</td>
+<td valign="bottom">&nbsp;nsRgbaColor );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Sets the fill color. </dd>
+<dd><p>
+
+To disable filling, simply set this color to something with 
+zero alpha (i.e. fully transparent). <p>
+
+</dd>
+<dt><b>Parameter nsRgbaColor</b></dt>
+<dd>RGBA color tuple, interpreted in the sRGB color space. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="setRectClip" class="membertitle">setRectClip</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>setRectClip</b>(</td>
+<td valign="top">[in] ::com::sun::star::geometry::RealRectangle2D</td>
+<td valign="bottom">&nbsp;aRect );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Sets the clip to the specified rectangle. </dd>
+<dd><p>
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="setTransformation" class="membertitle">setTransformation</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>setTransformation</b>(</td>
+<td valign="top">[in] ::com::sun::star::geometry::AffineMatrix2D</td>
+<td valign="bottom">&nbsp;aTransform );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Set the current transform matrix. </dd>
+<dd><p>
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="drawPixel" class="membertitle">drawPixel</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>drawPixel</b>(</td>
+<td valign="top">[in] ::com::sun::star::geometry::RealPoint2D</td>
+<td valign="bottom">&nbsp;aPoint );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Sets a single pixel on the canvas. </dd>
+<dd><p>
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="drawLine" class="membertitle">drawLine</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>drawLine</b>(</td>
+<td valign="top">[in] ::com::sun::star::geometry::RealPoint2D</td>
+<td valign="bottom">&nbsp;aStartPoint,</td>
+</tr>
+<tr>
+<td/><td valign="top">[in] ::com::sun::star::geometry::RealPoint2D</td>
+<td valign="bottom">&nbsp;aEndPoint );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Draws a line on the canvas. </dd>
+<dd><p>
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="drawRect" class="membertitle">drawRect</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>drawRect</b>(</td>
+<td valign="top">[in] ::com::sun::star::geometry::RealRectangle2D</td>
+<td valign="bottom">&nbsp;aRect );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Draws a rectangle on the canvas. </dd>
+<dd><p>
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="drawPolyPolygon" class="membertitle">drawPolyPolygon</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>drawPolyPolygon</b>(</td>
+<td valign="top">[in] <a href="XPolyPolygon2D.html">XPolyPolygon2D</a></td>
+<td valign="bottom">&nbsp;xPolyPolygon );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Draws a poly-polygon on the canvas. </dd>
+<dd><p>
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="drawText" class="membertitle">drawText</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>drawText</b>(</td>
+<td valign="top">[in] <a href="StringContext.html">StringContext</a></td>
+<td valign="bottom">&nbsp;aText,</td>
+</tr>
+<tr>
+<td/><td valign="top">[in] ::com::sun::star::geometry::RealPoint2D</td>
+<td valign="bottom">&nbsp;aOutPos,</td>
+</tr>
+<tr>
+<td/><td valign="top">[in] byte</td>
+<td valign="bottom">&nbsp;nTextDirection );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Draws text on the canvas. </dd>
+<dd><p>
+
+</dd>
+<dt><b>Parameter aText</b></dt>
+<dd>Text to render 
+
+</dd>
+<dt><b>Parameter aOutPos</b></dt>
+<dd>Output position of the text. This is the left or right edge, 
+depending on nTextDirection. Output position is always 
+relative to the font baseline. 
+
+</dd>
+<dt><b>Parameter nTextDirection</b></dt>
+<dd>A value from the <a href="TextDirection.html">TextDirection</a> collection, 
+denoting the main writing direction for this string. The main 
+writing direction determines the origin of the text output, 
+i.e. the left edge for left-to-right and the right edge for 
+right-to-left text. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="drawBitmap" class="membertitle">drawBitmap</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>drawBitmap</b>(</td>
+<td valign="top">[in] <a href="XBitmap.html">XBitmap</a></td>
+<td valign="bottom">&nbsp;xBitmap,</td>
+</tr>
+<tr>
+<td/><td valign="top">[in] ::com::sun::star::geometry::RealPoint2D</td>
+<td valign="bottom">&nbsp;aLeftTop );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Draws the bitmap on the canvas. </dd>
+<dd><p>
+
+</dd>
+<dt><b>Parameter xBitmap</b></dt>
+<dd>Bitmap to render 
+
+</dd>
+<dt><b>Parameter aLeftTop</b></dt>
+<dd>Left, top position of the bitmap on the destination canvas. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="getDevice" class="membertitle">getDevice</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="XGraphicDevice.html">XGraphicDevice</a></td>
+</tr>
+<tr>
+<td valign="top"><b>getDevice</b>();</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Request the associated graphic device for this canvas. </dd>
+<dd><p>
+
+A graphic device provides methods specific to the underlying 
+output device capabilities, which are common for all canvases 
+rendering to such a device. This includes device resolution, 
+color space, or bitmap formats. <p>
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>the associated <a href="XGraphicDevice.html">XGraphicDevice</a> . 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="getCanvas" class="membertitle">getCanvas</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="XCanvas.html">XCanvas</a></td>
+</tr>
+<tr>
+<td valign="top"><b>getCanvas</b>();</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Query the underlying <a href="XCanvas.html">XCanvas</a> . </dd>
+<dd><p>
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>the canvas interface this object is internally based 
+on. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="getFontMetrics" class="membertitle">getFontMetrics</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="FontMetrics.html">FontMetrics</a></td>
+</tr>
+<tr>
+<td valign="top"><b>getFontMetrics</b>();</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Request the font metrics of the current font. </dd>
+<dd><p>
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>the font metrics of the currently selected font. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="getCurrentFont" class="membertitle">getCurrentFont</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="XCanvasFont.html">XCanvasFont</a></td>
+</tr>
+<tr>
+<td valign="top"><b>getCurrentFont</b>();</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Retrieve currently selected font. </dd>
+<dd><p>
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>the font instance that's currently used for rendering 
+text. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="getCurrentPenColor" class="membertitle">getCurrentPenColor</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">::com::sun::star::util::Color</td>
+</tr>
+<tr>
+<td valign="top"><b>getCurrentPenColor</b>();</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Retrieve color currently used for lines. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="getCurrentFillColor" class="membertitle">getCurrentFillColor</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">::com::sun::star::util::Color</td>
+</tr>
+<tr>
+<td valign="top"><b>getCurrentFillColor</b>();</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Retrieve color currently used for fills 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="getCurrentClipRect" class="membertitle">getCurrentClipRect</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">::com::sun::star::geometry::RealRectangle2D</td>
+</tr>
+<tr>
+<td valign="top"><b>getCurrentClipRect</b>();</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Retrieve current clip rect 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="getCurrentTransformation" class="membertitle">getCurrentTransformation</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">::com::sun::star::geometry::AffineMatrix2D</td>
+</tr>
+<tr>
+<td valign="top"><b>getCurrentTransformation</b>();</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Retrieve current transformation matrix 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="getCurrentViewState" class="membertitle">getCurrentViewState</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="ViewState.html">ViewState</a></td>
+</tr>
+<tr>
+<td valign="top"><b>getCurrentViewState</b>();</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Retrieve view state. </dd>
+<dd><p>
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>the view state, that would generate matching output, 
+when rendering to an XCanvas instead. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="getCurrentRenderState" class="membertitle">getCurrentRenderState</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="RenderState.html">RenderState</a></td>
+</tr>
+<tr>
+<td valign="top"><b>getCurrentRenderState</b>();</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Retrieve render state. </dd>
+<dd><p>
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>the render state, that would generate matching output, 
+when rendering to an XCanvas instead. 
+</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; 2003 Sun Microsystems, Inc.</p>
+
+</div> <!-- id="adc-idlref" -->
+</body>
+
+</html>

Propchange: incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSimpleCanvas.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSprite-xref.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSprite-xref.html?rev=1206299&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSprite-xref.html (added)
+++ incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSprite-xref.html Fri Nov 25 20:06:37 2011
@@ -0,0 +1,84 @@
+<html>
+<head>
+<title>Uses of Interface XSprite-xref</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="navimainself">Use</td>
+<td class="navimainnone">Devguide</td>
+<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
+</tr>
+</table>
+<hr>
+<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
+<tr>
+<td class="title">uses of interface XSprite</td>
+</tr>
+<tr>
+<td><p><a href="XSprite.html"><b>back to interface XSprite</b></a><br>
+<br>
+
+<a href="#Deriveds">Derived Interfaces<br>
+
+</a>Synonym Typedefs<br>
+
+Services which Support this Interface<br>
+
+Singletons which Support this Interface<br>
+
+<a href="#Returns">Uses as Return Type<br>
+
+</a><a href="#Parameters">Uses as Parameter<br>
+
+</a>Uses as Data Type<br>
+
+References in Developers Guide<br>
+
+</p>
+</td>
+</tr>
+</table>
+<hr>
+<a name="Deriveds"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
+<tr>
+<td class="subtitle">Derived Interfaces</td>
+</tr>
+<tr>
+<td><pre style="font-family:monospace;"><a href="XAnimatedSprite.html">XAnimatedSprite</a>
+<a href="XCustomSprite.html">XCustomSprite</a>
+<a href="XCustomSprite.html">XCustomSprite</a>
+</pre></td>
+</tr>
+</table>
+<a name="Returns"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
+<tr>
+<td class="subtitle">Uses as Return Type</td>
+</tr>
+<tr>
+<td><a href="XSpriteCanvas.html">XSpriteCanvas</a>::<a href="XSpriteCanvas.html#createClonedSprite">createClonedSprite()</a><br>
+</td>
+</tr>
+</table>
+<a name="Parameters"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
+<tr>
+<td class="subtitle">Uses as Parameter</td>
+</tr>
+<tr>
+<td><a href="XSpriteCanvas.html">XSpriteCanvas</a>::<a href="XSpriteCanvas.html#createClonedSprite">createClonedSprite()</a><br>
+</td>
+</tr>
+</table>
+<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2003 Sun Microsystems, Inc.</p>
+
+</div> <!-- id="adc-idlref" -->
+</body>
+
+</html>

Propchange: incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSprite-xref.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSprite.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSprite.html?rev=1206299&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSprite.html (added)
+++ incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSprite.html Fri Nov 25 20:06:37 2011
@@ -0,0 +1,438 @@
+<html>
+<head>
+<title>Interface XSprite</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="XSprite-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="#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">rendering</a> :: </p>
+</td>
+</tr>
+<tr>
+<td class="title"><table class="title-table" width="99%">
+<tr>
+<td width="25%" class="title2">unpublished </td>
+<td width="50%" class="title">interface XSprite</td>
+<td width="*"/></tr>
+</table>
+</td>
+</tr>
+<tr>
+<td><dl>
+<dt><b>Base Interfaces</b></dt>
+<dd><pre style="font-family:monospace;"><strong>XSprite</strong>
+&#x2517 ::com::sun::star::uno::XInterface
+
+</pre></dd>
+<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
+<tr>
+<td class="imsum_left">::com::sun::star::uno::XInterface</td>
+<td class="imsum_right"><dl></dl>
+</td>
+</tr>
+</table>
+</dd>
+</dl>
+</td>
+</tr>
+<tr>
+<td><dl>
+<dt><b>Description</b></dt>
+<dd>Interface to control a sprite object. </dd>
+<dd><p>
+
+This is the basic interface to control a sprite object on a 
+<a href="XSpriteCanvas.html">XSpriteCanvas</a> . Sprites are moving, back-buffered 
+objects. <p>
+</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="#setAlpha">setAlpha</a></td>
+<td class="imsum_right">Set overall transparency of the sprite. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#move">move</a></td>
+<td class="imsum_right">Move sprite to the specified position. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#transform">transform</a></td>
+<td class="imsum_right">Apply a local transformation to the sprite. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#clip">clip</a></td>
+<td class="imsum_right">Apply a clipping to the shape output. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#setPriority">setPriority</a></td>
+<td class="imsum_right">Set sprite priority. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#show">show</a></td>
+<td class="imsum_right">Make the sprite visible. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#hide">hide</a></td>
+<td class="imsum_right">Make the sprite invisible. &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="setAlpha" class="membertitle">setAlpha</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>setAlpha</b>(</td>
+<td valign="top">[in] double</td>
+<td valign="bottom">&nbsp;nAlpha )</td>
+</tr>
+<tr>
+<td valign="top" align="right">raises( </td>
+<td valign="top" colspan="2">::com::sun::star::lang::IllegalArgumentException );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Set overall transparency of the sprite. </dd>
+<dd><p>
+
+This method is useful for e.g. fading in/out of animations. <p>
+
+Please note that if this sprite is not animated, the 
+associated <a href="XSpriteCanvas.html">XSpriteCanvas</a> does not update changed 
+sprites automatically, but has to be told to do so via 
+<a href="XSpriteCanvas.html">XSpriteCanvas</a>::<a href="XSpriteCanvas.html#updateScreen">updateScreen()</a> . <p>
+
+</dd>
+<dt><b>Parameter nAlpha</b></dt>
+<dd>New global alpha value to composite this sprite with the 
+background. Valid range is [0,1]. 
+
+</dd>
+<dt><b>Throws</b></dt>
+<dd>com::sun::star::lang::IllegalArgumentException 
+if nAlpha is not within the permissible range. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="move" class="membertitle">move</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>move</b>(</td>
+<td valign="top">[in] ::com::sun::star::geometry::RealPoint2D</td>
+<td valign="bottom">&nbsp;aNewPos,</td>
+</tr>
+<tr>
+<td/><td valign="top">[in] <a href="ViewState.html">ViewState</a></td>
+<td valign="bottom">&nbsp;aViewState,</td>
+</tr>
+<tr>
+<td/><td valign="top">[in] <a href="RenderState.html">RenderState</a></td>
+<td valign="bottom">&nbsp;aRenderState )</td>
+</tr>
+<tr>
+<td valign="top" align="right">raises( </td>
+<td valign="top" colspan="2">::com::sun::star::lang::IllegalArgumentException );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Move sprite to the specified position. </dd>
+<dd><p>
+
+The position specified here is first transformed by the 
+combined view and render transformation. The resulting 
+position is then used as the output position (also in device 
+coordinates) of the rendered sprite content. <p>
+
+Please note that if this sprite is not animated, the 
+associated ::XSpriteCanva does not update changed sprites 
+automatically, but has to be told to do so via 
+<a href="XSpriteCanvas.html">XSpriteCanvas</a>::<a href="XSpriteCanvas.html#updateScreen">updateScreen()</a> . <p>
+
+</dd>
+<dt><b>Parameter aNewPos</b></dt>
+<dd>The new position, in user coordinate space, to move the sprite to. 
+
+</dd>
+<dt><b>Parameter aViewState</b></dt>
+<dd>The viewstate to be used when interpreting aNewPos. 
+
+</dd>
+<dt><b>Parameter aRenderState</b></dt>
+<dd>The renderstate to be used when interpreting aNewPos. 
+
+</dd>
+<dt><b>Throws</b></dt>
+<dd>com::sun::star::lang::IllegalArgumentException 
+if one of the view and renderstate parameters are outside the 
+specified range. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="transform" class="membertitle">transform</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>transform</b>(</td>
+<td valign="top">[in] ::com::sun::star::geometry::AffineMatrix2D</td>
+<td valign="bottom">&nbsp;aTransformation )</td>
+</tr>
+<tr>
+<td valign="top" align="right">raises( </td>
+<td valign="top" colspan="2">::com::sun::star::lang::IllegalArgumentException );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Apply a local transformation to the sprite. </dd>
+<dd><p>
+
+The given transformation matrix locally transforms the sprite 
+shape. If this transformation contains translational 
+components, be aware that sprite content moved beyond the 
+sprite area (a box from (0,0) to (spriteWidth,spriteHeight)) 
+might (but need not) be clipped. Use 
+<a href="XSprite.html">XSprite</a>::<a href="XSprite.html#move">move</a> to change the sprite location 
+on screen. The canvas implementations are free, if they have a 
+cached representation of the sprite at hand, to transform only 
+this cached representation (e.g. a bitmap), instead of 
+re-rendering the sprite from first principles. This is usually 
+the case for an implementation of a <a href="XCustomSprite.html">XCustomSprite</a> 
+interface, since it typically has no other cached pictorial 
+information at hand. <p>
+
+Please note that if this sprite is not animated, the 
+associated <a href="XSpriteCanvas.html">XSpriteCanvas</a> does not update changed 
+sprites automatically, but has to be told to do so via 
+<a href="XSpriteCanvas.html">XSpriteCanvas</a>::<a href="XSpriteCanvas.html#updateScreen">updateScreen()</a> . <p>
+
+</dd>
+<dt><b>Parameter aTransformation</b></dt>
+<dd>The transformation to apply to the sprite shape. 
+
+</dd>
+<dt><b>Throws</b></dt>
+<dd>com::sun::star::lang::IllegalArgumentException 
+if the given transformation matrix is singular. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="clip" class="membertitle">clip</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>clip</b>(</td>
+<td valign="top">[in] <a href="XPolyPolygon2D.html">XPolyPolygon2D</a></td>
+<td valign="bottom">&nbsp;aClip );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Apply a clipping to the shape output. </dd>
+<dd><p>
+
+The given clip poly-polygon is always interpreted in device 
+coordinate space. As the sprite has its own local coordinate 
+system, with its origin on screen being equal to its current 
+position, the clip poly-polygon's origin will always coincide 
+with the sprite's origin. Furthermore, if any sprite 
+transformation is set via transform(), the clip is subject to 
+this transformation, too. The implementation is free, if it 
+has a cached representation of the sprite at hand, to 
+clip-output only this cached representation (e.g. a bitmap), 
+instead of re-rendering the sprite from first principles. This 
+is usually the case for an implementation of a 
+<a href="XCustomSprite.html">XCustomSprite</a> interface, since it typically has 
+no other cached pictorial information at hand. <p>
+
+Please note that if this sprite is not animated, the 
+associated <a href="XSpriteCanvas.html">XSpriteCanvas</a> does not update changed 
+sprites automatically, but has to be told to do so via 
+<a href="XSpriteCanvas.html">XSpriteCanvas</a>::<a href="XSpriteCanvas.html#updateScreen">updateScreen()</a> . <p>
+
+Specifying an empty interface denotes no clipping, 
+i.e. everything contained in the sprite will be visible 
+(subject to device-dependent constraints, of 
+course). Specifying an empty XPolyPolygon2D, i.e. a 
+poly-polygon containing zero polygons, or an XPolyPolygon2D 
+with any number of empty sub-polygons, denotes the NULL 
+clip. That means, nothing from the sprite will be visible. <p>
+
+</dd>
+<dt><b>Parameter aClip</b></dt>
+<dd>The clip poly-polygon to apply. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="setPriority" class="membertitle">setPriority</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>setPriority</b>(</td>
+<td valign="top">[in] double</td>
+<td valign="bottom">&nbsp;nPriority );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Set sprite priority. </dd>
+<dd><p>
+
+The sprite priority determines the order of rendering relative 
+to all other sprites of the associated canvas. The higher the 
+priority, the later will the sprite be rendered, or, in other 
+words, the closer to the screen surface the sprite is shown. <p>
+
+</dd>
+<dt><b>Parameter nPriority</b></dt>
+<dd>New sprite priority value to serve as the sort key when 
+determining sprite rendering order. Avoid NaNs and other 
+irregular floating point values here, the order position for 
+sprites with such a priority value is undefined. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="show" class="membertitle">show</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>show</b>();</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Make the sprite visible. </dd>
+<dd><p>
+
+This method makes the sprite visible on the canvas it was 
+created on. <p>
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="hide" class="membertitle">hide</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>hide</b>();</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Make the sprite invisible. </dd>
+<dd><p>
+
+This method makes the sprite invisible. <p>
+</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; 2003 Sun Microsystems, Inc.</p>
+
+</div> <!-- id="adc-idlref" -->
+</body>
+
+</html>

Propchange: incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSprite.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSpriteCanvas-xref.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSpriteCanvas-xref.html?rev=1206299&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSpriteCanvas-xref.html (added)
+++ incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSpriteCanvas-xref.html Fri Nov 25 20:06:37 2011
@@ -0,0 +1,55 @@
+<html>
+<head>
+<title>Uses of Interface XSpriteCanvas-xref</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="navimainself">Use</td>
+<td class="navimainnone">Devguide</td>
+<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
+</tr>
+</table>
+<hr>
+<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
+<tr>
+<td class="title">uses of interface XSpriteCanvas</td>
+</tr>
+<tr>
+<td><p><a href="XSpriteCanvas.html"><b>back to interface XSpriteCanvas</b></a><br>
+<br>
+
+Derived Interfaces<br>
+
+Synonym Typedefs<br>
+
+Services which Support this Interface<br>
+
+Singletons which Support this Interface<br>
+
+Uses as Return Type<br>
+
+Uses as Parameter<br>
+
+Uses as Data Type<br>
+
+References in Developers Guide<br>
+
+</p>
+</td>
+</tr>
+</table>
+<hr>
+<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2003 Sun Microsystems, Inc.</p>
+
+</div> <!-- id="adc-idlref" -->
+</body>
+
+</html>

Propchange: incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSpriteCanvas-xref.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSpriteCanvas.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSpriteCanvas.html?rev=1206299&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSpriteCanvas.html (added)
+++ incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSpriteCanvas.html Fri Nov 25 20:06:37 2011
@@ -0,0 +1,379 @@
+<html>
+<head>
+<title>Interface XSpriteCanvas</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="XSpriteCanvas-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="#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">rendering</a> :: </p>
+</td>
+</tr>
+<tr>
+<td class="title"><table class="title-table" width="99%">
+<tr>
+<td width="25%" class="title2">unpublished </td>
+<td width="50%" class="title">interface XSpriteCanvas</td>
+<td width="*"/></tr>
+</table>
+</td>
+</tr>
+<tr>
+<td><dl>
+<dt><b>Base Interfaces</b></dt>
+<dd><pre style="font-family:monospace;"><strong>XSpriteCanvas</strong>
+&#x2517 <a href="XBitmapCanvas.html">XBitmapCanvas</a>
+   &#x2517 <a href="XCanvas.html">XCanvas</a>
+      &#x2517 ::com::sun::star::uno::XInterface
+
+</pre></dd>
+<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
+<tr>
+<td class="imsum_left"><a href="XBitmapCanvas.html">XBitmapCanvas</a></td>
+<td class="imsum_right"><dl>
+<dt>(referenced interface's summary:)</dt>
+<dd>This is a specialization of the canvas interface for bitmapped 
+canvases. </dd>
+</dl>
+</td>
+</tr>
+</table>
+</dd>
+</dl>
+</td>
+</tr>
+<tr>
+<td><dl>
+<dt><b>Description</b></dt>
+<dd>Specialization of a XBitmapCanvas, where moving, animated objects 
+(called sprites) are supported. 
+
+@attention The screen output of canvas drawing operations is 
+undefined, unless XSpriteCanvas::updateScreen() is called. This is 
+because a sprite canvas might choose to employ double buffering to 
+reduce animation flicker, and cannot know the instant suitable to 
+display the newly rendered canvas content. When using external 
+double-buffering via XBufferController on a sprite canvas, the 
+implementation takes care of this issue, and in this case is able 
+to render correctly even without explicit updateScreen() calls 
+(because there's a defined moment in time where content display 
+can happen, namely the XBufferController::showBuffer()) call. If 
+you don't need sprite functionality, and don't want the 
+updateScreen hassle, simply use the XBitmapCanvas. 
+</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="#createSpriteFromAnimation">createSpriteFromAnimation</a></td>
+<td class="imsum_right">Create a sprite object from the specified animation 
+sequence. A sprite is a back-buffered object with its own, 
+independent animation. 
+&nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#createSpriteFromBitmaps">createSpriteFromBitmaps</a></td>
+<td class="imsum_right">Create a sprite object from the specified animation 
+sequence. 
+
+A sprite is a back-buffered object with its own, 
+independent animation. 
+
+&nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#createCustomSprite">createCustomSprite</a></td>
+<td class="imsum_right">Create a custom, user-handles-it-all sprite object. 
+
+A sprite is a back-buffered object with its own, independent 
+animation. 
+
+&nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#createClonedSprite">createClonedSprite</a></td>
+<td class="imsum_right">Create a cloned version of an already existing sprite 
+object. 
+
+The cloned sprite always shows the same content as its 
+original. Furthermore, cloned copies of a hidden original are 
+never visible, although cloned copies of a visible original 
+can of course be invisible. 
+
+&nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#updateScreen">updateScreen</a></td>
+<td class="imsum_right">Tells the sprite canvas to now update the screen 
+representation. 
+
+Required to display rendered changes to the canvas, and 
+updates to stopped animations and XCustomSprites in 
+general. This method will return only after the screen update 
+is done, or earlier if an error happened. &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="createSpriteFromAnimation" class="membertitle">createSpriteFromAnimation</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="XAnimatedSprite.html">XAnimatedSprite</a></td>
+</tr>
+<tr>
+<td valign="top"><b>createSpriteFromAnimation</b>(</td>
+<td valign="top">[in] <a href="XAnimation.html">XAnimation</a></td>
+<td valign="bottom">&nbsp;animation )</td>
+</tr>
+<tr>
+<td valign="top" align="right">raises( </td>
+<td valign="top" colspan="2">::com::sun::star::lang::IllegalArgumentException );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Create a sprite object from the specified animation 
+sequence. A sprite is a back-buffered object with its own, 
+independent animation. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="createSpriteFromBitmaps" class="membertitle">createSpriteFromBitmaps</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="XAnimatedSprite.html">XAnimatedSprite</a></td>
+</tr>
+<tr>
+<td valign="top"><b>createSpriteFromBitmaps</b>(</td>
+<td valign="top">[in] sequence&lt; <a href="XBitmap.html">XBitmap</a> &gt;</td>
+<td valign="bottom">&nbsp;animationBitmaps,</td>
+</tr>
+<tr>
+<td/><td valign="top">[in] byte</td>
+<td valign="bottom">&nbsp;interpolationMode )</td>
+</tr>
+<tr>
+<td valign="top" align="right">raises( </td>
+<td valign="top" colspan="2">::com::sun::star::lang::IllegalArgumentException,<br>
+<a href="VolatileContentDestroyedException.html">VolatileContentDestroyedException</a> );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Create a sprite object from the specified animation 
+sequence. 
+
+A sprite is a back-buffered object with its own, 
+independent animation. 
+
+</dd>
+<dt><b>Parameter animationBitmaps</b></dt>
+<dd>Sequence of bitmaps. The bitmaps don't need to have the same 
+size, but they are all rendered with their left, top edges 
+aligned. 
+
+</dd>
+<dt><b>Parameter interpolationMode</b></dt>
+<dd>Value of <a href="InterpolationMode.html">InterpolationMode</a> , to determine whether 
+and how to interpolate between the provided bitmaps, if 
+animation runs fast enough. 
+
+</dd>
+<dt><b>Throws</b></dt>
+<dd>VolatileContentDestroyedException 
+if at least one of the bitmap is volatile, and its content has been destroyed by the system. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="createCustomSprite" class="membertitle">createCustomSprite</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="XCustomSprite.html">XCustomSprite</a></td>
+</tr>
+<tr>
+<td valign="top"><b>createCustomSprite</b>(</td>
+<td valign="top">[in] ::com::sun::star::geometry::RealSize2D</td>
+<td valign="bottom">&nbsp;spriteSize )</td>
+</tr>
+<tr>
+<td valign="top" align="right">raises( </td>
+<td valign="top" colspan="2">::com::sun::star::lang::IllegalArgumentException );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Create a custom, user-handles-it-all sprite object. 
+
+A sprite is a back-buffered object with its own, independent 
+animation. 
+
+</dd>
+<dt><b>Parameter spriteSize</b></dt>
+<dd>The required size of the sprite in device 
+coordinates. Everything that is rendered outside this area 
+might be clipped on output. Both components of the size must 
+be greater than zero. 
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>an interface to a custom sprite object. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="createClonedSprite" class="membertitle">createClonedSprite</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="XSprite.html">XSprite</a></td>
+</tr>
+<tr>
+<td valign="top"><b>createClonedSprite</b>(</td>
+<td valign="top">[in] <a href="XSprite.html">XSprite</a></td>
+<td valign="bottom">&nbsp;original )</td>
+</tr>
+<tr>
+<td valign="top" align="right">raises( </td>
+<td valign="top" colspan="2">::com::sun::star::lang::IllegalArgumentException );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Create a cloned version of an already existing sprite 
+object. 
+
+The cloned sprite always shows the same content as its 
+original. Furthermore, cloned copies of a hidden original are 
+never visible, although cloned copies of a visible original 
+can of course be invisible. 
+
+</dd>
+<dt><b>Parameter original</b></dt>
+<dd>The original sprite to copy the content from. This sprite must 
+have been created by the same XSpriteCanvas instance as this 
+method is called on. Other sprite instances will generate an 
+IllegalArgumentException. 
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>an interface to a sprite object. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="updateScreen" class="membertitle">updateScreen</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">boolean</td>
+</tr>
+<tr>
+<td valign="top"><b>updateScreen</b>(</td>
+<td valign="top">[in] boolean</td>
+<td valign="bottom">&nbsp;bUpdateAll );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Tells the sprite canvas to now update the screen 
+representation. 
+
+Required to display rendered changes to the canvas, and 
+updates to stopped animations and XCustomSprites in 
+general. This method will return only after the screen update 
+is done, or earlier if an error happened. </dd>
+<dd><p>
+
+If double buffering is enabled via XBufferController, no 
+explicit call of updateScreen() is necessary, since the 
+XBufferController methods will automatically notify all 
+associated XSpriteCanvas instances. <p>
+
+</dd>
+<dt><b>Parameter bUpdateAll</b></dt>
+<dd>When <b>true</b> , update the whole screen. When <b>false</b> , 
+implementation is permitted to restrict update to areas the 
+canvas itself changed (e.g. because of render operations, or 
+changes on the sprites). The former is useful for updates 
+after window expose events. the latter for animation display. 
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd><b>true</b> , if the screen update was successfully 
+performed 
+</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; 2003 Sun Microsystems, Inc.</p>
+
+</div> <!-- id="adc-idlref" -->
+</body>
+
+</html>

Propchange: incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XSpriteCanvas.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XTextLayout-xref.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XTextLayout-xref.html?rev=1206299&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XTextLayout-xref.html (added)
+++ incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XTextLayout-xref.html Fri Nov 25 20:06:37 2011
@@ -0,0 +1,74 @@
+<html>
+<head>
+<title>Uses of Interface XTextLayout-xref</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="navimainself">Use</td>
+<td class="navimainnone">Devguide</td>
+<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
+</tr>
+</table>
+<hr>
+<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
+<tr>
+<td class="title">uses of interface XTextLayout</td>
+</tr>
+<tr>
+<td><p><a href="XTextLayout.html"><b>back to interface XTextLayout</b></a><br>
+<br>
+
+Derived Interfaces<br>
+
+Synonym Typedefs<br>
+
+Services which Support this Interface<br>
+
+Singletons which Support this Interface<br>
+
+<a href="#Returns">Uses as Return Type<br>
+
+</a><a href="#Parameters">Uses as Parameter<br>
+
+</a>Uses as Data Type<br>
+
+References in Developers Guide<br>
+
+</p>
+</td>
+</tr>
+</table>
+<hr>
+<a name="Returns"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
+<tr>
+<td class="subtitle">Uses as Return Type</td>
+</tr>
+<tr>
+<td><a href="XCanvasFont.html">XCanvasFont</a>::<a href="XCanvasFont.html#createTextLayout">createTextLayout()</a><br>
+</td>
+</tr>
+</table>
+<a name="Parameters"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
+<tr>
+<td class="subtitle">Uses as Parameter</td>
+</tr>
+<tr>
+<td><a href="XCanvas.html">XCanvas</a>::<a href="XCanvas.html#drawTextLayout">drawTextLayout()</a><br>
+<a href="XCanvas.html">XCanvas</a>::<a href="XCanvas.html#drawTextLayout">drawTextLayout()</a><br>
+</td>
+</tr>
+</table>
+<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2003 Sun Microsystems, Inc.</p>
+
+</div> <!-- id="adc-idlref" -->
+</body>
+
+</html>

Propchange: incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XTextLayout-xref.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XTextLayout.html
URL: http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XTextLayout.html?rev=1206299&view=auto
==============================================================================
--- incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XTextLayout.html (added)
+++ incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XTextLayout.html Fri Nov 25 20:06:37 2011
@@ -0,0 +1,945 @@
+<html>
+<head>
+<title>Interface XTextLayout</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="XTextLayout-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="#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">rendering</a> :: </p>
+</td>
+</tr>
+<tr>
+<td class="title"><table class="title-table" width="99%">
+<tr>
+<td width="25%" class="title2">unpublished </td>
+<td width="50%" class="title">interface XTextLayout</td>
+<td width="*"/></tr>
+</table>
+</td>
+</tr>
+<tr>
+<td><dl>
+<dt><b>Base Interfaces</b></dt>
+<dd><pre style="font-family:monospace;"><strong>XTextLayout</strong>
+&#x2517 ::com::sun::star::uno::XInterface
+
+</pre></dd>
+<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
+<tr>
+<td class="imsum_left">::com::sun::star::uno::XInterface</td>
+<td class="imsum_right"><dl></dl>
+</td>
+</tr>
+</table>
+</dd>
+</dl>
+</td>
+</tr>
+<tr>
+<td><dl>
+<dt><b>Description</b></dt>
+<dd>This is the central interface for text layouting. </dd>
+<dd><p>
+
+This is the central interface for text-related tasks more 
+complicated than simple string rendering. Note that all query 
+methods are subject to the current layout state of this 
+object. That is, calls to <a href="XTextLayout.html#justify()">justify()</a> 
+or <a href="XTextLayout.html#applyLogicalAdvancements()">applyLogicalAdvancements()</a> are 
+likely to change subsequent output of those query methods. <p>
+
+Similar to <a href="XCanvasFont.html">XCanvasFont</a> , all measurements and 
+coordinates accepted and returned by this interface are relative 
+to the font's local coordinate system (which only equals device 
+coordinate space, if the combined render transformation used 
+during text output is the identity transformation). Conversely, if 
+the combined transformation used during text output is 
+<em>not </em>the identity transformation, all measurements 
+returned by this interface should be subjected to that 
+transformation, to yield values in device coordinate space. 
+Depending on the underlying font technology, actual device output 
+might be off by up to one device pixel from the transformed 
+metrics. <p>
+
+</dd>
+<dt><b>Since </b></dt>
+<dd>OOo 2.0.0 </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="#queryTextShapes">queryTextShapes</a></td>
+<td class="imsum_right">Extract the polygonal shapes of the layouted text. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#queryInkMeasures">queryInkMeasures</a></td>
+<td class="imsum_right">Query the ink bounding boxes for every glyph in the layouted 
+text. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#queryMeasures">queryMeasures</a></td>
+<td class="imsum_right">Query the logical bounding boxes of every character in the 
+given text string. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#queryLogicalAdvancements">queryLogicalAdvancements</a></td>
+<td class="imsum_right">Query the advancements for every character in the input string. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#applyLogicalAdvancements">applyLogicalAdvancements</a></td>
+<td class="imsum_right">Apply explicit advancements for every character in the layout 
+string. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#queryTextBounds">queryTextBounds</a></td>
+<td class="imsum_right">Query the overall bounding box of the text. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#justify">justify</a></td>
+<td class="imsum_right">Justify the text to the given size. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#combinedJustify">combinedJustify</a></td>
+<td class="imsum_right">Justify a number of text layouts to the given size. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#getTextHit">getTextHit</a></td>
+<td class="imsum_right">This method determines the hit position in the text. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#getCaret">getCaret</a></td>
+<td class="imsum_right">This method converts an insertion index to a caret. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#getNextInsertionIndex">getNextInsertionIndex</a></td>
+<td class="imsum_right">This method calculates a new insertion index. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#queryVisualHighlighting">queryVisualHighlighting</a></td>
+<td class="imsum_right">This method generates a highlight polygon. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#queryLogicalHighlighting">queryLogicalHighlighting</a></td>
+<td class="imsum_right">This method generates a highlight polygon. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#getBaselineOffset">getBaselineOffset</a></td>
+<td class="imsum_right">This method yields the baseline offset. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#getMainTextDirection">getMainTextDirection</a></td>
+<td class="imsum_right">This method returns the main writing direction. &nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#getFont">getFont</a></td>
+<td class="imsum_right">Request the associated font for this layout.. 
+
+&nbsp;</td>
+</tr>
+<tr>
+<td class="imsum_left"><a href="#getText">getText</a></td>
+<td class="imsum_right">Request the text this layout contains. 
+
+&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="queryTextShapes" class="membertitle">queryTextShapes</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">sequence&lt; <a href="XPolyPolygon2D.html">XPolyPolygon2D</a> &gt;</td>
+</tr>
+<tr>
+<td valign="top"><b>queryTextShapes</b>();</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Extract the polygonal shapes of the layouted text. </dd>
+<dd><p>
+
+Each glyph is represented by a separate 
+<a href="XPolyPolygon2D.html">XPolyPolygon2D</a> in the returned sequence. <p>
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>a sequence of <a href="XPolyPolygon2D.html">XPolyPolygon2D</a> in font 
+coordinate space, one for every glyph. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="queryInkMeasures" class="membertitle">queryInkMeasures</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">sequence&lt; ::com::sun::star::geometry::RealRectangle2D &gt;</td>
+</tr>
+<tr>
+<td valign="top"><b>queryInkMeasures</b>();</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Query the ink bounding boxes for every glyph in the layouted 
+text. </dd>
+<dd><p>
+
+Ink, or tight bounding boxes in this case means that for 
+e.g. an 'a', the bounding box for the 
+<a href="XPolyPolygon2D.html">XPolyPolygon2D</a> describing the glyph 'a' is 
+returned, not the logical dimensions of the character in the 
+font. <p>
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>a sequence of rectangles in font coordinate space, 
+specifying the bounds, one for every glyph. 
+
+</dd>
+<dt><b>See also</b></dt>
+<dd><a href="#unknown ?">unknown ?</a><br>
+XTextLayout::queryMeasures() 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="queryMeasures" class="membertitle">queryMeasures</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">sequence&lt; ::com::sun::star::geometry::RealRectangle2D &gt;</td>
+</tr>
+<tr>
+<td valign="top"><b>queryMeasures</b>();</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Query the logical bounding boxes of every character in the 
+given text string. </dd>
+<dd><p>
+
+Logical bounding boxes means the space that the font allocates 
+for the given character, which, e.g. for a '.', might be 
+significantly broader than the bounds returned via 
+<a href="XTextLayout.html">XTextLayout</a>::<a href="XTextLayout.html#queryInkMeasures">queryInkMeasures()</a> . 
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>a sequence of rectangles specifying the bounds in 
+font coordinate space, one for every glyph. 
+
+</dd>
+<dt><b>See also</b></dt>
+<dd><a href="#unknown ?">unknown ?</a><br>
+XTextLayout::queryInkMeasures() 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="queryLogicalAdvancements" class="membertitle">queryLogicalAdvancements</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">sequence&lt; double &gt;</td>
+</tr>
+<tr>
+<td valign="top"><b>queryLogicalAdvancements</b>();</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Query the advancements for every character in the input string. </dd>
+<dd><p>
+
+This method returns a sequence of advancements, one for each 
+character in the input string ( <em>not </em>for every 
+glyph. There might be multiple glyphs per input character, or 
+multiple input characters per glyph). Adding up all 
+advancements yields the total advancement of this layout. To 
+manipulate the layout of a string on the level of characters, 
+this method can be used to query for the layout's default 
+advancements, which can subsequently be changed and applied to 
+the layout via 
+<a href="XTextLayout.html">XTextLayout</a>::<a href="XTextLayout.html#applyLogicalAdvancements">applyLogicalAdvancements()</a> . <p>
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>a sequence of ::double specifying the 
+advancements per character in font coordinate space. 
+
+</dd>
+<dt><b>See also</b></dt>
+<dd><a href="#unknown ?">unknown ?</a><br>
+XTextLayout::applyLogicalAdvancements() 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="applyLogicalAdvancements" class="membertitle">applyLogicalAdvancements</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>applyLogicalAdvancements</b>(</td>
+<td valign="top">[in] sequence&lt; double &gt;</td>
+<td valign="bottom">&nbsp;aAdvancements )</td>
+</tr>
+<tr>
+<td valign="top" align="right">raises( </td>
+<td valign="top" colspan="2">::com::sun::star::lang::IllegalArgumentException );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Apply explicit advancements for every character in the layout 
+string. </dd>
+<dd><p>
+
+This method applies the specified advancements to every 
+logical character in the input string ( <em>not </em>for every 
+glyph. There might be multiple glyphs per input character, or 
+multiple input characters per glyph). This is useful to 
+explicitely manipulate the exact output positions of 
+characters, e.g. relative to a reference output device. <p>
+
+</dd>
+<dt><b>Parameter aAdvancements</b></dt>
+<dd>A sequence of character advancements, in font coordinate 
+space. 
+
+</dd>
+<dt><b>Throws</b></dt>
+<dd>com::sun::star::lang::IllegalArgumentException 
+if the size of aAdvancements does not match the number of 
+characters in the text. 
+</dd>
+<dt><b>See also</b></dt>
+<dd><a href="#unknown ?">unknown ?</a><br>
+XTextLayout::queryLogicalAdvancements() 
+
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="queryTextBounds" class="membertitle">queryTextBounds</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">::com::sun::star::geometry::RealRectangle2D</td>
+</tr>
+<tr>
+<td valign="top"><b>queryTextBounds</b>();</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Query the overall bounding box of the text. </dd>
+<dd><p>
+
+This method is similar to 
+<a href="XTextLayout.html">XTextLayout</a>::<a href="XTextLayout.html#queryTextMeasures">queryTextMeasures</a> , only that the 
+overall bounds are returned by this method. <p>
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>the overall bounding box for the given layout, in font 
+coordinate space. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="justify" class="membertitle">justify</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">double</td>
+</tr>
+<tr>
+<td valign="top"><b>justify</b>(</td>
+<td valign="top">[in] double</td>
+<td valign="bottom">&nbsp;nSize )</td>
+</tr>
+<tr>
+<td valign="top" align="right">raises( </td>
+<td valign="top" colspan="2">::com::sun::star::lang::IllegalArgumentException );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Justify the text to the given size. </dd>
+<dd><p>
+
+This method is the core of the <a href="XTextLayout.html">XTextLayout</a> 
+interface, because it layouts the text in a typographically 
+correct way into the available space. <p>
+
+</dd>
+<dt><b>Parameter nSize</b></dt>
+<dd>The requested size of the text after justification (either 
+width or height, depending on the writing mode). This 
+parameter is interpreted in font coordinate space. 
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>the actual size of the text after the justification in 
+the font coordinate space. Depending on the font and the 
+script type, this might be somewhat different from the size 
+requested. If the requested size was smaller than the 
+justification algorithm could compress the text, this value 
+might even be significantly larger than nSize. 
+
+</dd>
+<dt><b>Throws</b></dt>
+<dd>com::sun::star::lang::IllegalArgumentException 
+if nSize is 0 or negative. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="combinedJustify" class="membertitle">combinedJustify</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">double</td>
+</tr>
+<tr>
+<td valign="top"><b>combinedJustify</b>(</td>
+<td valign="top">[in] sequence&lt; <a href="XTextLayout.html">XTextLayout</a> &gt;</td>
+<td valign="bottom">&nbsp;aNextLayouts,</td>
+</tr>
+<tr>
+<td/><td valign="top">[in] double</td>
+<td valign="bottom">&nbsp;nSize )</td>
+</tr>
+<tr>
+<td valign="top" align="right">raises( </td>
+<td valign="top" colspan="2">::com::sun::star::lang::IllegalArgumentException );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Justify a number of text layouts to the given size. </dd>
+<dd><p>
+
+This method can be used to combine the layout of a text line 
+into a single justification run. This is e.g. useful if the 
+line consists of several text portions (e.g. because of 
+different fonts or colors), but it is desirable to spread the 
+available space more globally across the different layout 
+objects. If, for example, one layout object contains 
+significantly more whitespace or Kashidas than the rest, this 
+method can assign proportionally more space to this layout 
+object. <p>
+
+</dd>
+<dt><b>Parameter aNextLayouts</b></dt>
+<dd>A sequence of layouts following this one in logical text 
+order. 
+
+</dd>
+<dt><b>Parameter nSize</b></dt>
+<dd>The requested size of the text for <em>all </em>
+<a href="XTextLayout.html">XTextLayout</a> s after justification in font 
+coordinate space (either width or height, depending on the 
+writing mode). 
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>the actual size of the text after the justification, 
+in font coordinate space. Depending on the font and the 
+script type, this might be somewhat different from the size 
+requested. If the requested size was smaller than the 
+justification algorithm could compress the text, this value 
+might even be significantly larger than nSize. 
+
+</dd>
+<dt><b>Throws</b></dt>
+<dd>com::sun::star::lang::IllegalArgumentException 
+if one of the parameters are not in the valid range. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="getTextHit" class="membertitle">getTextHit</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="TextHit.html">TextHit</a></td>
+</tr>
+<tr>
+<td valign="top"><b>getTextHit</b>(</td>
+<td valign="top">[in] ::com::sun::star::geometry::RealPoint2D</td>
+<td valign="bottom">&nbsp;aHitPoint );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>This method determines the hit position in the text. </dd>
+<dd><p>
+
+This method determines the index of the character hit at the 
+specified position (in font coordinate space). <p>
+
+</dd>
+<dt><b>Parameter aHitPoint</b></dt>
+<dd>The position in font coordinate space to determine the 
+underlying character index for. 
+
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="getCaret" class="membertitle">getCaret</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="Caret.html">Caret</a></td>
+</tr>
+<tr>
+<td valign="top"><b>getCaret</b>(</td>
+<td valign="top">[in] long</td>
+<td valign="bottom">&nbsp;nInsertionIndex,</td>
+</tr>
+<tr>
+<td/><td valign="top">[in] boolean</td>
+<td valign="bottom">&nbsp;bExcludeLigatures )</td>
+</tr>
+<tr>
+<td valign="top" align="right">raises( </td>
+<td valign="top" colspan="2">::com::sun::star::lang::IndexOutOfBoundsException );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>This method converts an insertion index to a caret. </dd>
+<dd><p>
+
+This method generates caret information for a given insertion 
+point in the layout text. <p>
+
+</dd>
+<dt><b>Parameter nInsertionIndex</b></dt>
+<dd>The insertion index, as e.g. returned by 
+<a href="XTextLayout.html">XTextLayout</a>::<a href="XTextLayout.html#getTextHit">getTextHit()</a> . This value must be 
+in the range 0 up to the number of characters in the string. 
+
+</dd>
+<dt><b>Parameter bExcludeLigatures</b></dt>
+<dd>Set this to <b>true</b> , to skip the positions inside ligatures as 
+valid caret placements. That means, on cannot e.g. set the 
+caret between the 'f' and the 'i' in a 'fi' ligature. 
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>the generated Caret structure. 
+
+</dd>
+<dt><b>Throws</b></dt>
+<dd>com::sun::star::lang::IndexOutOfBoundsException 
+if nInsertionIndex is outside the permissible range. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="getNextInsertionIndex" class="membertitle">getNextInsertionIndex</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">long</td>
+</tr>
+<tr>
+<td valign="top"><b>getNextInsertionIndex</b>(</td>
+<td valign="top">[in] long</td>
+<td valign="bottom">&nbsp;nStartIndex,</td>
+</tr>
+<tr>
+<td/><td valign="top">[in] long</td>
+<td valign="bottom">&nbsp;nCaretAdvancement,</td>
+</tr>
+<tr>
+<td/><td valign="top">[in] boolean</td>
+<td valign="bottom">&nbsp;bExcludeLigatures )</td>
+</tr>
+<tr>
+<td valign="top" align="right">raises( </td>
+<td valign="top" colspan="2">::com::sun::star::lang::IndexOutOfBoundsException );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>This method calculates a new insertion index. </dd>
+<dd><p>
+
+This method calculates a new insertion index, given a start 
+index and the number of characters to skip. This is most 
+useful for caret traveling. <p>
+
+</dd>
+<dt><b>Parameter nStartIndex</b></dt>
+<dd>The insertion index to start from. 
+
+</dd>
+<dt><b>Parameter nCaretAdvancement</b></dt>
+<dd>For values greater than 0, the caret is visually moved to the 
+right. For values smaller than 0, the caret is visually moved 
+to the left. 
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>the new insertion index. 
+
+</dd>
+<dt><b>Throws</b></dt>
+<dd>com::sun::star::lang::IndexOutOfBoundsException 
+if nStartIndex or nCaretAdvancement is outside the permissible 
+range. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="queryVisualHighlighting" class="membertitle">queryVisualHighlighting</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="XPolyPolygon2D.html">XPolyPolygon2D</a></td>
+</tr>
+<tr>
+<td valign="top"><b>queryVisualHighlighting</b>(</td>
+<td valign="top">[in] long</td>
+<td valign="bottom">&nbsp;nStartIndex,</td>
+</tr>
+<tr>
+<td/><td valign="top">[in] long</td>
+<td valign="bottom">&nbsp;nEndIndex )</td>
+</tr>
+<tr>
+<td valign="top" align="right">raises( </td>
+<td valign="top" colspan="2">::com::sun::star::lang::IndexOutOfBoundsException );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>This method generates a highlight polygon. </dd>
+<dd><p>
+
+This method generates a highlighting polygon from two 
+insertion indices. This polygon will be visually continuous, 
+i.e. will not have non-highlighted text in between. <p>
+
+</dd>
+<dt><b>Parameter nStartIndex</b></dt>
+<dd>Start of the selection range. 
+
+</dd>
+<dt><b>Parameter nEndIndex</b></dt>
+<dd>End of the selection range. 
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>the highlight polygon in the font coordinate space. 
+
+</dd>
+<dt><b>Throws</b></dt>
+<dd>com::sun::star::lang::IndexOutOfBoundsException 
+if nStartIndex or nEndIndex are outside the permissible 
+range. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="queryLogicalHighlighting" class="membertitle">queryLogicalHighlighting</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="XPolyPolygon2D.html">XPolyPolygon2D</a></td>
+</tr>
+<tr>
+<td valign="top"><b>queryLogicalHighlighting</b>(</td>
+<td valign="top">[in] long</td>
+<td valign="bottom">&nbsp;nStartIndex,</td>
+</tr>
+<tr>
+<td/><td valign="top">[in] long</td>
+<td valign="bottom">&nbsp;nEndIndex )</td>
+</tr>
+<tr>
+<td valign="top" align="right">raises( </td>
+<td valign="top" colspan="2">::com::sun::star::lang::IndexOutOfBoundsException );</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>This method generates a highlight polygon. </dd>
+<dd><p>
+
+This method generates a highlighting polygon from two 
+insertion indices. This polygon will not always be visually 
+continuous, if e.g. the text direction changes in the middle 
+of the selection, the might be parts visually between start 
+and end position that are not selected. <p>
+
+</dd>
+<dt><b>Parameter nStartIndex</b></dt>
+<dd>Start of the selection range. 
+
+</dd>
+<dt><b>Parameter nEndIndex</b></dt>
+<dd>End of the selection range. 
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>the highlight polygon in the font coordinate space. 
+
+</dd>
+<dt><b>Throws</b></dt>
+<dd>com::sun::star::lang::IndexOutOfBoundsException 
+if nStartIndex or nEndIndex are outside the permissible 
+range. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="getBaselineOffset" class="membertitle">getBaselineOffset</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">double</td>
+</tr>
+<tr>
+<td valign="top"><b>getBaselineOffset</b>();</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>This method yields the baseline offset. </dd>
+<dd><p>
+
+This method returns the baseline offset for this layout 
+object, either measured from the top or the left edge, 
+depending on the writing direction (horizontally or 
+vertically). Since rendering this layout via 
+<a href="XCanvas.html">XCanvas</a>::<a href="XCanvas.html#drawTextLayout">drawTextLayout()</a> outputs relative to 
+the layout object's baseline, this method can be used to 
+e.g. output relative to the left, top edge. <p>
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>the distance of the main baseline from the top or the 
+left edge of this object, depending on the writing direction. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="getMainTextDirection" class="membertitle">getMainTextDirection</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">byte</td>
+</tr>
+<tr>
+<td valign="top"><b>getMainTextDirection</b>();</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>This method returns the main writing direction. </dd>
+<dd><p>
+
+This method returns the main writing direction of this layout, 
+i.e. either LEFT_TO_RIGHT or RIGHT_TO_LEFT. <p>
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>the main text direction of this layout. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="getFont" class="membertitle">getFont</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="XCanvasFont.html">XCanvasFont</a></td>
+</tr>
+<tr>
+<td valign="top"><b>getFont</b>();</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Request the associated font for this layout.. 
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>the associated font for this layout. 
+</dd>
+</dl>
+</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
+<td class="imdetail"><a name="getText" class="membertitle">getText</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="StringContext.html">StringContext</a></td>
+</tr>
+<tr>
+<td valign="top"><b>getText</b>();</td>
+</tr>
+</table>
+<hr>
+<dl>
+<dt><b>Description</b></dt>
+<dd>Request the text this layout contains. 
+
+</dd>
+<dt><b>Returns</b></dt>
+<dd>the text this layout contains. 
+</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; 2003 Sun Microsystems, Inc.</p>
+
+</div> <!-- id="adc-idlref" -->
+</body>
+
+</html>

Propchange: incubator/ooo/ooo-site/trunk/content/gsl/canvas/api/rendering/XTextLayout.html
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message