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 <basegfx/vector/b2dsize.hxx>
  24 #include <cppcanvas/canvas.hxx>
  25 #include <cppcanvas/customsprite.hxx>
  26 #include <memory>
  27
  28 namespace com { namespace sun { namespace star { namespace rendering
  29 {
  30     class  XSpriteCanvas;
  31 } } } }
  32
  33
  34 /* Definition of SpriteCanvas */
  35
  36 namespace cppcanvas
  37 {
  38     class SpriteCanvas;
  39
  40     // forward declaration, since cloneSpriteCanvas() also references SpriteCanvas
  41     typedef std::shared_ptr< ::cppcanvas::SpriteCanvas > SpriteCanvasSharedPtr;
  42
  43     /** SpriteCanvas interface
  44      */
  45     class SpriteCanvas : public virtual Canvas
  46     {
  47         SpriteCanvas(const SpriteCanvas&) = delete;
  48         SpriteCanvas& operator=( const SpriteCanvas& ) = delete;
  49     public:
  50         SpriteCanvas() {}
  51         virtual bool                    updateScreen( bool bUpdateAll ) const = 0;
  52
  53         virtual CustomSpriteSharedPtr   createCustomSprite( const ::basegfx::B2DSize& ) const = 0;
  54
  55         virtual css::uno::Reference<
  56             css::rendering::XSpriteCanvas >    getUNOSpriteCanvas() const = 0;
  57     };
  58
  59 }
  60
  61 #endif // INCLUDED_CPPCANVAS_SPRITECANVAS_HXX
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */