canvas/source/cairo/cairo_spritesurface.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef _VCLCANVAS_SPRITESURFACE_HXX
  29 #define _VCLCANVAS_SPRITESURFACE_HXX
  30
  31 #include <sal/config.h>
  32
  33 #include "cairo_sprite.hxx"
  34
  35 class Point;
  36 class Size;
  37 class Rectangle;
  38
  39 namespace cairocanvas
  40 {
  41     /* Definition of SpriteSurface interface */
  42
  43     class SpriteSurface
  44     {
  45     public:
  46         virtual ~SpriteSurface() {}
  47
  48         // call this when XSprite::show() is called
  49         virtual void showSprite( const Sprite::ImplRef& sprite ) = 0;
  50
  51         // call this when XSprite::hide() is called
  52         virtual void hideSprite( const Sprite::ImplRef& sprite ) = 0;
  53
  54         // call this when XSprite::move() is called
  55         virtual void moveSprite( const Sprite::ImplRef& sprite,
  56                                  const Point&           rOldPos,
  57                                  const Point&           rNewPos,
  58                                  const Size&            rSpriteSize ) = 0;
  59
  60         // call this when some part of your sprite has changed. That
  61         // includes show/hide´, i.e. for show, both showSprite and
  62         // updateSprite must be called.
  63         virtual void updateSprite( const Sprite::ImplRef&   sprite,
  64                                    const Point&             rPos,
  65                                    const Rectangle&         rUpdateArea ) = 0;
  66
  67     };
  68 }
  69
  70 #endif /* _VCLCANVAS_SPRITESURFACE_HXX */