xref: /AOO41X/main/slideshow/source/inc/vieweventhandler.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef INCLUDED_SLIDESHOW_VIEWEVENTHANDLER_HXX
29*cdf0e10cSrcweir #define INCLUDED_SLIDESHOW_VIEWEVENTHANDLER_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <boost/shared_ptr.hpp>
32*cdf0e10cSrcweir #include <boost/weak_ptr.hpp>
33*cdf0e10cSrcweir 
34*cdf0e10cSrcweir #include "unoview.hxx"
35*cdf0e10cSrcweir 
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir /* Definition of ViewEventHandler interface */
38*cdf0e10cSrcweir 
39*cdf0e10cSrcweir namespace slideshow
40*cdf0e10cSrcweir {
41*cdf0e10cSrcweir     namespace internal
42*cdf0e10cSrcweir     {
43*cdf0e10cSrcweir 
44*cdf0e10cSrcweir         /** Interface for handling view events.
45*cdf0e10cSrcweir 
46*cdf0e10cSrcweir         	Classes implementing this interface can be added to an
47*cdf0e10cSrcweir         	EventMultiplexer object, and are called from there to
48*cdf0e10cSrcweir         	handle view events.
49*cdf0e10cSrcweir          */
50*cdf0e10cSrcweir         class ViewEventHandler
51*cdf0e10cSrcweir         {
52*cdf0e10cSrcweir         public:
53*cdf0e10cSrcweir             virtual ~ViewEventHandler() {}
54*cdf0e10cSrcweir 
55*cdf0e10cSrcweir             /** Notify new view.
56*cdf0e10cSrcweir 
57*cdf0e10cSrcweir             	@param rView
58*cdf0e10cSrcweir                 The newly added view
59*cdf0e10cSrcweir              */
60*cdf0e10cSrcweir             virtual void viewAdded( const UnoViewSharedPtr& rView ) = 0;
61*cdf0e10cSrcweir 
62*cdf0e10cSrcweir             /** Notify removed view.
63*cdf0e10cSrcweir 
64*cdf0e10cSrcweir             	@param rView
65*cdf0e10cSrcweir                 The removed view
66*cdf0e10cSrcweir              */
67*cdf0e10cSrcweir             virtual void viewRemoved( const UnoViewSharedPtr& rView ) = 0;
68*cdf0e10cSrcweir 
69*cdf0e10cSrcweir             /** Notify changed view.
70*cdf0e10cSrcweir 
71*cdf0e10cSrcweir                 Reasons for a viewChanged notification can be
72*cdf0e10cSrcweir                 different view size, transformation, or other device
73*cdf0e10cSrcweir                 properties (color resolution or profile, etc.)
74*cdf0e10cSrcweir 
75*cdf0e10cSrcweir             	@param rView
76*cdf0e10cSrcweir                 The changed view
77*cdf0e10cSrcweir              */
78*cdf0e10cSrcweir             virtual void viewChanged( const UnoViewSharedPtr& rView ) = 0;
79*cdf0e10cSrcweir 
80*cdf0e10cSrcweir             /** Notify that all views changed.
81*cdf0e10cSrcweir 
82*cdf0e10cSrcweir                 Reasons for a viewChanged notification can be
83*cdf0e10cSrcweir                 different view size, transformation, or other device
84*cdf0e10cSrcweir                 properties (color resolution or profile, etc.)
85*cdf0e10cSrcweir 
86*cdf0e10cSrcweir                 Note that this method avoids hidden inefficiencies
87*cdf0e10cSrcweir                 (O(n^2) behaviour when viewChanged() needs to perform
88*cdf0e10cSrcweir                 linear searches)
89*cdf0e10cSrcweir              */
90*cdf0e10cSrcweir             virtual void viewsChanged() = 0;
91*cdf0e10cSrcweir         };
92*cdf0e10cSrcweir 
93*cdf0e10cSrcweir         typedef ::boost::shared_ptr< ViewEventHandler > ViewEventHandlerSharedPtr;
94*cdf0e10cSrcweir         typedef ::boost::weak_ptr< ViewEventHandler >   ViewEventHandlerWeakPtr;
95*cdf0e10cSrcweir 
96*cdf0e10cSrcweir     }
97*cdf0e10cSrcweir }
98*cdf0e10cSrcweir 
99*cdf0e10cSrcweir #endif /* INCLUDED_SLIDESHOW_VIEWEVENTHANDLER_HXX */
100