1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski #ifndef SFX_SIDEBAR_CONTROLLER_HXX 23*b1cdbd2cSJim Jagielski #define SFX_SIDEBAR_CONTROLLER_HXX 24*b1cdbd2cSJim Jagielski 25*b1cdbd2cSJim Jagielski #include "AsynchronousCall.hxx" 26*b1cdbd2cSJim Jagielski #include "Context.hxx" 27*b1cdbd2cSJim Jagielski #include "FocusManager.hxx" 28*b1cdbd2cSJim Jagielski #include "Panel.hxx" 29*b1cdbd2cSJim Jagielski #include "ResourceManager.hxx" 30*b1cdbd2cSJim Jagielski #include "TabBar.hxx" 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielski #include <vcl/menu.hxx> 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski #include <com/sun/star/awt/XWindowPeer.hpp> 35*b1cdbd2cSJim Jagielski #include <com/sun/star/beans/XPropertyChangeListener.hpp> 36*b1cdbd2cSJim Jagielski #include <com/sun/star/frame/XDispatch.hpp> 37*b1cdbd2cSJim Jagielski #include <com/sun/star/ui/XContextChangeEventListener.hpp> 38*b1cdbd2cSJim Jagielski #include <com/sun/star/ui/XUIElement.hpp> 39*b1cdbd2cSJim Jagielski #include <com/sun/star/ui/XSidebar.hpp> 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski #include <boost/noncopyable.hpp> 42*b1cdbd2cSJim Jagielski #include <boost/optional.hpp> 43*b1cdbd2cSJim Jagielski #include <cppuhelper/compbase4.hxx> 44*b1cdbd2cSJim Jagielski #include <cppuhelper/basemutex.hxx> 45*b1cdbd2cSJim Jagielski #include <cppuhelper/weakref.hxx> 46*b1cdbd2cSJim Jagielski #include <comphelper/stl_types.hxx> 47*b1cdbd2cSJim Jagielski 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski namespace css = ::com::sun::star; 50*b1cdbd2cSJim Jagielski namespace cssu = ::com::sun::star::uno; 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski namespace 54*b1cdbd2cSJim Jagielski { 55*b1cdbd2cSJim Jagielski typedef ::cppu::WeakComponentImplHelper4 < 56*b1cdbd2cSJim Jagielski css::ui::XContextChangeEventListener, 57*b1cdbd2cSJim Jagielski css::beans::XPropertyChangeListener, 58*b1cdbd2cSJim Jagielski css::ui::XSidebar, 59*b1cdbd2cSJim Jagielski css::frame::XStatusListener 60*b1cdbd2cSJim Jagielski > SidebarControllerInterfaceBase; 61*b1cdbd2cSJim Jagielski } 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski class SfxSplitWindow; 64*b1cdbd2cSJim Jagielski class FixedBitmap; 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski namespace sfx2 { namespace sidebar { 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski class ContentPanelDescriptor; 69*b1cdbd2cSJim Jagielski class Deck; 70*b1cdbd2cSJim Jagielski class DeckDescriptor; 71*b1cdbd2cSJim Jagielski class SidebarDockingWindow; 72*b1cdbd2cSJim Jagielski class TabBar; 73*b1cdbd2cSJim Jagielski class TabBarConfiguration; 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski class SidebarController 76*b1cdbd2cSJim Jagielski : private ::boost::noncopyable, 77*b1cdbd2cSJim Jagielski private ::cppu::BaseMutex, 78*b1cdbd2cSJim Jagielski public SidebarControllerInterfaceBase 79*b1cdbd2cSJim Jagielski { 80*b1cdbd2cSJim Jagielski public: 81*b1cdbd2cSJim Jagielski SidebarController( 82*b1cdbd2cSJim Jagielski SidebarDockingWindow* pParentWindow, 83*b1cdbd2cSJim Jagielski const cssu::Reference<css::frame::XFrame>& rxFrame); 84*b1cdbd2cSJim Jagielski virtual ~SidebarController (void); 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski /** Return the SidebarController object that is associated with 87*b1cdbd2cSJim Jagielski the given XFrame. 88*b1cdbd2cSJim Jagielski @return 89*b1cdbd2cSJim Jagielski When there is no SidebarController object for the given 90*b1cdbd2cSJim Jagielski XFrame then <NULL/> is returned. 91*b1cdbd2cSJim Jagielski */ 92*b1cdbd2cSJim Jagielski static SidebarController* GetSidebarControllerForFrame ( 93*b1cdbd2cSJim Jagielski const cssu::Reference<css::frame::XFrame>& rxFrame); 94*b1cdbd2cSJim Jagielski 95*b1cdbd2cSJim Jagielski // ui::XContextChangeEventListener 96*b1cdbd2cSJim Jagielski virtual void SAL_CALL notifyContextChangeEvent (const css::ui::ContextChangeEventObject& rEvent) 97*b1cdbd2cSJim Jagielski throw(cssu::RuntimeException); 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski // XEventListener 100*b1cdbd2cSJim Jagielski virtual void SAL_CALL disposing (const css::lang::EventObject& rEventObject) 101*b1cdbd2cSJim Jagielski throw(cssu::RuntimeException); 102*b1cdbd2cSJim Jagielski 103*b1cdbd2cSJim Jagielski // beans::XPropertyChangeListener 104*b1cdbd2cSJim Jagielski virtual void SAL_CALL propertyChange (const css::beans::PropertyChangeEvent& rEvent) 105*b1cdbd2cSJim Jagielski throw(cssu::RuntimeException); 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski // frame::XStatusListener 108*b1cdbd2cSJim Jagielski virtual void SAL_CALL statusChanged (const css::frame::FeatureStateEvent& rEvent) 109*b1cdbd2cSJim Jagielski throw(cssu::RuntimeException); 110*b1cdbd2cSJim Jagielski 111*b1cdbd2cSJim Jagielski // ui::XSidebar 112*b1cdbd2cSJim Jagielski virtual void SAL_CALL requestLayout (void) 113*b1cdbd2cSJim Jagielski throw(cssu::RuntimeException); 114*b1cdbd2cSJim Jagielski 115*b1cdbd2cSJim Jagielski void NotifyResize (void); 116*b1cdbd2cSJim Jagielski 117*b1cdbd2cSJim Jagielski /** In some situations it is necessary to force an update of the 118*b1cdbd2cSJim Jagielski current deck and its panels. One reason is a change of the 119*b1cdbd2cSJim Jagielski view scale. Some panels can handle this only when 120*b1cdbd2cSJim Jagielski constructed. In this case we have to a context change and 121*b1cdbd2cSJim Jagielski also force that all panels are destroyed and created new. 122*b1cdbd2cSJim Jagielski */ 123*b1cdbd2cSJim Jagielski const static sal_Int32 SwitchFlag_NoForce = 0x00; 124*b1cdbd2cSJim Jagielski const static sal_Int32 SwitchFlag_ForceSwitch = 0x01; 125*b1cdbd2cSJim Jagielski const static sal_Int32 SwitchFlag_ForceNewDeck = 0x02; 126*b1cdbd2cSJim Jagielski const static sal_Int32 SwitchFlag_ForceNewPanels = 0x02; 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski void RequestSwitchToDeck ( 129*b1cdbd2cSJim Jagielski const ::rtl::OUString& rsDeckId); 130*b1cdbd2cSJim Jagielski void OpenThenSwitchToDeck ( 131*b1cdbd2cSJim Jagielski const ::rtl::OUString& rsDeckId); 132*b1cdbd2cSJim Jagielski 133*b1cdbd2cSJim Jagielski /** Show only the tab bar, not the deck. 134*b1cdbd2cSJim Jagielski */ 135*b1cdbd2cSJim Jagielski void RequestCloseDeck (void); 136*b1cdbd2cSJim Jagielski 137*b1cdbd2cSJim Jagielski /** Open the deck area and restore the parent window to its old width. 138*b1cdbd2cSJim Jagielski */ 139*b1cdbd2cSJim Jagielski void RequestOpenDeck (void); 140*b1cdbd2cSJim Jagielski 141*b1cdbd2cSJim Jagielski FocusManager& GetFocusManager (void); 142*b1cdbd2cSJim Jagielski 143*b1cdbd2cSJim Jagielski private: 144*b1cdbd2cSJim Jagielski typedef ::std::map< 145*b1cdbd2cSJim Jagielski const cssu::Reference<css::frame::XFrame>, 146*b1cdbd2cSJim Jagielski cssu::WeakReference<SidebarController> 147*b1cdbd2cSJim Jagielski > SidebarControllerContainer; 148*b1cdbd2cSJim Jagielski static SidebarControllerContainer maSidebarControllerContainer; 149*b1cdbd2cSJim Jagielski 150*b1cdbd2cSJim Jagielski ::boost::scoped_ptr<Deck> mpCurrentDeck; 151*b1cdbd2cSJim Jagielski SidebarDockingWindow* mpParentWindow; 152*b1cdbd2cSJim Jagielski ::boost::scoped_ptr<TabBar> mpTabBar; 153*b1cdbd2cSJim Jagielski cssu::Reference<css::frame::XFrame> mxFrame; 154*b1cdbd2cSJim Jagielski Context maCurrentContext; 155*b1cdbd2cSJim Jagielski Context maRequestedContext; 156*b1cdbd2cSJim Jagielski /// Use a combination of SwitchFlag_* as value. 157*b1cdbd2cSJim Jagielski sal_Int32 mnRequestedForceFlags; 158*b1cdbd2cSJim Jagielski ::rtl::OUString msCurrentDeckId; 159*b1cdbd2cSJim Jagielski ::rtl::OUString msCurrentDeckTitle; 160*b1cdbd2cSJim Jagielski AsynchronousCall maPropertyChangeForwarder; 161*b1cdbd2cSJim Jagielski AsynchronousCall maContextChangeUpdate; 162*b1cdbd2cSJim Jagielski AsynchronousCall maAsynchronousDeckSwitch; 163*b1cdbd2cSJim Jagielski 164*b1cdbd2cSJim Jagielski /** Two flags control whether the deck is displayed or if only the 165*b1cdbd2cSJim Jagielski tab bar remains visible. 166*b1cdbd2cSJim Jagielski The mbIsDeckOpen flag stores the current state while 167*b1cdbd2cSJim Jagielski mbIsDeckRequestedOpen stores how this state should be. User 168*b1cdbd2cSJim Jagielski actions like clicking on the deck closer affect the 169*b1cdbd2cSJim Jagielski mbIsDeckRequestedOpen. Normally both flags have the same 170*b1cdbd2cSJim Jagielski value. A document being read-only can prevent the deck from opening. 171*b1cdbd2cSJim Jagielski */ 172*b1cdbd2cSJim Jagielski ::boost::optional<bool> mbIsDeckRequestedOpen; 173*b1cdbd2cSJim Jagielski ::boost::optional<bool> mbIsDeckOpen; 174*b1cdbd2cSJim Jagielski bool mbCanDeckBeOpened; 175*b1cdbd2cSJim Jagielski 176*b1cdbd2cSJim Jagielski /** Before the deck is closed the sidebar width is saved into this variable, 177*b1cdbd2cSJim Jagielski so that it can be restored when the deck is reopended. 178*b1cdbd2cSJim Jagielski */ 179*b1cdbd2cSJim Jagielski sal_Int32 mnSavedSidebarWidth; 180*b1cdbd2cSJim Jagielski FocusManager maFocusManager; 181*b1cdbd2cSJim Jagielski cssu::Reference<css::frame::XDispatch> mxReadOnlyModeDispatch; 182*b1cdbd2cSJim Jagielski bool mbIsDocumentReadOnly; 183*b1cdbd2cSJim Jagielski SfxSplitWindow* mpSplitWindow; 184*b1cdbd2cSJim Jagielski /** When the user moves the splitter then we remember the 185*b1cdbd2cSJim Jagielski width at that time. 186*b1cdbd2cSJim Jagielski */ 187*b1cdbd2cSJim Jagielski sal_Int32 mnWidthOnSplitterButtonDown; 188*b1cdbd2cSJim Jagielski /** Control that is temporarily used as replacement for the deck 189*b1cdbd2cSJim Jagielski to indicate that when the current mouse drag operation ends, the 190*b1cdbd2cSJim Jagielski sidebar will only show the tab bar. 191*b1cdbd2cSJim Jagielski */ 192*b1cdbd2cSJim Jagielski ::boost::scoped_ptr<Window> mpCloseIndicator; 193*b1cdbd2cSJim Jagielski 194*b1cdbd2cSJim Jagielski DECL_LINK(WindowEventHandler, VclWindowEvent*); 195*b1cdbd2cSJim Jagielski /** Make maRequestedContext the current context. 196*b1cdbd2cSJim Jagielski */ 197*b1cdbd2cSJim Jagielski void UpdateConfigurations (void); 198*b1cdbd2cSJim Jagielski 199*b1cdbd2cSJim Jagielski cssu::Reference<css::ui::XUIElement> CreateUIElement ( 200*b1cdbd2cSJim Jagielski const cssu::Reference<css::awt::XWindowPeer>& rxWindow, 201*b1cdbd2cSJim Jagielski const ::rtl::OUString& rsImplementationURL, 202*b1cdbd2cSJim Jagielski const bool bWantsCanvas, 203*b1cdbd2cSJim Jagielski const Context& rContext); 204*b1cdbd2cSJim Jagielski SharedPanel CreatePanel ( 205*b1cdbd2cSJim Jagielski const ::rtl::OUString& rsPanelId, 206*b1cdbd2cSJim Jagielski ::Window* pParentWindow, 207*b1cdbd2cSJim Jagielski const bool bIsInitiallyExpanded, 208*b1cdbd2cSJim Jagielski const Context& rContext); 209*b1cdbd2cSJim Jagielski void SwitchToDeck ( 210*b1cdbd2cSJim Jagielski const ::rtl::OUString& rsDeckId); 211*b1cdbd2cSJim Jagielski void SwitchToDeck ( 212*b1cdbd2cSJim Jagielski const DeckDescriptor& rDeckDescriptor, 213*b1cdbd2cSJim Jagielski const Context& rContext); 214*b1cdbd2cSJim Jagielski void ShowPopupMenu ( 215*b1cdbd2cSJim Jagielski const Rectangle& rButtonBox, 216*b1cdbd2cSJim Jagielski const ::std::vector<TabBar::DeckMenuData>& rMenuData) const; 217*b1cdbd2cSJim Jagielski void ShowDetailMenu (const ::rtl::OUString& rsMenuCommand) const; 218*b1cdbd2cSJim Jagielski ::boost::shared_ptr<PopupMenu> CreatePopupMenu ( 219*b1cdbd2cSJim Jagielski const ::std::vector<TabBar::DeckMenuData>& rMenuData) const; 220*b1cdbd2cSJim Jagielski DECL_LINK(OnMenuItemSelected, Menu*); 221*b1cdbd2cSJim Jagielski void BroadcastPropertyChange (void); 222*b1cdbd2cSJim Jagielski 223*b1cdbd2cSJim Jagielski /** The close of the deck changes the width of the child window. 224*b1cdbd2cSJim Jagielski That is only possible if there is no other docking window docked above or below the sidebar. 225*b1cdbd2cSJim Jagielski Return whether the width of the child window can be modified. 226*b1cdbd2cSJim Jagielski */ 227*b1cdbd2cSJim Jagielski bool CanModifyChildWindowWidth (void); 228*b1cdbd2cSJim Jagielski 229*b1cdbd2cSJim Jagielski /** Set the child window container to a new width. 230*b1cdbd2cSJim Jagielski Return the old width. 231*b1cdbd2cSJim Jagielski */ 232*b1cdbd2cSJim Jagielski sal_Int32 SetChildWindowWidth (const sal_Int32 nNewWidth); 233*b1cdbd2cSJim Jagielski 234*b1cdbd2cSJim Jagielski /** Update the icons displayed in the title bars of the deck and 235*b1cdbd2cSJim Jagielski the panels. This is called once when a deck is created and 236*b1cdbd2cSJim Jagielski every time when a data change event is processed. 237*b1cdbd2cSJim Jagielski */ 238*b1cdbd2cSJim Jagielski void UpdateTitleBarIcons (void); 239*b1cdbd2cSJim Jagielski 240*b1cdbd2cSJim Jagielski void UpdateDeckOpenState (void); 241*b1cdbd2cSJim Jagielski void RestrictWidth (void); 242*b1cdbd2cSJim Jagielski SfxSplitWindow* GetSplitWindow (void); 243*b1cdbd2cSJim Jagielski void ProcessNewWidth (const sal_Int32 nNewWidth); 244*b1cdbd2cSJim Jagielski void UpdateCloseIndicator (const bool bIsIndicatorVisible); 245*b1cdbd2cSJim Jagielski 246*b1cdbd2cSJim Jagielski /** Typically called when a panel is focused via keyboard. 247*b1cdbd2cSJim Jagielski Tries to scroll the deck up or down to make the given panel 248*b1cdbd2cSJim Jagielski completely visible. 249*b1cdbd2cSJim Jagielski */ 250*b1cdbd2cSJim Jagielski void ShowPanel (const Panel& rPanel); 251*b1cdbd2cSJim Jagielski 252*b1cdbd2cSJim Jagielski Context GetCurrentContext (void) const; 253*b1cdbd2cSJim Jagielski 254*b1cdbd2cSJim Jagielski virtual void SAL_CALL disposing (void); 255*b1cdbd2cSJim Jagielski }; 256*b1cdbd2cSJim Jagielski 257*b1cdbd2cSJim Jagielski 258*b1cdbd2cSJim Jagielski } } // end of namespace sfx2::sidebar 259*b1cdbd2cSJim Jagielski 260*b1cdbd2cSJim Jagielski #endif 261