/************************************************************** * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * *************************************************************/ #include "precompiled_sfx2.hxx" #include "SidebarController.hxx" #include "Deck.hxx" #include "DeckConfiguration.hxx" #include "DeckTitleBar.hxx" #include "Panel.hxx" #include "SidebarPanel.hxx" #include "SidebarResource.hxx" #include "TabBar.hxx" #include "sfx2/sidebar/Theme.hxx" #include "SidebarDockingWindow.hxx" #include "Context.hxx" #include "sfxresid.hxx" #include "sfx2/sfxsids.hrc" #include "sfx2/titledockwin.hxx" #include "sfxlocal.hrc" #include #include "splitwin.hxx" #include #include #include #include #include #include #include #include #include #include #include #include using namespace css; using namespace cssu; using ::rtl::OUString; #define A2S(pString) (::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(pString))) namespace sfx2 { namespace sidebar { namespace { enum MenuId { MID_UNLOCK_TASK_PANEL = 1, MID_LOCK_TASK_PANEL, MID_CUSTOMIZATION, MID_RESTORE_DEFAULT, MID_FIRST_PANEL, MID_FIRST_HIDE = 1000 }; } SidebarController::SidebarController ( SidebarDockingWindow* pParentWindow, const cssu::Reference& rxFrame) : SidebarControllerInterfaceBase(m_aMutex), mpCurrentConfiguration(), mpParentWindow(pParentWindow), mpTabBar(new TabBar( mpParentWindow, rxFrame, ::boost::bind(&SidebarController::SwitchToDeck, this, _1), ::boost::bind(&SidebarController::ShowPopupMenu, this, _1,_2,_3))), mxFrame(rxFrame), maCurrentContext(OUString(), OUString()), msCurrentDeckId(A2S("PropertyDeck")), maPropertyChangeForwarder(::boost::bind(&SidebarController::BroadcastPropertyChange, this)), mbIsDeckClosed(false), mnSavedSidebarWidth(pParentWindow->GetSizePixel().Width()) { if (pParentWindow == NULL) { OSL_ASSERT(pParentWindow!=NULL); return; } // Listen for context change events. cssu::Reference xMultiplexer ( css::ui::ContextChangeEventMultiplexer::get( ::comphelper::getProcessComponentContext())); if (xMultiplexer.is()) xMultiplexer->addContextChangeEventListener( static_cast(this), mxFrame->getController()); // Listen for window events. mpParentWindow->AddEventListener(LINK(this, SidebarController, WindowEventHandler)); // Listen for theme property changes. Theme::GetPropertySet()->addPropertyChangeListener( A2S(""), static_cast(this)); } SidebarController::~SidebarController (void) { } void SAL_CALL SidebarController::disposing (void) { cssu::Reference xMultiplexer ( css::ui::ContextChangeEventMultiplexer::get( ::comphelper::getProcessComponentContext())); if (xMultiplexer.is()) xMultiplexer->removeAllContextChangeEventListeners( static_cast(this)); if (mpParentWindow != NULL) { mpParentWindow->RemoveEventListener(LINK(this, SidebarController, WindowEventHandler)); mpParentWindow = NULL; } if (mpCurrentConfiguration) { mpCurrentConfiguration->Dispose(); mpCurrentConfiguration.reset(); } mpTabBar.reset(); Theme::GetPropertySet()->removePropertyChangeListener( A2S(""), static_cast(this)); } void SAL_CALL SidebarController::notifyContextChangeEvent (const css::ui::ContextChangeEventObject& rEvent) throw(cssu::RuntimeException) { UpdateConfigurations( Context( rEvent.ApplicationName, rEvent.ContextName)); } void SAL_CALL SidebarController::disposing (const css::lang::EventObject& rEventObject) throw(cssu::RuntimeException) { (void)rEventObject; if (mpCurrentConfiguration) { mpCurrentConfiguration->Dispose(); mpCurrentConfiguration.reset(); } mpTabBar.reset(); } void SAL_CALL SidebarController::propertyChange (const css::beans::PropertyChangeEvent& rEvent) throw(cssu::RuntimeException) { (void)rEvent; maPropertyChangeForwarder.RequestCall(); } void SAL_CALL SidebarController::requestLayout (void) throw(cssu::RuntimeException) { if (mpCurrentConfiguration && mpCurrentConfiguration->mpDeck!=NULL) mpCurrentConfiguration->mpDeck->RequestLayout(); RestrictWidth(); } void SidebarController::BroadcastPropertyChange (void) { DataChangedEvent aEvent (DATACHANGED_USER); mpParentWindow->NotifyAllChilds(aEvent); mpParentWindow->Invalidate(INVALIDATE_CHILDREN); } void SidebarController::NotifyResize (void) { if (mpTabBar == NULL) { OSL_ASSERT(mpTabBar!=NULL); return; } Window* pParentWindow = mpTabBar->GetParent(); const sal_Int32 nWidth (pParentWindow->GetSizePixel().Width()); const sal_Int32 nHeight (pParentWindow->GetSizePixel().Height()); // Place the deck. Deck* pDeck = NULL; if (mpCurrentConfiguration != NULL && ! mbIsDeckClosed) { pDeck = mpCurrentConfiguration->mpDeck; if (pDeck == NULL) { OSL_ASSERT(mpCurrentConfiguration->mpDeck!=NULL); } } if (pDeck != NULL) { pDeck->SetPosSizePixel(0,0, nWidth-TabBar::GetDefaultWidth(), nHeight); pDeck->Show(); pDeck->RequestLayout(); } // Place the tab bar. mpTabBar->SetPosSizePixel(nWidth-TabBar::GetDefaultWidth(),0,TabBar::GetDefaultWidth(),nHeight); mpTabBar->Show(); // Determine if the closer of the deck can be shown. if (pDeck!=NULL) { DeckTitleBar* pTitleBar = pDeck->GetTitleBar(); if (pTitleBar != NULL && pTitleBar->IsVisible()) pTitleBar->SetCloserVisible(CanModifyChildWindowWidth()); } if (nWidth > TabBar::GetDefaultWidth()) mnSavedSidebarWidth = nWidth; RestrictWidth(); #ifdef DEBUG if (mpCurrentConfiguration != NULL) { mpCurrentConfiguration->mpDeck->PrintWindowTree(); sal_Int32 nPanelIndex (0); for (::std::vector::const_iterator iPanel(mpCurrentConfiguration->maPanels.begin()), iEnd(mpCurrentConfiguration->maPanels.end()); iPanel!=iEnd; ++iPanel,++nPanelIndex) { OSL_TRACE("panel %d:", nPanelIndex); (*iPanel)->PrintWindowTree(); } } #endif } void SidebarController::UpdateConfigurations (const Context& rContext) { if (maCurrentContext != rContext) { maCurrentContext = rContext; // Notify the tab bar about the updated set of decks. ResourceManager::IdContainer aDeckIds; ResourceManager::Instance().GetMatchingDecks ( aDeckIds, rContext, mxFrame); mpTabBar->SetDecks(aDeckIds); // Check if the current deck is among the matching decks. bool bCurrentDeckMatches (false); for (ResourceManager::IdContainer::const_iterator iDeck(aDeckIds.begin()), iEnd(aDeckIds.end()); iDeck!=iEnd; ++iDeck) { if (iDeck->equals(msCurrentDeckId)) { bCurrentDeckMatches = true; break; } } DeckDescriptor const* pDeckDescriptor = NULL; if ( ! bCurrentDeckMatches) { pDeckDescriptor = ResourceManager::Instance().GetBestMatchingDeck(rContext, mxFrame); msCurrentDeckId = pDeckDescriptor->msId; } else pDeckDescriptor = ResourceManager::Instance().GetDeckDescriptor(msCurrentDeckId); if (pDeckDescriptor != NULL) { msCurrentDeckId = pDeckDescriptor->msId; SwitchToDeck(*pDeckDescriptor, rContext); } } } void SidebarController::SwitchToDeck ( const ::rtl::OUString& rsDeckId) { if ( ! msCurrentDeckId.equals(rsDeckId) || mbIsDeckClosed) { const DeckDescriptor* pDeckDescriptor = ResourceManager::Instance().GetDeckDescriptor(rsDeckId); if (pDeckDescriptor != NULL) SwitchToDeck(*pDeckDescriptor, maCurrentContext); } } void SidebarController::SwitchToDeck ( const DeckDescriptor& rDeckDescriptor, const Context& rContext) { if ( ! msCurrentDeckId.equals(rDeckDescriptor.msId)) { // When the deck changes then destroy the deck and all panels // and create everything new. if (mpCurrentConfiguration) { mpCurrentConfiguration->Dispose(); mpCurrentConfiguration.reset(); } msCurrentDeckId = rDeckDescriptor.msId; } // Reopen the deck when necessary. OpenDeck(); // Determine the panels to display in the deck. ResourceManager::IdContainer aPanelIds; ResourceManager::Instance().GetMatchingPanels( aPanelIds, rContext, rDeckDescriptor.msId, mxFrame); // Provide a configuration and Deck object. if ( ! mpCurrentConfiguration) { mpCurrentConfiguration.reset(new DeckConfiguration); mpCurrentConfiguration->mpDeck = new Deck( rDeckDescriptor, mpParentWindow, ::boost::bind(&SidebarController::CloseDeck, this)); } // Update the panel list. const sal_Int32 nNewPanelCount (aPanelIds.size()); ::std::vector aNewPanels; ::std::vector aCurrentPanels; if (mpCurrentConfiguration) aCurrentPanels.swap(mpCurrentConfiguration->maPanels); aNewPanels.resize(nNewPanelCount); sal_Int32 nWriteIndex (0); for (sal_Int32 nReadIndex=0; nReadIndex::iterator iPanel (::std::find_if( aCurrentPanels.begin(), aCurrentPanels.end(), ::boost::bind(&Panel::HasIdPredicate, _1, ::boost::cref(rsPanelId)))); if (iPanel != aCurrentPanels.end()) { // Panel already exists in current configuration. Move it // to new configuration. aNewPanels[nWriteIndex] = *iPanel; aCurrentPanels[::std::distance(aCurrentPanels.begin(), iPanel)] = NULL; } else { // Panel does not yet exist. Create it. aNewPanels[nWriteIndex] = CreatePanel( rsPanelId, mpCurrentConfiguration->mpDeck->GetPanelParentWindow()); } if (aNewPanels[nWriteIndex] != NULL) ++nWriteIndex; } aNewPanels.resize(nWriteIndex); // Destroy all panels that are not used in the new configuration. for (::std::vector::const_iterator iPanel(aCurrentPanels.begin()),iEnd(aCurrentPanels.end()); iPanel!=iEnd; ++iPanel) { if (*iPanel != NULL) (*iPanel)->Dispose(); } // Activate the deck and the new set of panels. mpCurrentConfiguration->maPanels.swap(aNewPanels); mpCurrentConfiguration->mpDeck->SetPosSizePixel( 0, 0, mpParentWindow->GetSizePixel().Width()-TabBar::GetDefaultWidth(), mpParentWindow->GetSizePixel().Height()); mpCurrentConfiguration->mpDeck->SetPanels(mpCurrentConfiguration->maPanels); mpCurrentConfiguration->mpDeck->Show(); // Tell the tab bar to highlight the button associated with the // deck. mpTabBar->HighlightDeck(rDeckDescriptor.msId); mpParentWindow->SetText(rDeckDescriptor.msTitle); NotifyResize(); } Panel* SidebarController::CreatePanel ( const OUString& rsPanelId, ::Window* pParentWindow) { const PanelDescriptor* pPanelDescriptor = ResourceManager::Instance().GetPanelDescriptor(rsPanelId); if (pPanelDescriptor == NULL) return NULL; #ifdef DEBUG // Prevent the panel not being created in the same memory of an old panel. ::boost::scoped_array pUnused (new char[sizeof(Panel)]); OSL_TRACE("allocated memory at %x", pUnused.get()); #endif // Create the panel which is the parent window of the UIElement. Panel* pPanel = new Panel( *pPanelDescriptor, pParentWindow, ::boost::bind(&Deck::RequestLayout,mpCurrentConfiguration->mpDeck)); // Create the XUIElement. Reference xUIElement (CreateUIElement( pPanel->GetComponentInterface(), pPanelDescriptor->msImplementationURL, pPanel)); if (xUIElement.is()) { // Initialize the panel and add it to the active deck. pPanel->SetUIElement(xUIElement); } else { delete pPanel; pPanel = NULL; } return pPanel; } Reference SidebarController::CreateUIElement ( const Reference& rxWindow, const ::rtl::OUString& rsImplementationURL, Panel* pPanel) { try { const ::comphelper::ComponentContext aComponentContext (::comphelper::getProcessServiceFactory()); const Reference xUIElementFactory ( aComponentContext.createComponent("com.sun.star.ui.UIElementFactoryManager"), UNO_QUERY_THROW); // Create the XUIElement. ::comphelper::NamedValueCollection aCreationArguments; aCreationArguments.put("Frame", makeAny(mxFrame)); aCreationArguments.put("ParentWindow", makeAny(rxWindow)); SfxDockingWindow* pSfxDockingWindow = dynamic_cast(mpParentWindow); if (pSfxDockingWindow != NULL) aCreationArguments.put("SfxBindings", makeAny(sal_uInt64(&pSfxDockingWindow->GetBindings()))); aCreationArguments.put("Theme", Theme::GetPropertySet()); aCreationArguments.put("Sidebar", makeAny(Reference(static_cast(this)))); Reference xUIElement( xUIElementFactory->createUIElement( rsImplementationURL, Sequence(aCreationArguments.getPropertyValues())), UNO_QUERY_THROW); return xUIElement; } catch(Exception& rException) { OSL_TRACE("caught exception: %s", OUStringToOString(rException.Message, RTL_TEXTENCODING_ASCII_US).getStr()); // For some reason we can not create the actual panel. // Probably because its factory was not properly registered. // TODO: provide feedback to developer to better pinpoint the // source of the error. return NULL; } } IMPL_LINK(SidebarController, WindowEventHandler, VclWindowEvent*, pEvent) { if (pEvent != NULL) { switch (pEvent->GetId()) { case VCLEVENT_WINDOW_GETFOCUS: case VCLEVENT_WINDOW_LOSEFOCUS: break; case VCLEVENT_WINDOW_SHOW: case VCLEVENT_WINDOW_RESIZE: NotifyResize(); break; case VCLEVENT_WINDOW_DATACHANGED: // Force an update of deck and tab bar to reflect // changes in theme (high contrast mode). Theme::HandleDataChange(); mpParentWindow->Invalidate(); break; case SFX_HINT_DYING: dispose(); break; default: break; } } return sal_True; } void SidebarController::ShowPopupMenu ( const Rectangle& rButtonBox, const ::std::vector& rDeckSelectionData, const ::std::vector& rDeckShowData) const { ::boost::shared_ptr pMenu = CreatePopupMenu(rDeckSelectionData, rDeckShowData); pMenu->SetSelectHdl(LINK(this, SidebarController, OnMenuItemSelected)); // pass toolbox button rect so the menu can stay open on button up Rectangle aBox (rButtonBox); aBox.Move(mpTabBar->GetPosPixel().X(), 0); pMenu->Execute(mpParentWindow, aBox, POPUPMENU_EXECUTE_DOWN); } ::boost::shared_ptr SidebarController::CreatePopupMenu ( const ::std::vector& rDeckSelectionData, const ::std::vector& rDeckShowData) const { ::boost::shared_ptr pMenu (new PopupMenu()); FloatingWindow* pMenuWindow = dynamic_cast(pMenu->GetWindow()); if (pMenuWindow != NULL) { pMenuWindow->SetPopupModeFlags(pMenuWindow->GetPopupModeFlags() | FLOATWIN_POPUPMODE_NOMOUSEUPCLOSE); } SidebarResource aLocalResource; // Add one entry for every tool panel element to individually make // them visible or hide them. { sal_Int32 nIndex (MID_FIRST_PANEL); for(::std::vector::const_iterator iItem(rDeckSelectionData.begin()), iEnd(rDeckSelectionData.end()); iItem!=iEnd; ++iItem) { pMenu->InsertItem(nIndex, iItem->get<0>(), MIB_RADIOCHECK); pMenu->CheckItem(nIndex, iItem->get<2>()); ++nIndex; } } pMenu->InsertSeparator(); // Add entry for docking or un-docking the tool panel. if (mpParentWindow->IsFloatingMode()) pMenu->InsertItem(MID_LOCK_TASK_PANEL, String(SfxResId(STR_SFX_DOCK))); else pMenu->InsertItem(MID_UNLOCK_TASK_PANEL, String(SfxResId(STR_SFX_UNDOCK))); // Add sub menu for customization (hiding of deck tabs.) PopupMenu* pCustomizationMenu = new PopupMenu(); { sal_Int32 nIndex (MID_FIRST_HIDE); for(::std::vector::const_iterator iItem(rDeckShowData.begin()), iEnd(rDeckShowData.end()); iItem!=iEnd; ++iItem) { pCustomizationMenu->InsertItem(nIndex, iItem->get<0>(), MIB_CHECKABLE); pCustomizationMenu->CheckItem(nIndex, iItem->get<2>()); ++nIndex; } } pCustomizationMenu->InsertSeparator(); pCustomizationMenu->InsertItem(MID_RESTORE_DEFAULT, String(SfxResId(STRING_RESTORE))); pMenu->InsertItem(MID_CUSTOMIZATION, String(SfxResId(STRING_CUSTOMIZATION))); pMenu->SetPopupMenu(MID_CUSTOMIZATION, pCustomizationMenu); pMenu->RemoveDisabledEntries(sal_False, sal_False); return pMenu; } IMPL_LINK(SidebarController, OnMenuItemSelected, Menu*, pMenu) { if (pMenu == NULL) { OSL_ENSURE(pMenu!=NULL, "sfx2::sidebar::SidebarController::OnMenuItemSelected: illegal menu!"); return 0; } pMenu->Deactivate(); const sal_Int32 nIndex (pMenu->GetCurItemId()); switch (nIndex) { case MID_UNLOCK_TASK_PANEL: mpParentWindow->SetFloatingMode(sal_True); break; case MID_LOCK_TASK_PANEL: mpParentWindow->SetFloatingMode(sal_False); break; case MID_RESTORE_DEFAULT: mpTabBar->RestoreHideFlags(); break; default: { try { if (nIndex >= MID_FIRST_PANEL && nIndexGetDeckIdForIndex(nIndex - MID_FIRST_PANEL)); else if (nIndex >=MID_FIRST_HIDE) mpTabBar->ToggleHideFlag(nIndex-MID_FIRST_HIDE); } catch (RuntimeException&) { } } break; } return 1; } void SidebarController::CloseDeck (void) { if ( ! mbIsDeckClosed) { mbIsDeckClosed = true; if ( ! mpParentWindow->IsFloatingMode()) mnSavedSidebarWidth = SetChildWindowWidth(TabBar::GetDefaultWidth()); mpParentWindow->SetStyle(mpParentWindow->GetStyle() & ~WB_SIZEABLE); if (mpCurrentConfiguration && mpCurrentConfiguration->mpDeck!=NULL) mpCurrentConfiguration->mpDeck->Hide(); NotifyResize(); } } void SidebarController::OpenDeck (void) { if (mbIsDeckClosed) { mbIsDeckClosed = false; SetChildWindowWidth(mnSavedSidebarWidth); if (mpCurrentConfiguration && mpCurrentConfiguration->mpDeck!=NULL) mpCurrentConfiguration->mpDeck->Show(); NotifyResize(); } } bool SidebarController::CanModifyChildWindowWidth (void) const { SfxSplitWindow* pSplitWindow = dynamic_cast(mpParentWindow->GetParent()); if (pSplitWindow == NULL) { OSL_ASSERT(pSplitWindow!=NULL); return 0; } sal_uInt16 nRow (0xffff); sal_uInt16 nColumn (0xffff); pSplitWindow->GetWindowPos(mpParentWindow, nColumn, nRow); sal_uInt16 nRowCount (pSplitWindow->GetWindowCount(nColumn)); return nRowCount == 1; } sal_Int32 SidebarController::SetChildWindowWidth (const sal_Int32 nNewWidth) { SfxSplitWindow* pSplitWindow = dynamic_cast(mpParentWindow->GetParent()); if (pSplitWindow == NULL) return 0; sal_uInt16 nRow (0xffff); sal_uInt16 nColumn (0xffff); pSplitWindow->GetWindowPos(mpParentWindow, nColumn, nRow); const long nColumnWidth (pSplitWindow->GetLineSize(nColumn)); Window* pWindow = mpParentWindow; const Point aWindowPosition (pWindow->GetPosPixel()); const Size aWindowSize (pWindow->GetSizePixel()); pSplitWindow->MoveWindow( mpParentWindow, Size(nNewWidth, aWindowSize.Height()), nColumn, nRow); return static_cast(nColumnWidth); } void SidebarController::RestrictWidth (void) { SfxSplitWindow* pSplitWindow = dynamic_cast(mpParentWindow->GetParent()); if (pSplitWindow != NULL) { const sal_uInt16 nId (pSplitWindow->GetItemId(mpParentWindow)); const sal_uInt16 nSetId (pSplitWindow->GetSet(nId)); // Minimum width is always that of the tabbar. const sal_Int32 nMinimumWidth (TabBar::GetDefaultWidth()); // Maximum width depends on whether the deck is open or closed. const sal_Int32 nMaximumWidth ( mbIsDeckClosed ? TabBar::GetDefaultWidth() : 400); pSplitWindow->SetItemSizeRange( nSetId, Range(nMinimumWidth, nMaximumWidth)); if (nMinimumWidth == nMaximumWidth) pSplitWindow->SetItemSize(nSetId, nMinimumWidth); } } } } // end of namespace sfx2::sidebar