LibreOffice Module canvas (master)  1
Public Types | Public Member Functions | Protected Member Functions | List of all members
canvas::SpriteSurface Class Referenceabstract

Canvas surface containing sprites. More...

#include <spritesurface.hxx>

Inheritance diagram for canvas::SpriteSurface:
[legend]
Collaboration diagram for canvas::SpriteSurface:
[legend]

Public Types

typedef ::rtl::Reference< SpriteSurfaceReference
 

Public Member Functions

virtual void showSprite (const Sprite::Reference &rSprite)=0
 Sprites should call this from XSprite::show() More...
 
virtual void hideSprite (const Sprite::Reference &rSprite)=0
 Sprites should call this from XSprite::hide() More...
 
virtual void moveSprite (const Sprite::Reference &rSprite, const ::basegfx::B2DPoint &rOldPos, const ::basegfx::B2DPoint &rNewPos, const ::basegfx::B2DVector &rSpriteSize)=0
 Sprites should call this from XSprite::move() More...
 
virtual void updateSprite (const Sprite::Reference &rSprite, const ::basegfx::B2DPoint &rPos, const ::basegfx::B2DRange &rUpdateArea)=0
 Sprites should call this when some part of the content has changed. More...
 

Protected Member Functions

 ~SpriteSurface ()
 

Detailed Description

Canvas surface containing sprites.

Every canvas surface that contains sprites must implement this interface, when employing the canvas base framework. The methods provided here are used from the individual sprites to notify the canvas about necessary screen updates.

Definition at line 36 of file spritesurface.hxx.

Member Typedef Documentation

Definition at line 39 of file spritesurface.hxx.

Constructor & Destructor Documentation

canvas::SpriteSurface::~SpriteSurface ( )
inlineprotected

Definition at line 64 of file spritesurface.hxx.

Member Function Documentation

virtual void canvas::SpriteSurface::hideSprite ( const Sprite::Reference rSprite)
pure virtual

Sprites should call this from XSprite::hide()

virtual void canvas::SpriteSurface::moveSprite ( const Sprite::Reference rSprite,
const ::basegfx::B2DPoint rOldPos,
const ::basegfx::B2DPoint rNewPos,
const ::basegfx::B2DVector rSpriteSize 
)
pure virtual

Sprites should call this from XSprite::move()

virtual void canvas::SpriteSurface::showSprite ( const Sprite::Reference rSprite)
pure virtual

Sprites should call this from XSprite::show()

virtual void canvas::SpriteSurface::updateSprite ( const Sprite::Reference rSprite,
const ::basegfx::B2DPoint rPos,
const ::basegfx::B2DRange rUpdateArea 
)
pure virtual

Sprites should call this when some part of the content has changed.

That includes show/hide, i.e. for show, both showSprite() and updateSprite() must be called.


The documentation for this class was generated from the following file: