canvas/source/vcl/sprite.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: sprite.hxx,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_VCLCANVAS_SPRITE_HXX
  32 #define INCLUDED_VCLCANVAS_SPRITE_HXX
  33
  34 #include <canvas/base/sprite.hxx>
  35
  36 class OutputDevice;
  37
  38 namespace vclcanvas
  39 {
  40     /** Specialization of ::canvas::Sprite interface, to also provide
  41         redraw methods.
  42      */
  43     class Sprite : public ::canvas::Sprite
  44     {
  45     public:
  46
  47         /** Redraw sprite at the stored position.
  48
  49             @param bBufferedUpdate
  50             When true, the redraw does <em>not</em> happen directly on
  51             the front buffer, but within a VDev. Used to speed up
  52             drawing.
  53          */
  54         virtual void redraw( OutputDevice& rOutDev,
  55                              bool          bBufferedUpdate ) const = 0;
  56
  57         /** Redraw sprite at the given position.
  58
  59             @param rPos
  60             Output position of the sprite. Overrides the sprite's own
  61             output position.
  62
  63             @param bBufferedUpdate
  64             When true, the redraw does <em>not</em> happen directly on
  65             the front buffer, but within a VDev. Used to speed up
  66             drawing.
  67          */
  68         virtual void redraw( OutputDevice&              rOutDev,
  69                              const ::basegfx::B2DPoint& rPos,
  70                              bool                       bBufferedUpdate ) const = 0;
  71     };
  72 }
  73
  74 #endif /* INCLUDED_VCLCANVAS_SPRITE_HXX */