LibreOffice
LibreOffice 7.2 SDK API Reference
XCanvas.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 #ifndef __com_sun_star_rendering_XCanvas_idl__
20 #define __com_sun_star_rendering_XCanvas_idl__
21 
37 
38 
39 module com { module sun { module star { module geometry {
40  interface XMapping2D;
41 }; }; }; };
42 
43 module com { module sun { module star { module rendering {
44 
45 interface XCanvasFont;
46 interface XPolyPolygon2D;
47 interface XCachedPrimitive;
48 interface XBitmap;
49 interface XGraphicDevice;
50 interface XTextLayout;
51 
114 {
121  void clear();
122 
138  void drawPoint( [in] ::com::sun::star::geometry::RealPoint2D aPoint, [in] ViewState aViewState, [in] RenderState aRenderState )
140 
141 
161  void drawLine( [in] ::com::sun::star::geometry::RealPoint2D aStartPoint, [in] ::com::sun::star::geometry::RealPoint2D aEndPoint, [in] ViewState aViewState, [in] RenderState aRenderState )
163 
164 
184  void drawBezier( [in] ::com::sun::star::geometry::RealBezierSegment2D aBezierSegment, [in] ::com::sun::star::geometry::RealPoint2D aEndPoint, [in] ViewState aViewState, [in] RenderState aRenderState )
186 
187 
206  XCachedPrimitive drawPolyPolygon( [in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState )
208 
209 
238  XCachedPrimitive strokePolyPolygon( [in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] StrokeAttributes aStrokeAttributes )
240 
241 
279  XCachedPrimitive strokeTexturedPolyPolygon( [in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] sequence<Texture> aTextures, [in] StrokeAttributes aStrokeAttributes )
282 
283 
326  XCachedPrimitive strokeTextureMappedPolyPolygon( [in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] sequence<Texture> aTextures, [in] ::com::sun::star::geometry::XMapping2D xMapping, [in] StrokeAttributes aStrokeAttributes )
329 
330 
331  // [TODO: Method misplaced at this interface?]
332 
358  XPolyPolygon2D queryStrokeShapes( [in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] StrokeAttributes aStrokeAttributes )
360 
361 
383  XCachedPrimitive fillPolyPolygon( [in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState )
385 
386 
416  XCachedPrimitive fillTexturedPolyPolygon( [in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] sequence<Texture> xTextures )
419 
420 
455  XCachedPrimitive fillTextureMappedPolyPolygon( [in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] sequence<Texture> xTextures, [in] ::com::sun::star::geometry::XMapping2D xMapping )
458 
459 
482  XCanvasFont createFont( [in] FontRequest aFontRequest, [in] sequence< ::com::sun::star::beans::PropertyValue > aExtraFontProperties, [in] ::com::sun::star::geometry::Matrix2D aFontMatrix )
484 
485 
505  sequence< FontInfo > queryAvailableFonts( [in] FontInfo aFilter, [in] sequence< ::com::sun::star::beans::PropertyValue > aFontProperties )
507 
508 
543  XCachedPrimitive drawText( [in] StringContext aText, [in] XCanvasFont xFont, [in] ViewState aViewState, [in] RenderState aRenderState, [in] byte nTextDirection )
545 
546 
574  XCachedPrimitive drawTextLayout( [in] XTextLayout xLayoutetText, [in] ViewState aViewState, [in] RenderState aRenderState )
576 
577 
606  XCachedPrimitive drawBitmap( [in] XBitmap xBitmap, [in] ViewState aViewState, [in] RenderState aRenderState )
609 
645  XCachedPrimitive drawBitmapModulated( [in] XBitmap xBitmap, [in] ViewState aViewState, [in] RenderState aRenderState )
648 
649 
660 };
661 
662 }; }; }; };
663 
664 #endif
665 
666 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
This exception indicates an invalid volatile bitmap content.
Definition: VolatileContentDestroyedException.idl:34
Interface defining an arbitrary bijective mapping from R^2 to R^2.
Definition: XMapping2D.idl:42
This is a generic interface to a bitmap.
Definition: XBitmap.idl:41
Interface for cached repaint of already drawn XCanvas primitives.
Definition: XCachedPrimitive.idl:37
This interface provides access to a specific, XCanvas-dependent font incarnation.
Definition: XCanvasFont.idl:44
Central interface for rendering.
Definition: XCanvas.idl:114
XCachedPrimitive drawBitmap([in] XBitmap xBitmap, [in] ViewState aViewState, [in] RenderState aRenderState)
Render the given bitmap.
XCachedPrimitive drawText([in] StringContext aText, [in] XCanvasFont xFont, [in] ViewState aViewState, [in] RenderState aRenderState, [in] byte nTextDirection)
Draw the text given by the substring of the specified string with the given font.
XCachedPrimitive drawBitmapModulated([in] XBitmap xBitmap, [in] ViewState aViewState, [in] RenderState aRenderState)
Render the given bitmap, with a global color modulation.
sequence< FontInfo > queryAvailableFonts([in] FontInfo aFilter, [in] sequence< ::com::sun::star::beans::PropertyValue > aFontProperties)
Query font information, specific to this canvas.
XCachedPrimitive strokePolyPolygon([in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] StrokeAttributes aStrokeAttributes)
Stroke each polygon of the provided poly-polygon with the specified stroke attributes.
XCachedPrimitive strokeTextureMappedPolyPolygon([in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] sequence< Texture > aTextures, [in] ::com::sun::star::geometry::XMapping2D xMapping, [in] StrokeAttributes aStrokeAttributes)
Stroke each polygon of the provided poly-polygon with the specified stroke attributes,...
XCachedPrimitive drawPolyPolygon([in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState)
Draw a poly-polygon in device resolution line width (i.e.
XCachedPrimitive drawTextLayout([in] XTextLayout xLayoutetText, [in] ViewState aViewState, [in] RenderState aRenderState)
Draw the formatted text given by the text layout.
XGraphicDevice getDevice()
Request the associated graphic device for this canvas.
XPolyPolygon2D queryStrokeShapes([in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] StrokeAttributes aStrokeAttributes)
Query the polygonal representation of the stroke outlines, as it would be generated by the strokePoly...
XCachedPrimitive fillPolyPolygon([in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState)
Fill the given poly-polygon.
XCanvasFont createFont([in] FontRequest aFontRequest, [in] sequence< ::com::sun::star::beans::PropertyValue > aExtraFontProperties, [in] ::com::sun::star::geometry::Matrix2D aFontMatrix)
Create a suitable font for the specified font description.
void clear()
Clear the whole canvas area.
XCachedPrimitive fillTextureMappedPolyPolygon([in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] sequence< Texture > xTextures, [in] ::com::sun::star::geometry::XMapping2D xMapping)
Fill the given poly-polygon with a mapped texture.
XCachedPrimitive fillTexturedPolyPolygon([in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] sequence< Texture > xTextures)
Fill the given poly-polygon with a texture.
void drawPoint([in] ::com::sun::star::geometry::RealPoint2D aPoint, [in] ViewState aViewState, [in] RenderState aRenderState)
Draw a point in device resolution on the device.
XCachedPrimitive strokeTexturedPolyPolygon([in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] sequence< Texture > aTextures, [in] StrokeAttributes aStrokeAttributes)
Stroke each polygon of the provided poly-polygon with the specified stroke attributes,...
void drawLine([in] ::com::sun::star::geometry::RealPoint2D aStartPoint, [in] ::com::sun::star::geometry::RealPoint2D aEndPoint, [in] ViewState aViewState, [in] RenderState aRenderState)
Draw a line in device resolution width (i.e.
void drawBezier([in] ::com::sun::star::geometry::RealBezierSegment2D aBezierSegment, [in] ::com::sun::star::geometry::RealPoint2D aEndPoint, [in] ViewState aViewState, [in] RenderState aRenderState)
Draw a cubic Bezier curve in device resolution width (i.e.
This interface provides access to a graphic device, such as a printer, or a screen device.
Definition: XGraphicDevice.idl:58
Generic interface for poly-polygons in 2D.
Definition: XPolyPolygon2D.idl:35
This is the central interface for text layouting.
Definition: XTextLayout.idl:66
base interface of all UNO interfaces
Definition: XInterface.idl:48
Definition: Ambiguous.idl:22
This structure defines a 2 by 2 matrix.
Definition: Matrix2D.idl:66
This structure contains the relevant data for a cubic Bezier curve.
Definition: RealBezierSegment2D.idl:39
This structure defines a two-dimensional point.
Definition: RealPoint2D.idl:32
This structure provides information about a specific font.
Definition: FontInfo.idl:33
This structure contains all information necessary to describe a font to be queried from XCanvas.
Definition: FontRequest.idl:41
This structure contains information passed to each XCanvas render operation.
Definition: RenderState.idl:39
Collection of string-related arguments used on all canvas text interfaces.
Definition: StringContext.idl:34
This structure contains all attributes required for path stroking.
Definition: StrokeAttributes.idl:31
This structure contains information considered the view state.
Definition: ViewState.idl:37