xref: /aoo4110/main/slideshow/source/inc/view.hxx (revision b1cdbd2c)
1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski 
24*b1cdbd2cSJim Jagielski #ifndef INCLUDED_SLIDESHOW_VIEW_HXX
25*b1cdbd2cSJim Jagielski #define INCLUDED_SLIDESHOW_VIEW_HXX
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski #include "viewlayer.hxx"
28*b1cdbd2cSJim Jagielski 
29*b1cdbd2cSJim Jagielski #include <boost/shared_ptr.hpp>
30*b1cdbd2cSJim Jagielski #include <vector>
31*b1cdbd2cSJim Jagielski 
32*b1cdbd2cSJim Jagielski 
33*b1cdbd2cSJim Jagielski namespace basegfx { class B2DRange; class B2DVector; }
34*b1cdbd2cSJim Jagielski 
35*b1cdbd2cSJim Jagielski 
36*b1cdbd2cSJim Jagielski /* Definition of View interface */
37*b1cdbd2cSJim Jagielski 
38*b1cdbd2cSJim Jagielski namespace slideshow
39*b1cdbd2cSJim Jagielski {
40*b1cdbd2cSJim Jagielski     namespace internal
41*b1cdbd2cSJim Jagielski     {
42*b1cdbd2cSJim Jagielski         class View : public ViewLayer
43*b1cdbd2cSJim Jagielski         {
44*b1cdbd2cSJim Jagielski         public:
45*b1cdbd2cSJim Jagielski             /** Create a new view layer for this view
46*b1cdbd2cSJim Jagielski 
47*b1cdbd2cSJim Jagielski                 @param rLayerBounds
48*b1cdbd2cSJim Jagielski                 Specifies the bound rect of the layer relative to the
49*b1cdbd2cSJim Jagielski                 user view coordinate system.
50*b1cdbd2cSJim Jagielski 
51*b1cdbd2cSJim Jagielski             	This method sets the bounds of the view layer in
52*b1cdbd2cSJim Jagielski             	document coordinates (i.e. 'logical' coordinates). The
53*b1cdbd2cSJim Jagielski             	resulting transformation is then concatenated with the
54*b1cdbd2cSJim Jagielski             	underlying view transformation, returned by the
55*b1cdbd2cSJim Jagielski             	getTransformation() method.
56*b1cdbd2cSJim Jagielski              */
57*b1cdbd2cSJim Jagielski             virtual ViewLayerSharedPtr createViewLayer( const basegfx::B2DRange& rLayerBounds ) const = 0;
58*b1cdbd2cSJim Jagielski 
59*b1cdbd2cSJim Jagielski             /** Update screen representation from backbuffer
60*b1cdbd2cSJim Jagielski              */
61*b1cdbd2cSJim Jagielski             virtual bool updateScreen() const = 0;
62*b1cdbd2cSJim Jagielski 
63*b1cdbd2cSJim Jagielski             /** Paint screen content unconditionally from backbuffer
64*b1cdbd2cSJim Jagielski              */
65*b1cdbd2cSJim Jagielski             virtual bool paintScreen() const = 0;
66*b1cdbd2cSJim Jagielski 
67*b1cdbd2cSJim Jagielski             /** Set the size of the user view coordinate system.
68*b1cdbd2cSJim Jagielski 
69*b1cdbd2cSJim Jagielski             	This method sets the width and height of the view in
70*b1cdbd2cSJim Jagielski             	document coordinates (i.e. 'logical' coordinates). The
71*b1cdbd2cSJim Jagielski             	resulting transformation is then concatenated with the
72*b1cdbd2cSJim Jagielski             	underlying view transformation, returned by the
73*b1cdbd2cSJim Jagielski             	getTransformation() method.
74*b1cdbd2cSJim Jagielski             */
75*b1cdbd2cSJim Jagielski             virtual void setViewSize( const ::basegfx::B2DVector& ) = 0;
76*b1cdbd2cSJim Jagielski 
77*b1cdbd2cSJim Jagielski             /** Change the view's mouse cursor.
78*b1cdbd2cSJim Jagielski 
79*b1cdbd2cSJim Jagielski             	@param nPointerShape
80*b1cdbd2cSJim Jagielski                 One of the ::com::sun::star::awt::SystemPointer
81*b1cdbd2cSJim Jagielski                 constant group members.
82*b1cdbd2cSJim Jagielski              */
83*b1cdbd2cSJim Jagielski             virtual void setCursorShape( sal_Int16 nPointerShape ) = 0;
84*b1cdbd2cSJim Jagielski         };
85*b1cdbd2cSJim Jagielski 
86*b1cdbd2cSJim Jagielski         typedef ::boost::shared_ptr< View > 	ViewSharedPtr;
87*b1cdbd2cSJim Jagielski         typedef ::std::vector< ViewSharedPtr >	ViewVector;
88*b1cdbd2cSJim Jagielski     }
89*b1cdbd2cSJim Jagielski }
90*b1cdbd2cSJim Jagielski 
91*b1cdbd2cSJim Jagielski #endif /* INCLUDED_SLIDESHOW_VIEW_HXX */
92