LibreOffice LibreOffice 25.8 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
20
21module com { module sun { module star { module geometry {
22 interface XMapping2D;
23}; }; }; };
24
25module com { module sun { module star { module rendering {
26
27 interface XCanvasFont;
28 interface XPolyPolygon2D;
29 interface XCachedPrimitive;
30 interface XBitmap;
31 interface XGraphicDevice;
32 interface XTextLayout;
33
95 interface XCanvas : ::com::sun::star::uno::XInterface
96{
103 void clear();
104
120 void drawPoint( [in] ::com::sun::star::geometry::RealPoint2D aPoint, [in] ViewState aViewState, [in] RenderState aRenderState )
121 raises (com::sun::star::lang::IllegalArgumentException);
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 )
144 raises (com::sun::star::lang::IllegalArgumentException);
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 )
167 raises (com::sun::star::lang::IllegalArgumentException);
168
169
188 XCachedPrimitive drawPolyPolygon( [in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState )
189 raises (com::sun::star::lang::IllegalArgumentException);
190
191
220 XCachedPrimitive strokePolyPolygon( [in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] StrokeAttributes aStrokeAttributes )
221 raises (com::sun::star::lang::IllegalArgumentException);
222
223
261 XCachedPrimitive strokeTexturedPolyPolygon( [in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] sequence<Texture> aTextures, [in] StrokeAttributes aStrokeAttributes )
262 raises (com::sun::star::lang::IllegalArgumentException,
263 VolatileContentDestroyedException);
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 )
309 raises (com::sun::star::lang::IllegalArgumentException,
310 VolatileContentDestroyedException);
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 )
341 raises (com::sun::star::lang::IllegalArgumentException);
342
343
365 XCachedPrimitive fillPolyPolygon( [in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState )
366 raises (com::sun::star::lang::IllegalArgumentException);
367
368
398 XCachedPrimitive fillTexturedPolyPolygon( [in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] sequence<Texture> xTextures )
399 raises (com::sun::star::lang::IllegalArgumentException,
400 VolatileContentDestroyedException);
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 )
438 raises (com::sun::star::lang::IllegalArgumentException,
439 VolatileContentDestroyedException);
440
441
464 XCanvasFont createFont( [in] FontRequest aFontRequest, [in] sequence< ::com::sun::star::beans::PropertyValue > aExtraFontProperties, [in] ::com::sun::star::geometry::Matrix2D aFontMatrix )
465 raises (com::sun::star::lang::IllegalArgumentException);
466
467
487 sequence< FontInfo > queryAvailableFonts( [in] FontInfo aFilter, [in] sequence< ::com::sun::star::beans::PropertyValue > aFontProperties )
488 raises (com::sun::star::lang::IllegalArgumentException);
489
490
525 XCachedPrimitive drawText( [in] StringContext aText, [in] XCanvasFont xFont, [in] ViewState aViewState, [in] RenderState aRenderState, [in] byte nTextDirection )
526 raises (com::sun::star::lang::IllegalArgumentException);
527
528
556 XCachedPrimitive drawTextLayout( [in] XTextLayout xLayoutetText, [in] ViewState aViewState, [in] RenderState aRenderState )
557 raises (com::sun::star::lang::IllegalArgumentException);
558
559
588 XCachedPrimitive drawBitmap( [in] XBitmap xBitmap, [in] ViewState aViewState, [in] RenderState aRenderState )
589 raises (com::sun::star::lang::IllegalArgumentException,
590 VolatileContentDestroyedException);
591
627 XCachedPrimitive drawBitmapModulated( [in] XBitmap xBitmap, [in] ViewState aViewState, [in] RenderState aRenderState )
628 raises (com::sun::star::lang::IllegalArgumentException,
629 VolatileContentDestroyedException);
630
631
641 XGraphicDevice getDevice();
642};
643
644}; }; }; };
645
646/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
com::sun::star::rendering::VolatileContentDestroyedException
This exception indicates an invalid volatile bitmap content.
Definition: VolatileContentDestroyedException.idl:30
com::sun::star::geometry::XMapping2D
Interface defining an arbitrary bijective mapping from R^2 to R^2.
Definition: XMapping2D.idl:37
com::sun::star::rendering::XBitmap
This is a generic interface to a bitmap.
Definition: XBitmap.idl:33
com::sun::star::rendering::XCachedPrimitive
Interface for cached repaint of already drawn XCanvas primitives.
Definition: XCachedPrimitive.idl:31
com::sun::star::rendering::XCanvasFont
This interface provides access to a specific, XCanvas-dependent font incarnation.
Definition: XCanvasFont.idl:32
com::sun::star::rendering::XCanvas
Central interface for rendering.
Definition: XCanvas.idl:96
com::sun::star::rendering::XCanvas::drawBitmap
XCachedPrimitive drawBitmap([in] XBitmap xBitmap, [in] ViewState aViewState, [in] RenderState aRenderState)
Render the given bitmap.
com::sun::star::rendering::XCanvas::drawText
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.
com::sun::star::rendering::XCanvas::drawBitmapModulated
XCachedPrimitive drawBitmapModulated([in] XBitmap xBitmap, [in] ViewState aViewState, [in] RenderState aRenderState)
Render the given bitmap, with a global color modulation.
com::sun::star::rendering::XCanvas::queryAvailableFonts
sequence< FontInfo > queryAvailableFonts([in] FontInfo aFilter, [in] sequence< ::com::sun::star::beans::PropertyValue > aFontProperties)
Query font information, specific to this canvas.
com::sun::star::rendering::XCanvas::strokePolyPolygon
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.
com::sun::star::rendering::XCanvas::strokeTextureMappedPolyPolygon
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,...
com::sun::star::rendering::XCanvas::drawPolyPolygon
XCachedPrimitive drawPolyPolygon([in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState)
Draw a poly-polygon in device resolution line width (i.e.
com::sun::star::rendering::XCanvas::drawTextLayout
XCachedPrimitive drawTextLayout([in] XTextLayout xLayoutetText, [in] ViewState aViewState, [in] RenderState aRenderState)
Draw the formatted text given by the text layout.
com::sun::star::rendering::XCanvas::getDevice
XGraphicDevice getDevice()
Request the associated graphic device for this canvas.
com::sun::star::rendering::XCanvas::queryStrokeShapes
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...
com::sun::star::rendering::XCanvas::fillPolyPolygon
XCachedPrimitive fillPolyPolygon([in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState)
Fill the given poly-polygon.
com::sun::star::rendering::XCanvas::createFont
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.
com::sun::star::rendering::XCanvas::clear
void clear()
Clear the whole canvas area.
com::sun::star::rendering::XCanvas::fillTextureMappedPolyPolygon
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.
com::sun::star::rendering::XCanvas::fillTexturedPolyPolygon
XCachedPrimitive fillTexturedPolyPolygon([in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] sequence< Texture > xTextures)
Fill the given poly-polygon with a texture.
com::sun::star::rendering::XCanvas::drawPoint
void drawPoint([in] ::com::sun::star::geometry::RealPoint2D aPoint, [in] ViewState aViewState, [in] RenderState aRenderState)
Draw a point in device resolution on the device.
com::sun::star::rendering::XCanvas::strokeTexturedPolyPolygon
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,...
com::sun::star::rendering::XCanvas::drawLine
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.
com::sun::star::rendering::XCanvas::drawBezier
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.
com::sun::star::rendering::XGraphicDevice
This interface provides access to a graphic device, such as a printer, or a screen device.
Definition: XGraphicDevice.idl:47
com::sun::star::rendering::XPolyPolygon2D
Generic interface for poly-polygons in 2D.
Definition: XPolyPolygon2D.idl:27
com::sun::star::rendering::XTextLayout
This is the central interface for text layouting.
Definition: XTextLayout.idl:52
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com
Definition: Ambiguous.idl:20
com::sun::star::geometry::Matrix2D
This structure defines a 2 by 2 matrix.
Definition: Matrix2D.idl:64
com::sun::star::geometry::RealBezierSegment2D
This structure contains the relevant data for a cubic Bezier curve.
Definition: RealBezierSegment2D.idl:37
com::sun::star::geometry::RealPoint2D
This structure defines a two-dimensional point.
Definition: RealPoint2D.idl:30
com::sun::star::rendering::FontInfo
This structure provides information about a specific font.
Definition: FontInfo.idl:28
com::sun::star::rendering::FontRequest
This structure contains all information necessary to describe a font to be queried from XCanvas.
Definition: FontRequest.idl:36
com::sun::star::rendering::RenderState
This structure contains information passed to each XCanvas render operation.
Definition: RenderState.idl:34
com::sun::star::rendering::StringContext
Collection of string-related arguments used on all canvas text interfaces.
Definition: StringContext.idl:32
com::sun::star::rendering::StrokeAttributes
This structure contains all attributes required for path stroking.
Definition: StrokeAttributes.idl:29
com::sun::star::rendering::ViewState
This structure contains information considered the view state.
Definition: ViewState.idl:33