summaryrefslogtreecommitdiff
path: root/slideshow/source/inc/viewlayer.hxx
blob: 7e0b9053dd23eb23b1293db97ab860c852778c50 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: viewlayer.hxx,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: kz $ $Date: 2006-12-13 16:07:55 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef _SLIDESHOW_VIEWLAYER_HXX
#define _SLIDESHOW_VIEWLAYER_HXX

#include <cppcanvas/spritecanvas.hxx>

#include <basegfx/range/b2irectangle.hxx>

#include <boost/shared_ptr.hpp>

namespace basegfx { class B1DRange; class B2DRange; }


/* Definition of ViewLayer interface */

namespace slideshow
{
    namespace internal
    {
        class ViewLayer
        {
        public:
            virtual ~ViewLayer() {}

            /** Get the associated canvas of this layer.

                The canvas returned by this method must not change, as
                long as this object is alive.
            */
            virtual ::cppcanvas::CanvasSharedPtr getCanvas() const = 0;

            /** Create a sprite for this layer

                @param rSpriteSizePixel
                Sprite size in device pixel

                @return the sprite, or NULL on failure (or if this canvas
                does not support sprites)
            */
            virtual ::cppcanvas::CustomSpriteSharedPtr createSprite( const ::basegfx::B2DSize& rSpriteSizePixel ) const = 0;

            /** Compute a sprite priority relative to this layer.

                @param nSpritePrio
                Priority of the Sprite within this layer

                @return absolute sprite priority, to be set at a ::cppcanvas::Sprite
            */
            virtual double getSpritePriority( double nSpritePrio ) const = 0;

            /** Set the layer priority

                This method influences the relative priority of this
                layer, i.e. the z position in relation to other layers on
                the parent view. The higher the priority, the further in front
                the layer resides.

                @param nPrio
                Priority, must be in the range [0,1]
            */
            virtual void setPriority( double nPrio ) = 0;
        };

        typedef ::boost::shared_ptr< ViewLayer > ViewLayerSharedPtr;
    }
}

#endif /* _SLIDESHOW_VIEWLAYER_HXX */