Branch data     Line data    Source code

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