include/cppcanvas/spritecanvas.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_CPPCANVAS_SPRITECANVAS_HXX
  21 #define INCLUDED_CPPCANVAS_SPRITECANVAS_HXX
  22
  23 #include <sal/types.h>
  24 #include <osl/diagnose.h>
  25 #include <basegfx/vector/b2dsize.hxx>
  26
  27 #include <boost/noncopyable.hpp>
  28 #include <boost/shared_ptr.hpp>
  29
  30
  31 #include <cppcanvas/canvas.hxx>
  32 #include <cppcanvas/sprite.hxx>
  33 #include <cppcanvas/customsprite.hxx>
  34
  35 namespace com { namespace sun { namespace star { namespace rendering
  36 {
  37     class  XSpriteCanvas;
  38 } } } }
  39
  40
  41 /* Definition of SpriteCanvas */
  42
  43 namespace cppcanvas
  44 {
  45     class SpriteCanvas;
  46
  47     // forward declaration, since cloneSpriteCanvas() also references SpriteCanvas
  48     typedef ::boost::shared_ptr< ::cppcanvas::SpriteCanvas > SpriteCanvasSharedPtr;
  49
  50     /** SpriteCanvas interface
  51      */
  52     class SpriteCanvas : public virtual Canvas, private boost::noncopyable
  53     {
  54     public:
  55         virtual bool                    updateScreen( bool bUpdateAll ) const = 0;
  56
  57         virtual CustomSpriteSharedPtr   createCustomSprite( const ::basegfx::B2DSize& ) const = 0;
  58         virtual SpriteSharedPtr         createClonedSprite( const SpriteSharedPtr& ) const = 0;
  59
  60         // shared_ptr does not allow for covariant return types
  61         SpriteCanvasSharedPtr           cloneSpriteCanvas() const
  62         {
  63             SpriteCanvasSharedPtr p( ::boost::dynamic_pointer_cast< SpriteCanvas >(this->clone()) );
  64             OSL_ENSURE(p.get(), "SpriteCanvas::cloneSpriteCanvas(): dynamic cast failed");
  65             return p;
  66         }
  67
  68         virtual ::com::sun::star::uno::Reference<
  69             ::com::sun::star::rendering::XSpriteCanvas >    getUNOSpriteCanvas() const = 0;
  70     };
  71
  72 }
  73
  74 #endif // INCLUDED_CPPCANVAS_SPRITECANVAS_HXX
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */