From ed5640d8b587fbcfed7dd7967f3de04b37a76f26 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 11:06:44 +0200 Subject: Adding upstream version 4:7.4.7. Signed-off-by: Daniel Baumann --- offapi/com/sun/star/rendering/XSimpleCanvas.idl | 246 ++++++++++++++++++++++++ 1 file changed, 246 insertions(+) create mode 100644 offapi/com/sun/star/rendering/XSimpleCanvas.idl (limited to 'offapi/com/sun/star/rendering/XSimpleCanvas.idl') diff --git a/offapi/com/sun/star/rendering/XSimpleCanvas.idl b/offapi/com/sun/star/rendering/XSimpleCanvas.idl new file mode 100644 index 000000000..0e81b7f8c --- /dev/null +++ b/offapi/com/sun/star/rendering/XSimpleCanvas.idl @@ -0,0 +1,246 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_rendering_XSimpleCanvas_idl__ +#define __com_sun_star_rendering_XSimpleCanvas_idl__ + +#include +#include +#include +#include +#include +#include +#include +#include + + +module com { module sun { module star { module rendering { + +interface XCanvas; +interface XCanvasFont; +interface XBitmap; +interface XGraphicDevice; +interface XPolyPolygon2D; + +/** Provides the basic graphical output operations for a canvas.

+ + This interface is a simplified version of the XCanvas + interface. It holds explicit state, i.e. the pen and fill color, + the current transformation, clip and font are persistently + remembered.

+ + In contrast to the XCanvas 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.

+ */ +interface XSimpleCanvas: com::sun::star::uno::XInterface +{ + /** Select a font.

+ + This method selects the specified font (or a close substitute) + as the current font for text output.

+ + @param sFontName + The name of the font (like e.g. Arial) + + @param size + 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). + + @param bold + When true, selected font is bold. + + @param italic + When true, selected font is italic + */ + void selectFont( [in] string sFontName, [in]double size, [in] boolean bold, [in] boolean italic ); + + + /** Sets the color used by line and text operations.

+ + To disable stroking, simply set this color to something with + zero alpha (i.e. fully transparent).

+ + @param nsRgbaColor + RGBA color tuple, interpreted in the sRGB color space. + */ + void setPenColor( [in] com::sun::star::util::Color nsRgbaColor ); + + + /** Sets the fill color.

+ + To disable filling, simply set this color to something with + zero alpha (i.e. fully transparent).

+ + @param nsRgbaColor + RGBA color tuple, interpreted in the sRGB color space. + */ + void setFillColor( [in] com::sun::star::util::Color nsRgbaColor ); + + + /** Sets the clip to the specified rectangle.

+ */ + void setRectClip( [in] ::com::sun::star::geometry::RealRectangle2D aRect ); + + + /** Set the current transform matrix.

+ */ + void setTransformation( [in] ::com::sun::star::geometry::AffineMatrix2D aTransform ); + + + /** Sets a single pixel on the canvas.

+ */ + void drawPixel( [in] ::com::sun::star::geometry::RealPoint2D aPoint ); + + + /** Draws a line on the canvas.

+ */ + void drawLine( [in] ::com::sun::star::geometry::RealPoint2D aStartPoint, + [in] ::com::sun::star::geometry::RealPoint2D aEndPoint ); + + + /** Draws a rectangle on the canvas.

+ */ + void drawRect( [in] ::com::sun::star::geometry::RealRectangle2D aRect ); + + + /** Draws a poly-polygon on the canvas.

+ */ + void drawPolyPolygon( [in] XPolyPolygon2D xPolyPolygon ); + + + /** Draws text on the canvas.

+ + @param aText + Text to render. The text color is the current pen color. + + @param aOutPos + Output position of the text. This is the left or right edge, + depending on nTextDirection. Output position is always + relative to the font baseline. + + @param nTextDirection + A value from the TextDirection 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. + */ + void drawText( [in] StringContext aText, + [in] ::com::sun::star::geometry::RealPoint2D aOutPos, + [in] byte nTextDirection ); + + + /** Draws the bitmap on the canvas.

+ + @param xBitmap + Bitmap to render + + @param aLeftTop + Left, top position of the bitmap on the destination canvas. + */ + void drawBitmap( [in] XBitmap xBitmap, + [in] ::com::sun::star::geometry::RealPoint2D aLeftTop ); + + + /** Request the associated graphic device for this canvas.

+ + 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.

+ + @return the associated XGraphicDevice. + */ + XGraphicDevice getDevice(); + + + /** Query the underlying XCanvas.

+ + @return the canvas interface this object is internally based + on. + */ + XCanvas getCanvas(); + + + /** Request the font metrics of the current font.

+ + @return the font metrics of the currently selected font. + */ + FontMetrics getFontMetrics(); + + + /** Retrieve currently selected font.

+ + @return the font instance that's currently used for rendering + text. + */ + XCanvasFont getCurrentFont(); + + + /** Retrieve color currently used for lines. + */ + com::sun::star::util::Color getCurrentPenColor(); + + + /** Retrieve color currently used for fills + */ + com::sun::star::util::Color getCurrentFillColor(); + + + /** Retrieve current clip rect + */ + com::sun::star::geometry::RealRectangle2D getCurrentClipRect(); + + + /** Retrieve current transformation matrix + */ + com::sun::star::geometry::AffineMatrix2D getCurrentTransformation(); + + + /** Retrieve view state.

+ + @return the view state, that would generate matching output, + when rendering to an XCanvas instead. + */ + ViewState getCurrentViewState(); + + + /** Retrieve render state.

+ + @param bUseFillColor + When true, the Color member of the RenderState is initialized + with the current fill color; when false, the current pen color + is used. + + @return the render state, that would generate matching output, + when rendering to an XCanvas instead. + */ + RenderState getCurrentRenderState( [in] boolean bUseFillColor ); + + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ -- cgit v1.2.3