sd/source/ui/framework/module/CenterViewFocusModule.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: CenterViewFocusModule.hxx,v $
  10  * $Revision: 1.4 $
  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 SD_FRAMEWORK_CENTER_VIEW_FOCUS_MODULE_HXX
  32 #define SD_FRAMEWORK_CENTER_VIEW_FOCUS_MODULE_HXX
  33
  34 #include "MutexOwner.hxx"
  35
  36 #include <com/sun/star/drawing/framework/XConfigurationChangeListener.hpp>
  37 #include <com/sun/star/drawing/framework/XConfigurationController.hpp>
  38 #include <com/sun/star/frame/XController.hpp>
  39 #include <osl/mutex.hxx>
  40 #include <cppuhelper/compbase1.hxx>
  41
  42
  43 namespace {
  44
  45 typedef ::cppu::WeakComponentImplHelper1 <
  46     ::com::sun::star::drawing::framework::XConfigurationChangeListener
  47     > CenterViewFocusModuleInterfaceBase;
  48
  49 } // end of anonymous namespace.
  50
  51 namespace sd {
  52
  53 class ViewShellBase;
  54
  55 }
  56
  57
  58
  59
  60 namespace sd { namespace framework {
  61
  62 /** This module waits for new views to be created for the center pane and
  63     then moves the center view to the top most place on the shell stack.  As
  64     we are moving away from the shell stack this module may become obsolete
  65     or has to be modified.
  66 */
  67 class CenterViewFocusModule
  68     : private sd::MutexOwner,
  69       public CenterViewFocusModuleInterfaceBase
  70 {
  71 public:
  72     CenterViewFocusModule (
  73         ::com::sun::star::uno::Reference<com::sun::star::frame::XController>& rxController);
  74     virtual ~CenterViewFocusModule (void);
  75
  76     virtual void SAL_CALL disposing (void);
  77
  78
  79     // XConfigurationChangeListener
  80
  81     virtual void SAL_CALL notifyConfigurationChange (
  82         const com::sun::star::drawing::framework::ConfigurationChangeEvent& rEvent)
  83         throw (com::sun::star::uno::RuntimeException);
  84
  85     // XEventListener
  86
  87     virtual void SAL_CALL disposing (
  88         const com::sun::star::lang::EventObject& rEvent)
  89         throw (com::sun::star::uno::RuntimeException);
  90
  91 private:
  92     class ViewShellContainer;
  93
  94     bool mbValid;
  95     ::com::sun::star::uno::Reference<com::sun::star::drawing::framework::XConfigurationController>
  96         mxConfigurationController;
  97     ViewShellBase* mpBase;
  98     /** This flag indicates whether in the last configuration change cycle a
  99         new view has been created and thus the center view has to be moved
 100         to the top of the shell stack.
 101     */
 102     bool mbNewViewCreated;
 103
 104     /** At the end of an update of the current configuration this method
 105         handles a new view in the center pane by moving the associated view
 106         shell to the top of the shell stack.
 107     */
 108     void HandleNewView(
 109         const ::com::sun::star::uno::Reference<
 110             com::sun::star::drawing::framework::XConfiguration>& rxConfiguration);
 111 };
 112
 113 } } // end of namespace sd::framework
 114
 115 #endif