slideshow/source/inc/slideshowcontext.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: slideshowcontext.hxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_SLIDESHOW_SLIDESHOWCONTEXT_HXX
  32 #define INCLUDED_SLIDESHOW_SLIDESHOWCONTEXT_HXX
  33
  34 #include <com/sun/star/uno/Reference.hxx>
  35 #include <boost/shared_ptr.hpp>
  36
  37 namespace com{ namespace sun{ namespace star{ namespace uno
  38 {
  39     class XComponentContext;
  40 }}}}
  41
  42
  43 namespace slideshow
  44 {
  45     namespace internal
  46     {
  47         class ShapeManager;
  48         class EventQueue;
  49         class ActivitiesQueue;
  50         class UserEventQueue;
  51         class EventMultiplexer;
  52         class ScreenUpdater;
  53         class UnoViewContainer;
  54         class CursorManager;
  55         class SubsettableShapeManager;
  56
  57         /** Common arguments for slideshow objects.
  58
  59             This struct combines a number of object references
  60             ubiquituously needed throughout the slideshow.
  61          */
  62         struct SlideShowContext
  63         {
  64             /** Common context for node creation
  65
  66                 @param rShapeManager
  67                 ShapeManager, which handles all shapes
  68
  69                 @param rEventQueue
  70                 Event queue, where time-based events are to be
  71                 scheduled. A node must not schedule events there
  72                 before it's not resolved.
  73
  74                 @param rEventMultiplexer
  75                 Event multiplexer. Clients can register there for
  76                 about any event that happens in the slideshow
  77
  78                 @param rScreenUpdater
  79                 Screen updater. Gets notified of necessary screen
  80                 updates.
  81
  82                 @param rActivitiesQueue
  83                 Activities queue, where repeating activities are
  84                 to be scheduled.
  85
  86                 @param rUserEventQueue
  87                 User event queue
  88
  89                 @param rViewContainer
  90                 Holds all views added to slideshow
  91
  92                 @param rComponentContext
  93                 To create UNO services from
  94             */
  95             SlideShowContext( boost::shared_ptr<SubsettableShapeManager>&       rSubsettableShapeManager,
  96                               EventQueue&                                       rEventQueue,
  97                               EventMultiplexer&                                 rEventMultiplexer,
  98                               ScreenUpdater&                                    rScreenUpdater,
  99                               ActivitiesQueue&                                  rActivitiesQueue,
 100                               UserEventQueue&                                   rUserEventQueue,
 101                               CursorManager&                                    rCursorManager,
 102                               const UnoViewContainer&                           rViewContainer,
 103                               const ::com::sun::star::uno::Reference<
 104                                   ::com::sun::star::uno::XComponentContext>&    rComponentContext );
 105             void dispose();
 106
 107             boost::shared_ptr<SubsettableShapeManager>&     mpSubsettableShapeManager;
 108             EventQueue&                                                                         mrEventQueue;
 109             EventMultiplexer&                                                           mrEventMultiplexer;
 110             ScreenUpdater&                                  mrScreenUpdater;
 111             ActivitiesQueue&                                                            mrActivitiesQueue;
 112             UserEventQueue&                                                                     mrUserEventQueue;
 113             CursorManager&                                  mrCursorManager;
 114             const UnoViewContainer&                         mrViewContainer;
 115             ::com::sun::star::uno::Reference<
 116                 ::com::sun::star::uno::XComponentContext>       mxComponentContext;
 117         };
 118     }
 119 }
 120
 121 #endif /* INCLUDED_SLIDESHOW_SLIDESHOWCONTEXT_HXX */