LibreOffice
LibreOffice 24.2 SDK API Reference
Loading...
Searching...
No Matches
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
20
21module com { module sun { module star { module geometry {
22 interface XMapping2D;
23}; }; }; };
24
25module com { module sun { module star { module rendering {
26
27interface XCanvasFont;
28interface XPolyPolygon2D;
29interface XCachedPrimitive;
30interface XBitmap;
31interface XGraphicDevice;
32interface XTextLayout;
33
96{
103 void clear();
104
120 void drawPoint( [in] ::com::sun::star::geometry::RealPoint2D aPoint, [in] ViewState aViewState, [in] RenderState aRenderState )
122
123
143 void drawLine( [in] ::com::sun::star::geometry::RealPoint2D aStartPoint, [in] ::com::sun::star::geometry::RealPoint2D aEndPoint, [in] ViewState aViewState, [in] RenderState aRenderState )
145
146
166 void drawBezier( [in] ::com::sun::star::geometry::RealBezierSegment2D aBezierSegment, [in] ::com::sun::star::geometry::RealPoint2D aEndPoint, [in] ViewState aViewState, [in] RenderState aRenderState )
168
169
188 XCachedPrimitive drawPolyPolygon( [in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState )
190
191
220 XCachedPrimitive strokePolyPolygon( [in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] StrokeAttributes aStrokeAttributes )
222
223
261 XCachedPrimitive strokeTexturedPolyPolygon( [in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] sequence<Texture> aTextures, [in] StrokeAttributes aStrokeAttributes )
264
265
308 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 )
311
312
313 // [TODO: Method misplaced at this interface?]
314
340 XPolyPolygon2D queryStrokeShapes( [in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] StrokeAttributes aStrokeAttributes )
342
343
365 XCachedPrimitive fillPolyPolygon( [in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState )
367
368
398 XCachedPrimitive fillTexturedPolyPolygon( [in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] sequence<Texture> xTextures )
401
402
437 XCachedPrimitive fillTextureMappedPolyPolygon( [in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] sequence<Texture> xTextures, [in] ::com::sun::star::geometry::XMapping2D xMapping )
440
441
464 XCanvasFont createFont( [in] FontRequest aFontRequest, [in] sequence< ::com::sun::star::beans::PropertyValue > aExtraFontProperties, [in] ::com::sun::star::geometry::Matrix2D aFontMatrix )
466
467
487 sequence< FontInfo > queryAvailableFonts( [in] FontInfo aFilter, [in] sequence< ::com::sun::star::beans::PropertyValue > aFontProperties )
489
490
525 XCachedPrimitive drawText( [in] StringContext aText, [in] XCanvasFont xFont, [in] ViewState aViewState, [in] RenderState aRenderState, [in] byte nTextDirection )
527
528
556 XCachedPrimitive drawTextLayout( [in] XTextLayout xLayoutetText, [in] ViewState aViewState, [in] RenderState aRenderState )
558
559
588 XCachedPrimitive drawBitmap( [in] XBitmap xBitmap, [in] ViewState aViewState, [in] RenderState aRenderState )
591
627 XCachedPrimitive drawBitmapModulated( [in] XBitmap xBitmap, [in] ViewState aViewState, [in] RenderState aRenderState )
630
631
642};
643
644}; }; }; };
645
646/* 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:27
This exception indicates an invalid volatile bitmap content.
Definition VolatileContentDestroyedException.idl:30
Interface defining an arbitrary bijective mapping from R^2 to R^2.
Definition XMapping2D.idl:37
This is a generic interface to a bitmap.
Definition XBitmap.idl:33
Interface for cached repaint of already drawn XCanvas primitives.
Definition XCachedPrimitive.idl:31
This interface provides access to a specific, XCanvas-dependent font incarnation.
Definition XCanvasFont.idl:32
Central interface for rendering.
Definition XCanvas.idl:96
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:47
Generic interface for poly-polygons in 2D.
Definition XPolyPolygon2D.idl:27
This is the central interface for text layouting.
Definition XTextLayout.idl:52
base interface of all UNO interfaces
Definition generated_idl_chapter_refs.idl:452
Definition Ambiguous.idl:20
This structure defines a 2 by 2 matrix.
Definition Matrix2D.idl:64
This structure contains the relevant data for a cubic Bezier curve.
Definition RealBezierSegment2D.idl:37
This structure defines a two-dimensional point.
Definition RealPoint2D.idl:30
This structure provides information about a specific font.
Definition FontInfo.idl:28
This structure contains all information necessary to describe a font to be queried from XCanvas.
Definition FontRequest.idl:36
This structure contains information passed to each XCanvas render operation.
Definition RenderState.idl:34
Collection of string-related arguments used on all canvas text interfaces.
Definition StringContext.idl:32
This structure contains all attributes required for path stroking.
Definition StrokeAttributes.idl:29
This structure contains information considered the view state.
Definition ViewState.idl:33