1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
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 <com/sun/star/util/Color.idl>
#include <com/sun/star/geometry/RealPoint2D.idl>
#include <com/sun/star/geometry/RealRectangle2D.idl>
#include <com/sun/star/geometry/AffineMatrix2D.idl>
#include <com/sun/star/rendering/StringContext.idl>
#include <com/sun/star/rendering/ViewState.idl>
#include <com/sun/star/rendering/RenderState.idl>
#include <com/sun/star/rendering/FontMetrics.idl>
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.<p>
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.<p>
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.<p>
*/
interface XSimpleCanvas: com::sun::star::uno::XInterface
{
/** Select a font.<p>
This method selects the specified font (or a close substitute)
as the current font for text output.<p>
@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.<p>
To disable stroking, simply set this color to something with
zero alpha (i.e. fully transparent).<p>
@param nsRgbaColor
RGBA color tuple, interpreted in the sRGB color space.
*/
void setPenColor( [in] com::sun::star::util::Color nsRgbaColor );
/** Sets the fill color.<p>
To disable filling, simply set this color to something with
zero alpha (i.e. fully transparent).<p>
@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.<p>
*/
void setRectClip( [in] ::com::sun::star::geometry::RealRectangle2D aRect );
/** Set the current transform matrix.<p>
*/
void setTransformation( [in] ::com::sun::star::geometry::AffineMatrix2D aTransform );
/** Sets a single pixel on the canvas.<p>
*/
void drawPixel( [in] ::com::sun::star::geometry::RealPoint2D aPoint );
/** Draws a line on the canvas.<p>
*/
void drawLine( [in] ::com::sun::star::geometry::RealPoint2D aStartPoint,
[in] ::com::sun::star::geometry::RealPoint2D aEndPoint );
/** Draws a rectangle on the canvas.<p>
*/
void drawRect( [in] ::com::sun::star::geometry::RealRectangle2D aRect );
/** Draws a poly-polygon on the canvas.<p>
*/
void drawPolyPolygon( [in] XPolyPolygon2D xPolyPolygon );
/** Draws text on the canvas.<p>
@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.<p>
@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.<p>
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.<p>
@return the associated XGraphicDevice.
*/
XGraphicDevice getDevice();
/** Query the underlying XCanvas.<p>
@return the canvas interface this object is internally based
on.
*/
XCanvas getCanvas();
/** Request the font metrics of the current font.<p>
@return the font metrics of the currently selected font.
*/
FontMetrics getFontMetrics();
/** Retrieve currently selected font.<p>
@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.<p>
@return the view state, that would generate matching output,
when rendering to an XCanvas instead.
*/
ViewState getCurrentViewState();
/** Retrieve render state.<p>
@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: */
|
