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 _CAIROCANVAS_SPRITE_HXX
29 #define _CAIROCANVAS_SPRITE_HXX
30 
31 #include <canvas/base/sprite.hxx>
32 
33 #include "cairo_cairo.hxx"
34 
35 namespace cairocanvas
36 {
37     /** Specialization of ::canvas::Sprite interface, to also provide
38         redraw methods.
39      */
40     class Sprite : public ::canvas::Sprite
41     {
42     public:
43 
44         /** Redraw sprite at the stored position.
45 
46             @param bBufferedUpdate
47             When true, the redraw does <em>not</em> happen directly on
48             the front buffer, but within a VDev. Used to speed up
49             drawing.
50          */
51         virtual void redraw( const ::cairo::CairoSharedPtr& pCairo,
52                              bool                           bBufferedUpdate ) const = 0;
53 
54         /** Redraw sprite at the given position.
55 
56         	@param rPos
57             Output position of the sprite. Overrides the sprite's own
58             output position.
59 
60             @param bBufferedUpdate
61             When true, the redraw does <em>not</em> happen directly on
62             the front buffer, but within a VDev. Used to speed up
63             drawing.
64         */
65         virtual void redraw( const ::cairo::CairoSharedPtr& pCairo,
66                              const ::basegfx::B2DPoint&     rOrigOutputPos,
67                              bool                           bBufferedUpdate ) const = 0;
68     };
69 }
70 
71 #endif /* _CAIROCANVAS_SPRITE_HXX */
72