xref: /AOO41X/main/slideshow/source/inc/slideshowcontext.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_SLIDESHOWCONTEXT_HXX
29*cdf0e10cSrcweir #define INCLUDED_SLIDESHOW_SLIDESHOWCONTEXT_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <com/sun/star/uno/Reference.hxx>
32*cdf0e10cSrcweir #include <boost/shared_ptr.hpp>
33*cdf0e10cSrcweir 
34*cdf0e10cSrcweir namespace com{ namespace sun{ namespace star{ namespace uno
35*cdf0e10cSrcweir {
36*cdf0e10cSrcweir     class XComponentContext;
37*cdf0e10cSrcweir }}}}
38*cdf0e10cSrcweir 
39*cdf0e10cSrcweir 
40*cdf0e10cSrcweir namespace slideshow
41*cdf0e10cSrcweir {
42*cdf0e10cSrcweir     namespace internal
43*cdf0e10cSrcweir     {
44*cdf0e10cSrcweir         class ShapeManager;
45*cdf0e10cSrcweir         class EventQueue;
46*cdf0e10cSrcweir         class ActivitiesQueue;
47*cdf0e10cSrcweir         class UserEventQueue;
48*cdf0e10cSrcweir         class EventMultiplexer;
49*cdf0e10cSrcweir         class ScreenUpdater;
50*cdf0e10cSrcweir         class UnoViewContainer;
51*cdf0e10cSrcweir         class CursorManager;
52*cdf0e10cSrcweir         class SubsettableShapeManager;
53*cdf0e10cSrcweir 
54*cdf0e10cSrcweir         /** Common arguments for slideshow objects.
55*cdf0e10cSrcweir 
56*cdf0e10cSrcweir         	This struct combines a number of object references
57*cdf0e10cSrcweir         	ubiquituously needed throughout the slideshow.
58*cdf0e10cSrcweir          */
59*cdf0e10cSrcweir 		struct SlideShowContext
60*cdf0e10cSrcweir         {
61*cdf0e10cSrcweir             /** Common context for node creation
62*cdf0e10cSrcweir 
63*cdf0e10cSrcweir 	            @param rShapeManager
64*cdf0e10cSrcweir                 ShapeManager, which handles all shapes
65*cdf0e10cSrcweir 
66*cdf0e10cSrcweir                 @param rEventQueue
67*cdf0e10cSrcweir                 Event queue, where time-based events are to be
68*cdf0e10cSrcweir                 scheduled. A node must not schedule events there
69*cdf0e10cSrcweir                 before it's not resolved.
70*cdf0e10cSrcweir 
71*cdf0e10cSrcweir                 @param rEventMultiplexer
72*cdf0e10cSrcweir                 Event multiplexer. Clients can register there for
73*cdf0e10cSrcweir                 about any event that happens in the slideshow
74*cdf0e10cSrcweir 
75*cdf0e10cSrcweir                 @param rScreenUpdater
76*cdf0e10cSrcweir                 Screen updater. Gets notified of necessary screen
77*cdf0e10cSrcweir                 updates.
78*cdf0e10cSrcweir 
79*cdf0e10cSrcweir                 @param rActivitiesQueue
80*cdf0e10cSrcweir                 Activities queue, where repeating activities are
81*cdf0e10cSrcweir                 to be scheduled.
82*cdf0e10cSrcweir 
83*cdf0e10cSrcweir                 @param rUserEventQueue
84*cdf0e10cSrcweir                 User event queue
85*cdf0e10cSrcweir 
86*cdf0e10cSrcweir                 @param rViewContainer
87*cdf0e10cSrcweir                 Holds all views added to slideshow
88*cdf0e10cSrcweir 
89*cdf0e10cSrcweir                 @param rComponentContext
90*cdf0e10cSrcweir                 To create UNO services from
91*cdf0e10cSrcweir             */
92*cdf0e10cSrcweir             SlideShowContext( boost::shared_ptr<SubsettableShapeManager>&       rSubsettableShapeManager,
93*cdf0e10cSrcweir                               EventQueue&                                       rEventQueue,
94*cdf0e10cSrcweir                               EventMultiplexer&                                 rEventMultiplexer,
95*cdf0e10cSrcweir                               ScreenUpdater&                                    rScreenUpdater,
96*cdf0e10cSrcweir                               ActivitiesQueue&                                  rActivitiesQueue,
97*cdf0e10cSrcweir                               UserEventQueue&                                   rUserEventQueue,
98*cdf0e10cSrcweir                               CursorManager&                                    rCursorManager,
99*cdf0e10cSrcweir                               const UnoViewContainer&                           rViewContainer,
100*cdf0e10cSrcweir                               const ::com::sun::star::uno::Reference<
101*cdf0e10cSrcweir                                   ::com::sun::star::uno::XComponentContext>&    rComponentContext );
102*cdf0e10cSrcweir             void dispose();
103*cdf0e10cSrcweir 
104*cdf0e10cSrcweir             boost::shared_ptr<SubsettableShapeManager>&     mpSubsettableShapeManager;
105*cdf0e10cSrcweir             EventQueue&										mrEventQueue;
106*cdf0e10cSrcweir             EventMultiplexer&								mrEventMultiplexer;
107*cdf0e10cSrcweir             ScreenUpdater&                                  mrScreenUpdater;
108*cdf0e10cSrcweir             ActivitiesQueue&								mrActivitiesQueue;
109*cdf0e10cSrcweir             UserEventQueue&									mrUserEventQueue;
110*cdf0e10cSrcweir             CursorManager&                                  mrCursorManager;
111*cdf0e10cSrcweir             const UnoViewContainer&                         mrViewContainer;
112*cdf0e10cSrcweir             ::com::sun::star::uno::Reference<
113*cdf0e10cSrcweir                 ::com::sun::star::uno::XComponentContext>	mxComponentContext;
114*cdf0e10cSrcweir         };
115*cdf0e10cSrcweir     }
116*cdf0e10cSrcweir }
117*cdf0e10cSrcweir 
118*cdf0e10cSrcweir #endif /* INCLUDED_SLIDESHOW_SLIDESHOWCONTEXT_HXX */
119