1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef SD_FRAMEWORK_CENTER_VIEW_FOCUS_MODULE_HXX
29 #define SD_FRAMEWORK_CENTER_VIEW_FOCUS_MODULE_HXX
30 
31 #include "MutexOwner.hxx"
32 
33 #include <com/sun/star/drawing/framework/XConfigurationChangeListener.hpp>
34 #include <com/sun/star/drawing/framework/XConfigurationController.hpp>
35 #include <com/sun/star/frame/XController.hpp>
36 #include <osl/mutex.hxx>
37 #include <cppuhelper/compbase1.hxx>
38 
39 
40 namespace {
41 
42 typedef ::cppu::WeakComponentImplHelper1 <
43     ::com::sun::star::drawing::framework::XConfigurationChangeListener
44     > CenterViewFocusModuleInterfaceBase;
45 
46 } // end of anonymous namespace.
47 
48 namespace sd {
49 
50 class ViewShellBase;
51 
52 }
53 
54 
55 
56 
57 namespace sd { namespace framework {
58 
59 /** This module waits for new views to be created for the center pane and
60     then moves the center view to the top most place on the shell stack.  As
61     we are moving away from the shell stack this module may become obsolete
62     or has to be modified.
63 */
64 class CenterViewFocusModule
65     : private sd::MutexOwner,
66       public CenterViewFocusModuleInterfaceBase
67 {
68 public:
69     CenterViewFocusModule (
70         ::com::sun::star::uno::Reference<com::sun::star::frame::XController>& rxController);
71     virtual ~CenterViewFocusModule (void);
72 
73     virtual void SAL_CALL disposing (void);
74 
75 
76     // XConfigurationChangeListener
77 
78     virtual void SAL_CALL notifyConfigurationChange (
79         const com::sun::star::drawing::framework::ConfigurationChangeEvent& rEvent)
80         throw (com::sun::star::uno::RuntimeException);
81 
82     // XEventListener
83 
84     virtual void SAL_CALL disposing (
85         const com::sun::star::lang::EventObject& rEvent)
86         throw (com::sun::star::uno::RuntimeException);
87 
88 private:
89     class ViewShellContainer;
90 
91     bool mbValid;
92     ::com::sun::star::uno::Reference<com::sun::star::drawing::framework::XConfigurationController>
93         mxConfigurationController;
94     ViewShellBase* mpBase;
95     /** This flag indicates whether in the last configuration change cycle a
96         new view has been created and thus the center view has to be moved
97         to the top of the shell stack.
98     */
99     bool mbNewViewCreated;
100 
101     /** At the end of an update of the current configuration this method
102         handles a new view in the center pane by moving the associated view
103         shell to the top of the shell stack.
104     */
105     void HandleNewView(
106         const ::com::sun::star::uno::Reference<
107             com::sun::star::drawing::framework::XConfiguration>& rxConfiguration);
108 };
109 
110 } } // end of namespace sd::framework
111 
112 #endif
113