framework/source/uielement/toolbarmodemenucontroller.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <uielement/toolbarmodemenucontroller.hxx>
  21 #include <services.h>
  22
  23 #include <com/sun/star/awt/MenuItemStyle.hpp>
  24 #include <com/sun/star/ui/UIElementType.hpp>
  25 #include <com/sun/star/frame/XModuleManager.hpp>
  26 #include <com/sun/star/frame/ModuleManager.hpp>
  27
  28
  29 #include <toolkit/awt/vclxmenu.hxx>
  30 #include <officecfg/Office/Common.hxx>
  31 #include <vcl/svapp.hxx>
  32 #include <vcl/EnumContext.hxx>
  33 #include <rtl/ustrbuf.hxx>
  34 #include <comphelper/processfactory.hxx>
  35 #include <comphelper/propertysequence.hxx>
  36 #include <comphelper/types.hxx>
  37 #include <unotools/confignode.hxx>
  38 #include <cppuhelper/supportsservice.hxx>
  39
  40 //  Defines
  41
  42 using namespace ::com::sun::star;
  43 using namespace ::com::sun::star::uno;
  44 using namespace ::com::sun::star::lang;
  45 using namespace ::com::sun::star::frame;
  46 using namespace ::com::sun::star::util;
  47
  48 namespace framework
  49 {
  50
  51 // XInterface, XTypeProvider, XServiceInfo
  52
  53 OUString SAL_CALL ToolbarModeMenuController::getImplementationName()
  54 {
  55     return u"com.sun.star.comp.framework.ToolbarModeMenuController"_ustr;
  56 }
  57
  58 sal_Bool SAL_CALL ToolbarModeMenuController::supportsService( const OUString& sServiceName )
  59 {
  60     return cppu::supportsService(this, sServiceName);
  61 }
  62
  63 css::uno::Sequence< OUString > SAL_CALL ToolbarModeMenuController::getSupportedServiceNames()
  64 {
  65     return { SERVICENAME_POPUPMENUCONTROLLER };
  66 }
  67
  68
  69 ToolbarModeMenuController::ToolbarModeMenuController( const css::uno::Reference< css::uno::XComponentContext >& xContext ) :
  70     svt::PopupMenuControllerBase( xContext ),
  71     m_xContext( xContext )
  72 {
  73 }
  74
  75 ToolbarModeMenuController::~ToolbarModeMenuController()
  76 {
  77 }
  78
  79 void ToolbarModeMenuController::fillPopupMenu( Reference< css::awt::XPopupMenu > const & rPopupMenu )
  80 {
  81     if ( officecfg::Office::Common::Misc::DisableUICustomization::get() )
  82         return;
  83
  84     SolarMutexGuard aSolarMutexGuard;
  85     resetPopupMenu( rPopupMenu );
  86
  87     const Reference<XComponentContext>& xContext (::comphelper::getProcessComponentContext() );
  88     const Reference<frame::XModuleManager> xModuleManager  = frame::ModuleManager::create( xContext );
  89     vcl::EnumContext::Application eApp = vcl::EnumContext::GetApplicationEnum(xModuleManager->identify(m_xFrame));
  90
  91     OUStringBuffer aPath("org.openoffice.Office.UI.ToolbarMode/Applications/");
  92     switch ( eApp )
  93     {
  94         case vcl::EnumContext::Application::Writer:
  95             aPath.append("Writer");
  96             break;
  97         case vcl::EnumContext::Application::Calc:
  98             aPath.append("Calc");
  99             break;
 100         case vcl::EnumContext::Application::Impress:
 101             aPath.append("Impress");
 102             break;
 103         case vcl::EnumContext::Application::Draw:
 104             aPath.append("Draw");
 105             break;
 106         case vcl::EnumContext::Application::Formula:
 107             aPath.append("Formula");
 108             break;
 109         case vcl::EnumContext::Application::Base:
 110             aPath.append("Base");
 111             break;
 112         default:
 113             break;
 114     }
 115     aPath.append("/Modes");
 116
 117     const utl::OConfigurationTreeRoot aModesNode(
 118                                         m_xContext,
 119                                         aPath.makeStringAndClear(),
 120                                         false);
 121     if ( !aModesNode.isValid() )
 122         return;
 123
 124     const Sequence<OUString> aModeNodeNames (aModesNode.getNodeNames());
 125     const sal_Int32 nCount(aModeNodeNames.getLength());
 126     tools::Long nCountToolbar = 0;
 127
 128     for ( sal_Int32 nReadIndex = 0; nReadIndex < nCount; ++nReadIndex )
 129     {
 130         const utl::OConfigurationNode aModeNode(aModesNode.openNode(aModeNodeNames[nReadIndex]));
 131         if ( !aModeNode.isValid() )
 132             continue;
 133
 134         OUString aLabel = comphelper::getString( aModeNode.getNodeValue( u"Label"_ustr ) );
 135         OUString aCommandArg = comphelper::getString( aModeNode.getNodeValue( u"CommandArg"_ustr ) );
 136         tools::Long nPosition = comphelper::getINT32( aModeNode.getNodeValue( u"MenuPosition"_ustr ) );
 137         bool isExperimental = comphelper::getBOOL( aModeNode.getNodeValue( u"IsExperimental"_ustr ) );
 138         bool hasNotebookbar = comphelper::getBOOL( aModeNode.getNodeValue( u"HasNotebookbar"_ustr ) );
 139
 140         // Allow Notebookbar only in experimental mode
 141         if ( isExperimental && !officecfg::Office::Common::Misc::ExperimentalMode::get() )
 142             continue;
 143         if (!hasNotebookbar)
 144             nCountToolbar++;
 145
 146         m_xPopupMenu->insertItem( nReadIndex+1, aLabel, css::awt::MenuItemStyle::RADIOCHECK, nPosition );
 147         rPopupMenu->setCommand( nReadIndex+1, aCommandArg );
 148     }
 149     rPopupMenu->insertSeparator(nCountToolbar);
 150 }
 151
 152 // XEventListener
 153 void SAL_CALL ToolbarModeMenuController::disposing( const EventObject& )
 154 {
 155     Reference< css::awt::XMenuListener > xHolder(this);
 156
 157     std::unique_lock aLock( m_aMutex );
 158     m_xFrame.clear();
 159     m_xDispatch.clear();
 160
 161     if ( m_xPopupMenu.is() )
 162         m_xPopupMenu->removeMenuListener( Reference< css::awt::XMenuListener >(this) );
 163     m_xPopupMenu.clear();
 164 }
 165
 166 // XStatusListener
 167 void SAL_CALL ToolbarModeMenuController::statusChanged( const FeatureStateEvent& Event )
 168 {
 169     OUString aFeatureURL( Event.FeatureURL.Complete );
 170
 171     // All other status events will be processed here
 172     std::unique_lock aLock( m_aMutex );
 173     Reference< css::awt::XPopupMenu > xPopupMenu( m_xPopupMenu );
 174     aLock.unlock();
 175
 176     if ( !xPopupMenu.is() )
 177         return;
 178
 179     SolarMutexGuard aGuard;
 180
 181     bool bSetCheckmark      = false;
 182     bool bCheckmark         = false;
 183     for (sal_Int16 i = 0, nCount = xPopupMenu->getItemCount(); i < nCount; ++i)
 184     {
 185         sal_Int16 nId = xPopupMenu->getItemId(i);
 186         if ( nId == 0 )
 187             continue;
 188
 189         OUString aCmd = xPopupMenu->getCommand(nId);
 190         if ( aCmd == aFeatureURL )
 191         {
 192             // Enable/disable item
 193             xPopupMenu->enableItem(nId, Event.IsEnabled);
 194
 195             // Checkmark
 196             if ( Event.State >>= bCheckmark )
 197                 bSetCheckmark = true;
 198
 199             if ( bSetCheckmark )
 200                 xPopupMenu->checkItem(nId, bCheckmark);
 201             else
 202             {
 203                 OUString aItemText;
 204
 205                 if ( Event.State >>= aItemText )
 206                     xPopupMenu->setItemText(nId, aItemText);
 207             }
 208         }
 209     }
 210 }
 211
 212 // XMenuListener
 213 void SAL_CALL ToolbarModeMenuController::itemSelected( const css::awt::MenuEvent& rEvent )
 214 {
 215     auto aArgs(comphelper::InitPropertySequence({{"Mode", Any(m_xPopupMenu->getCommand(rEvent.MenuId))}}));
 216     dispatchCommand(m_aCommandURL, aArgs);
 217 }
 218
 219 void SAL_CALL ToolbarModeMenuController::itemActivated( const css::awt::MenuEvent& )
 220 {
 221     const Reference<frame::XModuleManager> xModuleManager  = frame::ModuleManager::create( m_xContext );
 222     vcl::EnumContext::Application eApp = vcl::EnumContext::GetApplicationEnum(xModuleManager->identify(m_xFrame));
 223
 224     OUStringBuffer aPath("org.openoffice.Office.UI.ToolbarMode/Applications/");
 225     switch ( eApp )
 226     {
 227         case vcl::EnumContext::Application::Writer:
 228             aPath.append("Writer");
 229             break;
 230         case vcl::EnumContext::Application::Calc:
 231             aPath.append("Calc");
 232             break;
 233         case vcl::EnumContext::Application::Impress:
 234             aPath.append("Impress");
 235             break;
 236         case vcl::EnumContext::Application::Draw:
 237             aPath.append("Draw");
 238             break;
 239         case vcl::EnumContext::Application::Formula:
 240             aPath.append("Formula");
 241             break;
 242         case vcl::EnumContext::Application::Base:
 243             aPath.append("Base");
 244             break;
 245         default:
 246             break;
 247     }
 248
 249     const utl::OConfigurationTreeRoot aModesNode(
 250                                         m_xContext,
 251                                         aPath.makeStringAndClear(),
 252                                         false);
 253     if ( !aModesNode.isValid() )
 254         return;
 255
 256     OUString aMode = comphelper::getString( aModesNode.getNodeValue( u"Active"_ustr ) );
 257
 258     for ( int i = 0; i < m_xPopupMenu->getItemCount(); ++i )
 259     {
 260         sal_Int16 nItemId(m_xPopupMenu->getItemId(i));
 261         m_xPopupMenu->checkItem(nItemId, aMode == m_xPopupMenu->getCommand(nItemId));
 262     }
 263 }
 264
 265 // XPopupMenuController
 266 void SAL_CALL ToolbarModeMenuController::setPopupMenu( const Reference< css::awt::XPopupMenu >& xPopupMenu )
 267 {
 268     std::unique_lock aLock( m_aMutex );
 269
 270     throwIfDisposed(aLock);
 271
 272     if ( m_xFrame.is() && !m_xPopupMenu.is() )
 273     {
 274         // Create popup menu on demand
 275         SolarMutexGuard aSolarMutexGuard;
 276
 277         m_xPopupMenu = dynamic_cast<VCLXPopupMenu*>(xPopupMenu.get());
 278         assert(bool(xPopupMenu) == bool(m_xPopupMenu) && "we only support VCLXPopupMenu");
 279         m_xPopupMenu->addMenuListener( Reference< css::awt::XMenuListener >(this) );
 280         fillPopupMenu( m_xPopupMenu );
 281     }
 282 }
 283
 284 }
 285
 286 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
 287 framework_ToolbarModeMenuController_get_implementation(
 288     css::uno::XComponentContext* context, css::uno::Sequence<css::uno::Any> const& )
 289 {
 290     return cppu::acquire(new framework::ToolbarModeMenuController(context));
 291 }
 292
 293 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */