From 22e88f0ef7e3fb0f96170c03e059fe00fd049c8b Mon Sep 17 00:00:00 2001 From: Kurt Zenker Date: Tue, 24 Jun 2008 10:26:46 +0000 Subject: INTEGRATION: CWS canvas05 (1.5.56); FILE MERGED 2008/04/21 07:38:01 thb 1.5.56.4: RESYNC: (1.6-1.7); FILE MERGED 2008/04/07 14:35:53 thb 1.5.56.3: RESYNC: (1.5-1.6); FILE MERGED 2007/12/20 16:34:43 thb 1.5.56.2: #i81094# Clarified documentation 2007/10/01 13:33:53 thb 1.5.56.1: #i79437# Merge from CWS picom --- offapi/com/sun/star/rendering/XCanvas.idl | 74 ++++++++++++++++++++----------- 1 file changed, 47 insertions(+), 27 deletions(-) (limited to 'offapi/com/sun') diff --git a/offapi/com/sun/star/rendering/XCanvas.idl b/offapi/com/sun/star/rendering/XCanvas.idl index 36dfb3990..bd5c4f53a 100644 --- a/offapi/com/sun/star/rendering/XCanvas.idl +++ b/offapi/com/sun/star/rendering/XCanvas.idl @@ -7,7 +7,7 @@ * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: XCanvas.idl,v $ - * $Revision: 1.7 $ + * $Revision: 1.8 $ * * This file is part of OpenOffice.org. * @@ -124,13 +124,32 @@ interface XTextLayout; extra clipping).

Furtheron, this stateless nature provides easy ways for - caching. Every non-trivial operation on XCanvas - returns a cache object, which, when called to redraw, renders the + caching. Every non-trivial operation on XCanvas can + return a cache object, which, when called to redraw, renders the primitive usually much more quickly than the original method. Note that such caching is a lot more complicated, should the actual rendering a method yields depend on internal state (which is the case e.g. for the - XGraphics interface).

+ ::com::sun::star::drawing::XGraphics + interface). Please note, though, that deciding whether to return + an XCachedPrimitive is completely up to the + implementation - don't rely on the methods returning something + (this is because there might be cases when returning such a cache + object will actually be a pessimization, since it involves memory + allocation and comparisons).

+ + Things that need more than a small, fixed amount of data are + encapsulated in own interfaces, e.g. polygons and bitmaps. You + can, in principle, roll your own implementations of these + interfaces, wrap it around your internal representation of + polygons and bitmaps, and render them. It might just not be overly + fast, because the XCanvas would need to convert for + each render call. It is therefore recommended to create such + objects via the XGraphicDevice factory (to be + retrieved from every canvas object via the + getDevice() call) - they will then internally + optimize to the underlying graphics subsystem.

@since OOo 2.0.0 */ @@ -155,7 +174,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @param aRenderState The renderstate to be used when drawing this point. - @throws com::sun::star::lang::IllegalArgumentException + @throws com::sun::star::lang::IllegalArgumentException if one of the view and renderstate parameters are outside the specified range. */ @@ -179,7 +198,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @param aRenderState The renderstate to be used when drawing this line. - @throws com::sun::star::lang::IllegalArgumentException + @throws com::sun::star::lang::IllegalArgumentException if one of the view and renderstate parameters are outside the specified range. */ @@ -203,7 +222,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @param aRenderState The renderstate to be used when drawing this curve. - @throws com::sun::star::lang::IllegalArgumentException + @throws com::sun::star::lang::IllegalArgumentException if one of the view and renderstate parameters are outside the specified range. */ @@ -226,7 +245,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws com::sun::star::lang::IllegalArgumentException + @throws com::sun::star::lang::IllegalArgumentException if one of the view and renderstate parameters are outside the specified range. */ @@ -259,7 +278,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws com::sun::star::lang::IllegalArgumentException + @throws com::sun::star::lang::IllegalArgumentException if one of the view and renderstate parameters are outside the specified range. */ @@ -297,11 +316,11 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws com::sun::star::lang::IllegalArgumentException + @throws com::sun::star::lang::IllegalArgumentException if one of the view and renderstate parameters are outside the specified range. - @throws VolatileContentDestroyedException + @throws VolatileContentDestroyedException if a texture bitmap was volatile, and the content was destroyed before the rendering could take place. */ @@ -345,11 +364,11 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws com::sun::star::lang::IllegalArgumentException + @throws com::sun::star::lang::IllegalArgumentException if one of the view and renderstate parameters are outside the specified range. - @throws VolatileContentDestroyedException + @throws VolatileContentDestroyedException if a texture bitmap was volatile, and the content was destroyed before the rendering could take place. */ @@ -382,7 +401,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a poly-polygon describing the outline of the stroked area. - @throws com::sun::star::lang::IllegalArgumentException + @throws com::sun::star::lang::IllegalArgumentException if one of the view and renderstate parameters are outside the specified range. */ @@ -408,7 +427,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws com::sun::star::lang::IllegalArgumentException + @throws com::sun::star::lang::IllegalArgumentException if one of the view and renderstate parameters are outside the specified range. */ @@ -438,11 +457,11 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws com::sun::star::lang::IllegalArgumentException + @throws com::sun::star::lang::IllegalArgumentException if one of the view and renderstate parameters are outside the specified range. - @throws VolatileContentDestroyedException + @throws VolatileContentDestroyedException if a texture bitmap was volatile, and the content was destroyed before the rendering could take place. */ @@ -478,11 +497,11 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws com::sun::star::lang::IllegalArgumentException + @throws com::sun::star::lang::IllegalArgumentException if one of the view and renderstate parameters are outside the specified range. - @throws VolatileContentDestroyedException + @throws VolatileContentDestroyedException if a texture bitmap was volatile, and the content was destroyed before the rendering could take place. */ @@ -530,7 +549,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @returns the requested font, or an invalid reference, if the request failed. - @throws com::sun::star::lang::IllegalArgumentException + @throws com::sun::star::lang::IllegalArgumentException if one of the parameters is not within the allowed range. */ XCanvasFont createFont( [in] FontRequest aFontRequest, [in] sequence< ::com::sun::star::beans::PropertyValue > aExtraFontProperties, [in] ::com::sun::star::geometry::Matrix2D aFontMatrix ) @@ -552,7 +571,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @returns the list of fonts matching the filter set. - @throws com::sun::star::lang::IllegalArgumentException + @throws com::sun::star::lang::IllegalArgumentException if one of the font properties are invalid or not recognized, or if one of the FontInfo members is not within the permitted range. @@ -592,7 +611,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws com::sun::star::lang::IllegalArgumentException + @throws com::sun::star::lang::IllegalArgumentException if one of the view and renderstate parameters are outside the specified range. */ @@ -624,7 +643,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws com::sun::star::lang::IllegalArgumentException + @throws com::sun::star::lang::IllegalArgumentException if one of the view and renderstate parameters are outside the specified range. */ @@ -653,11 +672,11 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws com::sun::star::lang::IllegalArgumentException + @throws com::sun::star::lang::IllegalArgumentException if one of the view and renderstate parameters are outside the specified range. - @throws VolatileContentDestroyedException + @throws VolatileContentDestroyedException if a texture bitmap was volatile, and the content was destroyed before the rendering could take place. */ @@ -692,11 +711,11 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws com::sun::star::lang::IllegalArgumentException + @throws com::sun::star::lang::IllegalArgumentException if one of the view and renderstate parameters are outside the specified range. - @throws VolatileContentDestroyedException + @throws VolatileContentDestroyedException if a texture bitmap was volatile, and the content was destroyed before the rendering could take place. */ @@ -720,6 +739,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface //============================================================================= +/// Service providing an XCanvas interface service Canvas: XCanvas; }; }; }; }; -- cgit v1.2.3