1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef _VCLCANVAS_CANVASCUSTOMSPRITE_HXX
29 #define _VCLCANVAS_CANVASCUSTOMSPRITE_HXX
30 
31 #include <cppuhelper/compbase4.hxx>
32 #include <comphelper/uno3.hxx>
33 
34 #include <com/sun/star/lang/XServiceInfo.hpp>
35 #include <com/sun/star/lang/XComponent.hpp>
36 #include <com/sun/star/rendering/XCustomSprite.hpp>
37 #include <com/sun/star/rendering/XIntegerBitmap.hpp>
38 #include <com/sun/star/rendering/XPolyPolygon2D.hpp>
39 
40 #include <vcl/virdev.hxx>
41 
42 #include <canvas/vclwrapper.hxx>
43 #include <canvas/base/basemutexhelper.hxx>
44 #include <canvas/base/spritesurface.hxx>
45 #include <canvas/base/canvascustomspritebase.hxx>
46 
47 #include "sprite.hxx"
48 #include "canvashelper.hxx"
49 #include "spritehelper.hxx"
50 #include "backbuffer.hxx"
51 #include "impltools.hxx"
52 #include "spritecanvas.hxx"
53 #include "repainttarget.hxx"
54 
55 
56 namespace vclcanvas
57 {
58     typedef ::cppu::WeakComponentImplHelper4< ::com::sun::star::rendering::XCustomSprite,
59 									 		  ::com::sun::star::rendering::XBitmapCanvas,
60 											  ::com::sun::star::rendering::XIntegerBitmap,
61                          			 		  ::com::sun::star::lang::XServiceInfo >	CanvasCustomSpriteBase_Base;
62 	/** Mixin Sprite
63 
64     	Have to mixin the Sprite interface before deriving from
65     	::canvas::CanvasCustomSpriteBase, as this template should
66     	already implement some of those interface methods.
67 
68         The reason why this appears kinda convoluted is the fact that
69         we cannot specify non-IDL types as WeakComponentImplHelperN
70         template args, and furthermore, don't want to derive
71         ::canvas::CanvasCustomSpriteBase directly from
72         ::canvas::Sprite (because derivees of
73         ::canvas::CanvasCustomSpriteBase have to explicitely forward
74         the XInterface methods (e.g. via DECLARE_UNO3_AGG_DEFAULTS)
75         anyway). Basically, ::canvas::CanvasCustomSpriteBase should
76         remain a base class that provides implementation, not to
77         enforce any specific interface on its derivees.
78      */
79 	class CanvasCustomSpriteSpriteBase_Base : public ::canvas::BaseMutexHelper< CanvasCustomSpriteBase_Base >,
80     									   	  public Sprite
81     {
82     };
83 
84 	typedef ::canvas::CanvasCustomSpriteBase< CanvasCustomSpriteSpriteBase_Base,
85                                               SpriteHelper,
86                                               CanvasHelper,
87                                               tools::LocalGuard,
88                                               ::cppu::OWeakObject > 					CanvasCustomSpriteBaseT;
89 
90 	/* Definition of CanvasCustomSprite class */
91 
92     class CanvasCustomSprite : public CanvasCustomSpriteBaseT,
93                                public RepaintTarget
94     {
95     public:
96         CanvasCustomSprite( const ::com::sun::star::geometry::RealSize2D& rSpriteSize,
97                             ::com::sun::star::rendering::XGraphicDevice&  rDevice,
98                             const ::canvas::SpriteSurface::Reference&     rOwningSpriteCanvas,
99                             const OutDevProviderSharedPtr&                rOutDevProvider,
100                             bool                                          bShowSpriteBounds );
101 
102         virtual void SAL_CALL disposing();
103 
104 		// Forwarding the XComponent implementation to the
105         // cppu::ImplHelper templated base
106         //                                    Classname           Base doing refcount          Base implementing the XComponent interface
107         //                                          |                    |                         |
108         //                                          V                    V                         V
109         DECLARE_UNO3_XCOMPONENT_AGG_DEFAULTS( CanvasCustomSprite, CanvasCustomSpriteBase_Base, ::cppu::WeakComponentImplHelperBase );
110 
111         // XServiceInfo
112         virtual ::rtl::OUString SAL_CALL getImplementationName() throw( ::com::sun::star::uno::RuntimeException );
113         virtual sal_Bool SAL_CALL supportsService( const ::rtl::OUString& ServiceName ) throw( ::com::sun::star::uno::RuntimeException );
114         virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames()  throw( ::com::sun::star::uno::RuntimeException );
115 
116         // Sprite
117         virtual void redraw( OutputDevice& rOutDev,
118                              bool          bBufferedUpdate ) const;
119         virtual void redraw( OutputDevice&              rOutDev,
120                              const ::basegfx::B2DPoint& rPos,
121                              bool                       bBufferedUpdate ) const;
122 
123         // RepaintTarget
124         virtual bool repaint( const GraphicObjectSharedPtr&                   rGrf,
125                               const ::com::sun::star::rendering::ViewState&   viewState,
126                               const ::com::sun::star::rendering::RenderState& renderState,
127                               const ::Point&                                  rPt,
128                               const ::Size&                                   rSz,
129                               const GraphicAttr&                              rAttr ) const;
130     };
131 }
132 
133 #endif /* _VCLCANVAS_CANVASCUSTOMSPRITE_HXX */
134