canvas/source/vcl/sprite.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_CANVAS_SOURCE_VCL_SPRITE_HXX
  21 #define INCLUDED_CANVAS_SOURCE_VCL_SPRITE_HXX
  22
  23 #include <canvas/base/sprite.hxx>
  24
  25 class OutputDevice;
  26
  27 namespace vclcanvas
  28 {
  29     /** Specialization of ::canvas::Sprite interface, to also provide
  30         redraw methods.
  31      */
  32     class Sprite : public ::canvas::Sprite
  33     {
  34     public:
  35
  36         /** Redraw sprite at the stored position.
  37
  38             @param bBufferedUpdate
  39             When true, the redraw does <em>not</em> happen directly on
  40             the front buffer, but within a VDev. Used to speed up
  41             drawing.
  42          */
  43         virtual void redraw( OutputDevice& rOutDev,
  44                              bool          bBufferedUpdate ) const = 0;
  45
  46         /** Redraw sprite at the given position.
  47
  48             @param rPos
  49             Output position of the sprite. Overrides the sprite's own
  50             output position.
  51
  52             @param bBufferedUpdate
  53             When true, the redraw does <em>not</em> happen directly on
  54             the front buffer, but within a VDev. Used to speed up
  55             drawing.
  56          */
  57         virtual void redraw( OutputDevice&              rOutDev,
  58                              const ::basegfx::B2DPoint& rPos,
  59                              bool                       bBufferedUpdate ) const = 0;
  60
  61     protected:
  62         ~Sprite() {}
  63     };
  64 }
  65
  66 #endif // INCLUDED_CANVAS_SOURCE_VCL_SPRITE_HXX
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */