xref: /trunk/main/canvas/source/vcl/canvashelper.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef _VCLCANVAS_CANVASHELPER_HXX_
29*cdf0e10cSrcweir #define _VCLCANVAS_CANVASHELPER_HXX_
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <com/sun/star/rendering/XCanvas.hpp>
32*cdf0e10cSrcweir #include <com/sun/star/rendering/XIntegerBitmap.hpp>
33*cdf0e10cSrcweir 
34*cdf0e10cSrcweir #include <vcl/outdev.hxx>
35*cdf0e10cSrcweir 
36*cdf0e10cSrcweir #include <canvas/vclwrapper.hxx>
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir #include "cachedbitmap.hxx"
39*cdf0e10cSrcweir #include "outdevprovider.hxx"
40*cdf0e10cSrcweir 
41*cdf0e10cSrcweir #include <boost/utility.hpp>
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir 
44*cdf0e10cSrcweir namespace vclcanvas
45*cdf0e10cSrcweir {
46*cdf0e10cSrcweir     class SpriteCanvas;
47*cdf0e10cSrcweir 
48*cdf0e10cSrcweir     /** Helper class for basic canvas functionality. Also offers
49*cdf0e10cSrcweir         optional backbuffer painting, when providing it with a second
50*cdf0e10cSrcweir         OutputDevice to render into.
51*cdf0e10cSrcweir      */
52*cdf0e10cSrcweir     class CanvasHelper : private ::boost::noncopyable
53*cdf0e10cSrcweir     {
54*cdf0e10cSrcweir     public:
55*cdf0e10cSrcweir         /** Create canvas helper
56*cdf0e10cSrcweir          */
57*cdf0e10cSrcweir         CanvasHelper();
58*cdf0e10cSrcweir 
59*cdf0e10cSrcweir         /// Release all references
60*cdf0e10cSrcweir         void disposing();
61*cdf0e10cSrcweir 
62*cdf0e10cSrcweir         /** Initialize canvas helper
63*cdf0e10cSrcweir 
64*cdf0e10cSrcweir             This method late-initializes the canvas helper, providing
65*cdf0e10cSrcweir             it with the necessary device and output objects. Note that
66*cdf0e10cSrcweir             the CanvasHelper does <em>not</em> take ownership of the
67*cdf0e10cSrcweir             passed rDevice reference, nor does it perform any
68*cdf0e10cSrcweir             reference counting. Thus, to prevent the reference counted
69*cdf0e10cSrcweir             SpriteCanvas object from deletion, the user of this class
70*cdf0e10cSrcweir             is responsible for holding ref-counted references itself!
71*cdf0e10cSrcweir 
72*cdf0e10cSrcweir             @param rDevice
73*cdf0e10cSrcweir             Reference device this canvas is associated with
74*cdf0e10cSrcweir 
75*cdf0e10cSrcweir             @param rOutDev
76*cdf0e10cSrcweir             Set primary output device for this canvas. That's where
77*cdf0e10cSrcweir             all content is output to.
78*cdf0e10cSrcweir 
79*cdf0e10cSrcweir             @param bProtect
80*cdf0e10cSrcweir             When true, all output operations preserve outdev
81*cdf0e10cSrcweir             state. When false, outdev state might change at any time.
82*cdf0e10cSrcweir 
83*cdf0e10cSrcweir             @param bHaveAlpha
84*cdf0e10cSrcweir             When true, hasAlpha() will always return true, otherwise, false.
85*cdf0e10cSrcweir          */
86*cdf0e10cSrcweir         void init( ::com::sun::star::rendering::XGraphicDevice& rDevice,
87*cdf0e10cSrcweir                    const OutDevProviderSharedPtr&               rOutDev,
88*cdf0e10cSrcweir                    bool                                         bProtect,
89*cdf0e10cSrcweir                    bool                                         bHaveAlpha );
90*cdf0e10cSrcweir 
91*cdf0e10cSrcweir         /** Set primary output device
92*cdf0e10cSrcweir 
93*cdf0e10cSrcweir             This changes the primary output device, where rendering is
94*cdf0e10cSrcweir             sent to.
95*cdf0e10cSrcweir          */
96*cdf0e10cSrcweir         void setOutDev( const OutDevProviderSharedPtr&  rOutDev,
97*cdf0e10cSrcweir                         bool                            bProtect);
98*cdf0e10cSrcweir 
99*cdf0e10cSrcweir         /** Set secondary output device
100*cdf0e10cSrcweir 
101*cdf0e10cSrcweir             Used for sprites, to generate mask bitmap.
102*cdf0e10cSrcweir          */
103*cdf0e10cSrcweir         void setBackgroundOutDev( const OutDevProviderSharedPtr& rOutDev );
104*cdf0e10cSrcweir 
105*cdf0e10cSrcweir 
106*cdf0e10cSrcweir         // CanvasHelper functionality
107*cdf0e10cSrcweir         // ==========================
108*cdf0e10cSrcweir 
109*cdf0e10cSrcweir         // XCanvas (only providing, not implementing the
110*cdf0e10cSrcweir         // interface. Also note subtle method parameter differences)
111*cdf0e10cSrcweir         void clear();
112*cdf0e10cSrcweir         void drawPoint( const ::com::sun::star::rendering::XCanvas*         rCanvas,
113*cdf0e10cSrcweir                         const ::com::sun::star::geometry::RealPoint2D&      aPoint,
114*cdf0e10cSrcweir                         const ::com::sun::star::rendering::ViewState&       viewState,
115*cdf0e10cSrcweir                         const ::com::sun::star::rendering::RenderState&     renderState );
116*cdf0e10cSrcweir         void drawLine( const ::com::sun::star::rendering::XCanvas*      rCanvas,
117*cdf0e10cSrcweir                        const ::com::sun::star::geometry::RealPoint2D&   aStartPoint,
118*cdf0e10cSrcweir                        const ::com::sun::star::geometry::RealPoint2D&   aEndPoint,
119*cdf0e10cSrcweir                        const ::com::sun::star::rendering::ViewState&    viewState,
120*cdf0e10cSrcweir                        const ::com::sun::star::rendering::RenderState&  renderState );
121*cdf0e10cSrcweir         void drawBezier( const ::com::sun::star::rendering::XCanvas*            rCanvas,
122*cdf0e10cSrcweir                          const ::com::sun::star::geometry::RealBezierSegment2D& aBezierSegment,
123*cdf0e10cSrcweir                          const ::com::sun::star::geometry::RealPoint2D&         aEndPoint,
124*cdf0e10cSrcweir                          const ::com::sun::star::rendering::ViewState&          viewState,
125*cdf0e10cSrcweir                          const ::com::sun::star::rendering::RenderState&        renderState );
126*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
127*cdf0e10cSrcweir             drawPolyPolygon( const ::com::sun::star::rendering::XCanvas*        rCanvas,
128*cdf0e10cSrcweir                              const ::com::sun::star::uno::Reference<
129*cdf0e10cSrcweir                                 ::com::sun::star::rendering::XPolyPolygon2D >&  xPolyPolygon,
130*cdf0e10cSrcweir                              const ::com::sun::star::rendering::ViewState&      viewState,
131*cdf0e10cSrcweir                              const ::com::sun::star::rendering::RenderState&    renderState );
132*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
133*cdf0e10cSrcweir             strokePolyPolygon( const ::com::sun::star::rendering::XCanvas*          rCanvas,
134*cdf0e10cSrcweir                                const ::com::sun::star::uno::Reference<
135*cdf0e10cSrcweir                                     ::com::sun::star::rendering::XPolyPolygon2D >&  xPolyPolygon,
136*cdf0e10cSrcweir                                const ::com::sun::star::rendering::ViewState&        viewState,
137*cdf0e10cSrcweir                                const ::com::sun::star::rendering::RenderState&      renderState,
138*cdf0e10cSrcweir                                const ::com::sun::star::rendering::StrokeAttributes& strokeAttributes );
139*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
140*cdf0e10cSrcweir             strokeTexturedPolyPolygon( const ::com::sun::star::rendering::XCanvas*          rCanvas,
141*cdf0e10cSrcweir                                        const ::com::sun::star::uno::Reference<
142*cdf0e10cSrcweir                                             ::com::sun::star::rendering::XPolyPolygon2D >&  xPolyPolygon,
143*cdf0e10cSrcweir                                        const ::com::sun::star::rendering::ViewState&        viewState,
144*cdf0e10cSrcweir                                        const ::com::sun::star::rendering::RenderState&      renderState,
145*cdf0e10cSrcweir                                        const ::com::sun::star::uno::Sequence<
146*cdf0e10cSrcweir                                             ::com::sun::star::rendering::Texture >&         textures,
147*cdf0e10cSrcweir                                        const ::com::sun::star::rendering::StrokeAttributes& strokeAttributes );
148*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
149*cdf0e10cSrcweir             strokeTextureMappedPolyPolygon( const ::com::sun::star::rendering::XCanvas*             rCanvas,
150*cdf0e10cSrcweir                                             const ::com::sun::star::uno::Reference<
151*cdf0e10cSrcweir                                                     ::com::sun::star::rendering::XPolyPolygon2D >&  xPolyPolygon,
152*cdf0e10cSrcweir                                             const ::com::sun::star::rendering::ViewState&           viewState,
153*cdf0e10cSrcweir                                             const ::com::sun::star::rendering::RenderState&         renderState,
154*cdf0e10cSrcweir                                             const ::com::sun::star::uno::Sequence<
155*cdf0e10cSrcweir                                                     ::com::sun::star::rendering::Texture >&         textures,
156*cdf0e10cSrcweir                                             const ::com::sun::star::uno::Reference<
157*cdf0e10cSrcweir                                                     ::com::sun::star::geometry::XMapping2D >&       xMapping,
158*cdf0e10cSrcweir                                             const ::com::sun::star::rendering::StrokeAttributes&    strokeAttributes );
159*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XPolyPolygon2D >
160*cdf0e10cSrcweir             queryStrokeShapes( const ::com::sun::star::rendering::XCanvas*          rCanvas,
161*cdf0e10cSrcweir                                const ::com::sun::star::uno::Reference<
162*cdf0e10cSrcweir                                     ::com::sun::star::rendering::XPolyPolygon2D >&  xPolyPolygon,
163*cdf0e10cSrcweir                                const ::com::sun::star::rendering::ViewState&        viewState,
164*cdf0e10cSrcweir                                const ::com::sun::star::rendering::RenderState&      renderState,
165*cdf0e10cSrcweir                                const ::com::sun::star::rendering::StrokeAttributes& strokeAttributes );
166*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
167*cdf0e10cSrcweir             fillPolyPolygon( const ::com::sun::star::rendering::XCanvas*            rCanvas,
168*cdf0e10cSrcweir                              const ::com::sun::star::uno::Reference<
169*cdf0e10cSrcweir                                     ::com::sun::star::rendering::XPolyPolygon2D >&  xPolyPolygon,
170*cdf0e10cSrcweir                              const ::com::sun::star::rendering::ViewState&          viewState,
171*cdf0e10cSrcweir                              const ::com::sun::star::rendering::RenderState&        renderState );
172*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
173*cdf0e10cSrcweir             fillTexturedPolyPolygon( const ::com::sun::star::rendering::XCanvas*            rCanvas,
174*cdf0e10cSrcweir                                      const ::com::sun::star::uno::Reference<
175*cdf0e10cSrcweir                                             ::com::sun::star::rendering::XPolyPolygon2D >&  xPolyPolygon,
176*cdf0e10cSrcweir                                      const ::com::sun::star::rendering::ViewState&          viewState,
177*cdf0e10cSrcweir                                      const ::com::sun::star::rendering::RenderState&        renderState,
178*cdf0e10cSrcweir                                      const ::com::sun::star::uno::Sequence<
179*cdf0e10cSrcweir                                             ::com::sun::star::rendering::Texture >&         textures );
180*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
181*cdf0e10cSrcweir             fillTextureMappedPolyPolygon( const ::com::sun::star::rendering::XCanvas*           rCanvas,
182*cdf0e10cSrcweir                                           const ::com::sun::star::uno::Reference<
183*cdf0e10cSrcweir                                                 ::com::sun::star::rendering::XPolyPolygon2D >&  xPolyPolygon,
184*cdf0e10cSrcweir                                           const ::com::sun::star::rendering::ViewState&         viewState,
185*cdf0e10cSrcweir                                           const ::com::sun::star::rendering::RenderState&       renderState,
186*cdf0e10cSrcweir                                           const ::com::sun::star::uno::Sequence<
187*cdf0e10cSrcweir                                                 ::com::sun::star::rendering::Texture >&         textures,
188*cdf0e10cSrcweir                                           const ::com::sun::star::uno::Reference<
189*cdf0e10cSrcweir                                                 ::com::sun::star::geometry::XMapping2D >&       xMapping );
190*cdf0e10cSrcweir 
191*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCanvasFont >
192*cdf0e10cSrcweir             createFont( const ::com::sun::star::rendering::XCanvas*         rCanvas,
193*cdf0e10cSrcweir                         const ::com::sun::star::rendering::FontRequest&     fontRequest,
194*cdf0e10cSrcweir                         const ::com::sun::star::uno::Sequence<
195*cdf0e10cSrcweir                             ::com::sun::star::beans::PropertyValue >&       extraFontProperties,
196*cdf0e10cSrcweir                         const ::com::sun::star::geometry::Matrix2D&         fontMatrix );
197*cdf0e10cSrcweir 
198*cdf0e10cSrcweir         ::com::sun::star::uno::Sequence< ::com::sun::star::rendering::FontInfo >
199*cdf0e10cSrcweir             queryAvailableFonts( const ::com::sun::star::rendering::XCanvas*        rCanvas,
200*cdf0e10cSrcweir                                  const ::com::sun::star::rendering::FontInfo&       aFilter,
201*cdf0e10cSrcweir                                  const ::com::sun::star::uno::Sequence<
202*cdf0e10cSrcweir                                         ::com::sun::star::beans::PropertyValue >&   aFontProperties );
203*cdf0e10cSrcweir 
204*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
205*cdf0e10cSrcweir             drawText( const ::com::sun::star::rendering::XCanvas*       rCanvas,
206*cdf0e10cSrcweir                       const ::com::sun::star::rendering::StringContext& text,
207*cdf0e10cSrcweir                       const ::com::sun::star::uno::Reference<
208*cdf0e10cSrcweir                             ::com::sun::star::rendering::XCanvasFont >& xFont,
209*cdf0e10cSrcweir                       const ::com::sun::star::rendering::ViewState&     viewState,
210*cdf0e10cSrcweir                       const ::com::sun::star::rendering::RenderState&   renderState,
211*cdf0e10cSrcweir                       sal_Int8                                          textDirection );
212*cdf0e10cSrcweir 
213*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
214*cdf0e10cSrcweir             drawTextLayout( const ::com::sun::star::rendering::XCanvas*         rCanvas,
215*cdf0e10cSrcweir                             const ::com::sun::star::uno::Reference<
216*cdf0e10cSrcweir                                     ::com::sun::star::rendering::XTextLayout >& layoutetText,
217*cdf0e10cSrcweir                             const ::com::sun::star::rendering::ViewState&       viewState,
218*cdf0e10cSrcweir                             const ::com::sun::star::rendering::RenderState&     renderState );
219*cdf0e10cSrcweir 
220*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
221*cdf0e10cSrcweir             drawBitmap( const ::com::sun::star::rendering::XCanvas*     rCanvas,
222*cdf0e10cSrcweir                         const ::com::sun::star::uno::Reference<
223*cdf0e10cSrcweir                                 ::com::sun::star::rendering::XBitmap >& xBitmap,
224*cdf0e10cSrcweir                         const ::com::sun::star::rendering::ViewState&   viewState,
225*cdf0e10cSrcweir                         const ::com::sun::star::rendering::RenderState& renderState );
226*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
227*cdf0e10cSrcweir             drawBitmapModulated( const ::com::sun::star::rendering::XCanvas*        rCanvas,
228*cdf0e10cSrcweir                                  const ::com::sun::star::uno::Reference<
229*cdf0e10cSrcweir                                         ::com::sun::star::rendering::XBitmap >&     xBitmap,
230*cdf0e10cSrcweir                                  const ::com::sun::star::rendering::ViewState&      viewState,
231*cdf0e10cSrcweir                                  const ::com::sun::star::rendering::RenderState&    renderState );
232*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XGraphicDevice >
233*cdf0e10cSrcweir             getDevice();
234*cdf0e10cSrcweir 
235*cdf0e10cSrcweir         // BitmapCanvasHelper functionality
236*cdf0e10cSrcweir         // ================================
237*cdf0e10cSrcweir 
238*cdf0e10cSrcweir         void copyRect( const ::com::sun::star::rendering::XCanvas*          rCanvas,
239*cdf0e10cSrcweir                        const ::com::sun::star::uno::Reference<
240*cdf0e10cSrcweir                             ::com::sun::star::rendering::XBitmapCanvas >&   sourceCanvas,
241*cdf0e10cSrcweir                        const ::com::sun::star::geometry::RealRectangle2D&   sourceRect,
242*cdf0e10cSrcweir                        const ::com::sun::star::rendering::ViewState&        sourceViewState,
243*cdf0e10cSrcweir                        const ::com::sun::star::rendering::RenderState&      sourceRenderState,
244*cdf0e10cSrcweir                        const ::com::sun::star::geometry::RealRectangle2D&   destRect,
245*cdf0e10cSrcweir                        const ::com::sun::star::rendering::ViewState&        destViewState,
246*cdf0e10cSrcweir                        const ::com::sun::star::rendering::RenderState&      destRenderState );
247*cdf0e10cSrcweir 
248*cdf0e10cSrcweir         ::com::sun::star::geometry::IntegerSize2D getSize();
249*cdf0e10cSrcweir 
250*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XBitmapCanvas > queryBitmapCanvas();
251*cdf0e10cSrcweir 
252*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XBitmap >
253*cdf0e10cSrcweir             getScaledBitmap( const ::com::sun::star::geometry::RealSize2D&  newSize,
254*cdf0e10cSrcweir                              sal_Bool                                               beFast );
255*cdf0e10cSrcweir 
256*cdf0e10cSrcweir         ::com::sun::star::uno::Sequence< sal_Int8 >
257*cdf0e10cSrcweir             getData( ::com::sun::star::rendering::IntegerBitmapLayout&      bitmapLayout,
258*cdf0e10cSrcweir                      const ::com::sun::star::geometry::IntegerRectangle2D&  rect );
259*cdf0e10cSrcweir 
260*cdf0e10cSrcweir         void setData( const ::com::sun::star::uno::Sequence< sal_Int8 >&        data,
261*cdf0e10cSrcweir                       const ::com::sun::star::rendering::IntegerBitmapLayout&   bitmapLayout,
262*cdf0e10cSrcweir                       const ::com::sun::star::geometry::IntegerRectangle2D&     rect );
263*cdf0e10cSrcweir 
264*cdf0e10cSrcweir         void setPixel( const ::com::sun::star::uno::Sequence< sal_Int8 >&       color,
265*cdf0e10cSrcweir                        const ::com::sun::star::rendering::IntegerBitmapLayout&  bitmapLayout,
266*cdf0e10cSrcweir                        const ::com::sun::star::geometry::IntegerPoint2D&        pos );
267*cdf0e10cSrcweir 
268*cdf0e10cSrcweir         ::com::sun::star::uno::Sequence< sal_Int8 >
269*cdf0e10cSrcweir             getPixel( ::com::sun::star::rendering::IntegerBitmapLayout& bitmapLayout,
270*cdf0e10cSrcweir                       const ::com::sun::star::geometry::IntegerPoint2D& pos );
271*cdf0e10cSrcweir 
272*cdf0e10cSrcweir         ::com::sun::star::rendering::IntegerBitmapLayout getMemoryLayout();
273*cdf0e10cSrcweir 
274*cdf0e10cSrcweir         /// Repaint a cached bitmap
275*cdf0e10cSrcweir         bool repaint( const GraphicObjectSharedPtr&                   rGrf,
276*cdf0e10cSrcweir                       const ::com::sun::star::rendering::ViewState&   viewState,
277*cdf0e10cSrcweir                       const ::com::sun::star::rendering::RenderState& renderState,
278*cdf0e10cSrcweir                       const ::Point&                                  rPt,
279*cdf0e10cSrcweir                       const ::Size&                                   rSz,
280*cdf0e10cSrcweir                       const GraphicAttr&                              rAttr ) const;
281*cdf0e10cSrcweir 
282*cdf0e10cSrcweir         /** Flush drawing queue.
283*cdf0e10cSrcweir 
284*cdf0e10cSrcweir             This only works for Window canvases, and ensures that all
285*cdf0e10cSrcweir             pending render operations are flushed to the
286*cdf0e10cSrcweir             driver/hardware.
287*cdf0e10cSrcweir          */
288*cdf0e10cSrcweir         void flush() const;
289*cdf0e10cSrcweir 
290*cdf0e10cSrcweir         enum ColorType
291*cdf0e10cSrcweir         {
292*cdf0e10cSrcweir             LINE_COLOR, FILL_COLOR, TEXT_COLOR, IGNORE_COLOR
293*cdf0e10cSrcweir         };
294*cdf0e10cSrcweir 
295*cdf0e10cSrcweir         // returns transparency of color
296*cdf0e10cSrcweir         int setupOutDevState( const ::com::sun::star::rendering::ViewState&     viewState,
297*cdf0e10cSrcweir                               const ::com::sun::star::rendering::RenderState&   renderState,
298*cdf0e10cSrcweir                               ColorType                                         eColorType ) const;
299*cdf0e10cSrcweir 
300*cdf0e10cSrcweir         /** Called from XCanvas base classes, to notify that content
301*cdf0e10cSrcweir             is _about_ to change
302*cdf0e10cSrcweir         */
303*cdf0e10cSrcweir         void modifying() {}
304*cdf0e10cSrcweir 
305*cdf0e10cSrcweir         bool hasAlpha() const { return mbHaveAlpha; }
306*cdf0e10cSrcweir 
307*cdf0e10cSrcweir     protected:
308*cdf0e10cSrcweir         /** Phyical output device
309*cdf0e10cSrcweir 
310*cdf0e10cSrcweir             Deliberately not a refcounted reference, because of
311*cdf0e10cSrcweir             potential circular references for spritecanvas.
312*cdf0e10cSrcweir          */
313*cdf0e10cSrcweir         ::com::sun::star::rendering::XGraphicDevice* mpDevice;
314*cdf0e10cSrcweir 
315*cdf0e10cSrcweir         /// Rendering to this outdev preserves its state
316*cdf0e10cSrcweir         OutDevProviderSharedPtr                      mpProtectedOutDev;
317*cdf0e10cSrcweir 
318*cdf0e10cSrcweir         /// Rendering to this outdev does not preserve its state
319*cdf0e10cSrcweir         OutDevProviderSharedPtr                      mpOutDev;
320*cdf0e10cSrcweir 
321*cdf0e10cSrcweir         /// Rendering to this outdev does not preserve its state
322*cdf0e10cSrcweir         OutDevProviderSharedPtr                      mp2ndOutDev;
323*cdf0e10cSrcweir 
324*cdf0e10cSrcweir         /// When true, content is able to represent alpha
325*cdf0e10cSrcweir         bool                                         mbHaveAlpha;
326*cdf0e10cSrcweir 
327*cdf0e10cSrcweir     private:
328*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
329*cdf0e10cSrcweir             implDrawBitmap( const ::com::sun::star::rendering::XCanvas*     rCanvas,
330*cdf0e10cSrcweir                             const ::com::sun::star::uno::Reference<
331*cdf0e10cSrcweir                                   ::com::sun::star::rendering::XBitmap >&   xBitmap,
332*cdf0e10cSrcweir                             const ::com::sun::star::rendering::ViewState&   viewState,
333*cdf0e10cSrcweir                             const ::com::sun::star::rendering::RenderState& renderState,
334*cdf0e10cSrcweir                             bool                                            bModulateColors );
335*cdf0e10cSrcweir 
336*cdf0e10cSrcweir         bool setupTextOutput( ::Point&                                                                              o_rOutPos,
337*cdf0e10cSrcweir                               const ::com::sun::star::rendering::ViewState&                                         viewState,
338*cdf0e10cSrcweir                               const ::com::sun::star::rendering::RenderState&                                       renderState,
339*cdf0e10cSrcweir                               const ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCanvasFont >&   xFont ) const;
340*cdf0e10cSrcweir 
341*cdf0e10cSrcweir     };
342*cdf0e10cSrcweir }
343*cdf0e10cSrcweir 
344*cdf0e10cSrcweir #endif /* _VCLCANVAS_CANVASHELPER_HXX_ */
345