canvas/source/null/null_canvascustomsprite.hxx

   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 _NULLCANVAS_CANVASCUSTOMSPRITE_HXX
  29 #define _NULLCANVAS_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 <basegfx/point/b2dpoint.hxx>
  41 #include <basegfx/vector/b2isize.hxx>
  42 #include <basegfx/matrix/b2dhommatrix.hxx>
  43
  44 #include <canvas/base/basemutexhelper.hxx>
  45 #include <canvas/base/canvascustomspritebase.hxx>
  46
  47 #include "sprite.hxx"
  48 #include "null_canvashelper.hxx"
  49 #include "null_spritehelper.hxx"
  50 #include "null_spritecanvas.hxx"
  51 #include "null_usagecounter.hxx"
  52
  53
  54 namespace nullcanvas
  55 {
  56     typedef ::cppu::WeakComponentImplHelper4< ::com::sun::star::rendering::XCustomSprite,
  57                                                ::com::sun::star::rendering::XBitmapCanvas,
  58                                               ::com::sun::star::rendering::XIntegerBitmap,
  59                                                 ::com::sun::star::lang::XServiceInfo >  CanvasCustomSpriteBase_Base;
  60     /** Mixin Sprite
  61
  62         Have to mixin the Sprite interface before deriving from
  63         ::canvas::CanvasCustomSpriteBase, as this template should
  64         already implement some of those interface methods.
  65
  66         The reason why this appears kinda convoluted is the fact that
  67         we cannot specify non-IDL types as WeakComponentImplHelperN
  68         template args, and furthermore, don't want to derive
  69         ::canvas::CanvasCustomSpriteBase directly from
  70         ::canvas::Sprite (because derivees of
  71         ::canvas::CanvasCustomSpriteBase have to explicitely forward
  72         the XInterface methods (e.g. via DECLARE_UNO3_AGG_DEFAULTS)
  73         anyway). Basically, ::canvas::CanvasCustomSpriteBase should
  74         remain a base class that provides implementation, not to
  75         enforce any specific interface on its derivees.
  76      */
  77     class CanvasCustomSpriteSpriteBase_Base : public ::canvas::BaseMutexHelper< CanvasCustomSpriteBase_Base >,
  78                                                  public Sprite
  79     {
  80     };
  81
  82     typedef ::canvas::CanvasCustomSpriteBase< CanvasCustomSpriteSpriteBase_Base,
  83                                               SpriteHelper,
  84                                               CanvasHelper,
  85                                               ::osl::MutexGuard,
  86                                               ::cppu::OWeakObject >                     CanvasCustomSpriteBaseT;
  87
  88     /* Definition of CanvasCustomSprite class */
  89
  90     class CanvasCustomSprite : public CanvasCustomSpriteBaseT,
  91                                private UsageCounter< CanvasCustomSprite >
  92     {
  93     public:
  94         /** Create a custom sprite
  95
  96             @param rSpriteSize
  97             Size of the sprite in pixel
  98
  99             @param rRefDevice
 100             Associated output device
 101
 102             @param rSpriteCanvas
 103             Target canvas
 104
 105             @param rDevice
 106             Target DX device
 107          */
 108         CanvasCustomSprite( const ::com::sun::star::geometry::RealSize2D&   rSpriteSize,
 109                             const SpriteCanvasRef&                          rRefDevice );
 110
 111         virtual void SAL_CALL disposing();
 112
 113         // Forwarding the XComponent implementation to the
 114         // cppu::ImplHelper templated base
 115         //                                    Classname           Base doing refcount          Base implementing the XComponent interface
 116         //                                          |                    |                         |
 117         //                                          V                    V                         V
 118         DECLARE_UNO3_XCOMPONENT_AGG_DEFAULTS( CanvasCustomSprite, CanvasCustomSpriteBase_Base, ::cppu::WeakComponentImplHelperBase );
 119
 120         // XServiceInfo
 121         virtual ::rtl::OUString SAL_CALL getImplementationName() throw( ::com::sun::star::uno::RuntimeException );
 122         virtual sal_Bool SAL_CALL supportsService( const ::rtl::OUString& ServiceName ) throw( ::com::sun::star::uno::RuntimeException );
 123         virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames()  throw( ::com::sun::star::uno::RuntimeException );
 124
 125         // Sprite
 126         virtual void redraw() const;
 127
 128     private:
 129         /** MUST hold here, too, since CanvasHelper only contains a
 130             raw pointer (without refcounting)
 131         */
 132         SpriteCanvasRef mpSpriteCanvas;
 133     };
 134 }
 135
 136 #endif /* _NULLCANVAS_CANVASCUSTOMSPRITE_HXX */