canvas/source/cairo/cairo_spritesurface.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: cairo_spritesurface.hxx,v $
  10  * $Revision: 1.5 $
  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 _VCLCANVAS_SPRITESURFACE_HXX
  32 #define _VCLCANVAS_SPRITESURFACE_HXX
  33
  34 #include <sal/config.h>
  35
  36 #include "cairo_sprite.hxx"
  37
  38 class Point;
  39 class Size;
  40 class Rectangle;
  41
  42 namespace cairocanvas
  43 {
  44     /* Definition of SpriteSurface interface */
  45
  46     class SpriteSurface
  47     {
  48     public:
  49         virtual ~SpriteSurface() {}
  50
  51         // call this when XSprite::show() is called
  52         virtual void showSprite( const Sprite::ImplRef& sprite ) = 0;
  53
  54         // call this when XSprite::hide() is called
  55         virtual void hideSprite( const Sprite::ImplRef& sprite ) = 0;
  56
  57         // call this when XSprite::move() is called
  58         virtual void moveSprite( const Sprite::ImplRef& sprite,
  59                                  const Point&                   rOldPos,
  60                                  const Point&                   rNewPos,
  61                                  const Size&                    rSpriteSize ) = 0;
  62
  63         // call this when some part of your sprite has changed. That
  64         // includes show/hide´, i.e. for show, both showSprite and
  65         // updateSprite must be called.
  66         virtual void updateSprite( const Sprite::ImplRef&       sprite,
  67                                    const Point&                         rPos,
  68                                    const Rectangle&             rUpdateArea ) = 0;
  69
  70     };
  71 }
  72
  73 #endif /* _VCLCANVAS_SPRITESURFACE_HXX */