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_CANVAS_SPRITESURFACE_HXX
      30                 :            : #define INCLUDED_CANVAS_SPRITESURFACE_HXX
      31                 :            : 
      32                 :            : #include <canvas/base/sprite.hxx>
      33                 :            : 
      34                 :            : namespace canvas
      35                 :            : {
      36                 :            :     /* Definition of the SpriteSurface interface */
      37                 :            : 
      38                 :            :     /** Canvas surface containing sprites
      39                 :            : 
      40                 :            :         Every canvas surface that contains sprites must implement this
      41                 :            :         interface, when employing the canvas base framework. The
      42                 :            :         methods provided here are used from the individual sprites to
      43                 :            :         notify the canvas about necessary screen updates.
      44                 :            :      */
      45                 :          0 :     class SpriteSurface : public ::com::sun::star::uno::XInterface
      46                 :            :     {
      47                 :            :     public:
      48                 :            :         typedef ::rtl::Reference< SpriteSurface > Reference;
      49                 :            : 
      50                 :            :         /// Sprites should call this from XSprite::show()
      51                 :            :         virtual void showSprite( const Sprite::Reference& rSprite ) = 0;
      52                 :            : 
      53                 :            :         /// Sprites should call this from XSprite::hide()
      54                 :            :         virtual void hideSprite( const Sprite::Reference& rSprite ) = 0;
      55                 :            : 
      56                 :            :         /// Sprites should call this from XSprite::move()
      57                 :            :         virtual void moveSprite( const Sprite::Reference&       rSprite,
      58                 :            :                                  const ::basegfx::B2DPoint&     rOldPos,
      59                 :            :                                  const ::basegfx::B2DPoint&     rNewPos,
      60                 :            :                                  const ::basegfx::B2DVector&    rSpriteSize ) = 0;
      61                 :            : 
      62                 :            :         /** Sprites should call this when some part of the content has
      63                 :            :             changed.
      64                 :            : 
      65                 :            :             That includes show/hide, i.e. for show, both showSprite()
      66                 :            :             and updateSprite() must be called.
      67                 :            :         */
      68                 :            :         virtual void updateSprite( const Sprite::Reference&     rSprite,
      69                 :            :                                    const ::basegfx::B2DPoint&   rPos,
      70                 :            :                                    const ::basegfx::B2DRange&   rUpdateArea ) = 0;
      71                 :            : 
      72                 :            :     protected:
      73                 :          0 :         ~SpriteSurface() {}
      74                 :            :     };
      75                 :            : }
      76                 :            : 
      77                 :            : #endif /* INCLUDED_CANVAS_SPRITESURFACE_HXX */
      78                 :            : 
      79                 :            : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */