framework/source/uielement/langselectionmenucontroller.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/langselectionmenucontroller.hxx>
  21
  22 #include <services.h>
  23
  24 #include <com/sun/star/awt/MenuItemStyle.hpp>
  25 #include <com/sun/star/frame/XDispatchProvider.hpp>
  26 #include <com/sun/star/util/XURLTransformer.hpp>
  27
  28 #include <vcl/svapp.hxx>
  29
  30 #include <svl/languageoptions.hxx>
  31 #include <svtools/langtab.hxx>
  32 #include <classes/fwkresid.hxx>
  33
  34 #include <strings.hrc>
  35
  36 #include <helper/mischelper.hxx>
  37 #include <osl/mutex.hxx>
  38 #include <cppuhelper/supportsservice.hxx>
  39
  40 #include <map>
  41 #include <set>
  42
  43 //  Defines
  44
  45 using namespace ::com::sun::star;
  46 using namespace com::sun::star::uno;
  47 using namespace com::sun::star::lang;
  48 using namespace com::sun::star::frame;
  49 using namespace com::sun::star::beans;
  50 using namespace com::sun::star::util;
  51
  52 namespace framework
  53 {
  54
  55 // XInterface, XTypeProvider, XServiceInfo
  56
  57 OUString SAL_CALL LanguageSelectionMenuController::getImplementationName()
  58 {
  59     return "com.sun.star.comp.framework.LanguageSelectionMenuController";
  60 }
  61
  62 sal_Bool SAL_CALL LanguageSelectionMenuController::supportsService( const OUString& sServiceName )
  63 {
  64     return cppu::supportsService(this, sServiceName);
  65 }
  66
  67 css::uno::Sequence< OUString > SAL_CALL LanguageSelectionMenuController::getSupportedServiceNames()
  68 {
  69     return { SERVICENAME_POPUPMENUCONTROLLER };
  70 }
  71
  72
  73 LanguageSelectionMenuController::LanguageSelectionMenuController( const css::uno::Reference< css::uno::XComponentContext >& xContext )
  74     : svt::PopupMenuControllerBase(xContext)
  75     , m_bShowMenu(true)
  76     , m_nScriptType(SvtScriptType::LATIN | SvtScriptType::ASIAN | SvtScriptType::COMPLEX)
  77     , m_aLangGuessHelper(xContext)
  78 {
  79 }
  80
  81 LanguageSelectionMenuController::~LanguageSelectionMenuController()
  82 {
  83 }
  84
  85 // XEventListener
  86 void SAL_CALL LanguageSelectionMenuController::disposing( const EventObject& )
  87 {
  88     Reference< css::awt::XMenuListener > xHolder(this);
  89
  90     osl::MutexGuard aLock( m_aMutex );
  91     m_xFrame.clear();
  92     m_xDispatch.clear();
  93     m_xLanguageDispatch.clear();
  94
  95     if ( m_xPopupMenu.is() )
  96         m_xPopupMenu->removeMenuListener( Reference< css::awt::XMenuListener >(this) );
  97     m_xPopupMenu.clear();
  98 }
  99
 100 // XStatusListener
 101 void SAL_CALL LanguageSelectionMenuController::statusChanged( const FeatureStateEvent& Event )
 102 {
 103     SolarMutexGuard aSolarMutexGuard;
 104
 105     if (rBHelper.bDisposed || rBHelper.bInDispose)
 106         return;
 107
 108     m_bShowMenu = true;
 109     m_nScriptType = SvtScriptType::LATIN | SvtScriptType::ASIAN | SvtScriptType::COMPLEX;  //set the default value
 110
 111     Sequence< OUString > aSeq;
 112
 113     if ( Event.State >>= aSeq )
 114     {
 115         if ( aSeq.getLength() == 4 )
 116         {
 117             // Retrieve all other values from the sequence and
 118             // store it members!
 119             m_aCurLang          = aSeq[0];
 120             m_nScriptType       = static_cast< SvtScriptType >(aSeq[1].toInt32());
 121             m_aKeyboardLang     = aSeq[2];
 122             m_aGuessedTextLang  = aSeq[3];
 123         }
 124     }
 125     else if ( !Event.State.hasValue() )
 126     {
 127         m_bShowMenu = false;    // no language -> no sub-menu entries -> disable menu
 128     }
 129 }
 130
 131 // XPopupMenuController
 132 void LanguageSelectionMenuController::impl_setPopupMenu()
 133 {
 134     Reference< XDispatchProvider > xDispatchProvider( m_xFrame, UNO_QUERY );
 135
 136     css::util::URL aTargetURL;
 137
 138     // Register for language updates
 139     aTargetURL.Complete = m_aLangStatusCommandURL;
 140     m_xURLTransformer->parseStrict( aTargetURL );
 141     m_xLanguageDispatch = xDispatchProvider->queryDispatch( aTargetURL, OUString(), 0 );
 142
 143     // Register for setting languages and opening language dialog
 144     aTargetURL.Complete = m_aMenuCommandURL_Lang;
 145     m_xURLTransformer->parseStrict( aTargetURL );
 146     m_xMenuDispatch_Lang = xDispatchProvider->queryDispatch( aTargetURL, OUString(), 0 );
 147
 148     // Register for opening character dialog
 149     aTargetURL.Complete = m_aMenuCommandURL_Font;
 150     m_xURLTransformer->parseStrict( aTargetURL );
 151     m_xMenuDispatch_Font = xDispatchProvider->queryDispatch( aTargetURL, OUString(), 0 );
 152
 153     // Register for opening character dialog with preselected paragraph
 154     aTargetURL.Complete = m_aMenuCommandURL_CharDlgForParagraph;
 155     m_xURLTransformer->parseStrict( aTargetURL );
 156     m_xMenuDispatch_CharDlgForParagraph = xDispatchProvider->queryDispatch( aTargetURL, OUString(), 0 );
 157 }
 158
 159 void LanguageSelectionMenuController::fillPopupMenu( Reference< css::awt::XPopupMenu > const & rPopupMenu , const Mode eMode )
 160 {
 161     SolarMutexGuard aSolarMutexGuard;
 162
 163     resetPopupMenu( rPopupMenu );
 164     if (!m_bShowMenu)
 165         return;
 166
 167     OUString aCmd_Dialog;
 168     OUString aCmd_Language;
 169     if( eMode == MODE_SetLanguageSelectionMenu )
 170     {
 171         aCmd_Dialog += ".uno:FontDialog?Page:string=font";
 172         aCmd_Language += ".uno:LanguageStatus?Language:string=Current_";
 173     }
 174     else if ( eMode == MODE_SetLanguageParagraphMenu )
 175     {
 176         aCmd_Dialog += ".uno:FontDialogForParagraph";
 177         aCmd_Language += ".uno:LanguageStatus?Language:string=Paragraph_";
 178     }
 179     else if ( eMode == MODE_SetLanguageAllTextMenu )
 180     {
 181         aCmd_Dialog += ".uno:LanguageStatus?Language:string=*";
 182         aCmd_Language += ".uno:LanguageStatus?Language:string=Default_";
 183     }
 184
 185     // get languages to be displayed in the menu
 186     std::set< OUString > aLangItems;
 187     FillLangItems( aLangItems, m_xFrame, m_aLangGuessHelper,
 188             m_nScriptType, m_aCurLang, m_aKeyboardLang, m_aGuessedTextLang );
 189
 190     // now add menu entries
 191     // the different menus purpose will be handled by the different string
 192     // for aCmd_Dialog and aCmd_Language
 193     sal_Int16 nItemId = 0;  // in this control the item id is not important for executing the command
 194     static const OUStringLiteral sAsterisk(u"*");  // multiple languages in current selection
 195     const OUString sNone( SvtLanguageTable::GetLanguageString( LANGUAGE_NONE ));
 196     for (auto const& langItem : aLangItems)
 197     {
 198         if (langItem != sNone &&
 199             langItem != sAsterisk &&
 200             !langItem.isEmpty()) // 'no language found' from language guessing
 201         {
 202             ++nItemId;
 203             rPopupMenu->insertItem(nItemId, langItem, css::awt::MenuItemStyle::CHECKABLE, nItemId - 1);
 204             OUString aCmd = aCmd_Language + langItem;
 205             rPopupMenu->setCommand(nItemId, aCmd);
 206             bool bChecked = langItem == m_aCurLang && eMode == MODE_SetLanguageSelectionMenu;
 207             //make a sign for the current language
 208             rPopupMenu->checkItem(nItemId, bChecked);
 209         }
 210     }
 211
 212     // entry for LANGUAGE_NONE
 213     ++nItemId;
 214     rPopupMenu->insertItem(nItemId, FwkResId(STR_LANGSTATUS_NONE), 0, nItemId - 1);
 215     OUString aCmd = aCmd_Language + "LANGUAGE_NONE";
 216     rPopupMenu->setCommand(nItemId, aCmd);
 217
 218     // entry for 'Reset to default language'
 219     ++nItemId;
 220     rPopupMenu->insertItem(nItemId, FwkResId(STR_RESET_TO_DEFAULT_LANGUAGE), 0, nItemId - 1);
 221     aCmd = aCmd_Language + "RESET_LANGUAGES";
 222     rPopupMenu->setCommand(nItemId, aCmd);
 223
 224     // entry for opening the Format/Character dialog
 225     ++nItemId;
 226     rPopupMenu->insertItem(nItemId, FwkResId(STR_LANGSTATUS_MORE), 0, nItemId - 1);
 227     rPopupMenu->setCommand(nItemId, aCmd_Dialog);
 228 }
 229
 230 void SAL_CALL LanguageSelectionMenuController::updatePopupMenu()
 231 {
 232     svt::PopupMenuControllerBase::updatePopupMenu();
 233
 234     // Force status update to get information about the current languages
 235     osl::ClearableMutexGuard aLock( m_aMutex );
 236     Reference< XDispatch > xDispatch( m_xLanguageDispatch );
 237     css::util::URL aTargetURL;
 238     aTargetURL.Complete = m_aLangStatusCommandURL;
 239     m_xURLTransformer->parseStrict( aTargetURL );
 240     aLock.clear();
 241
 242     if ( xDispatch.is() )
 243     {
 244         xDispatch->addStatusListener( static_cast< XStatusListener* >(this), aTargetURL );
 245         xDispatch->removeStatusListener( static_cast< XStatusListener* >(this), aTargetURL );
 246     }
 247
 248     // TODO: Fill menu with the information retrieved by the status update
 249
 250     if ( m_aCommandURL == ".uno:SetLanguageSelectionMenu" )
 251     {
 252         fillPopupMenu(m_xPopupMenu, MODE_SetLanguageSelectionMenu );
 253     }
 254     else if ( m_aCommandURL == ".uno:SetLanguageParagraphMenu" )
 255     {
 256         fillPopupMenu(m_xPopupMenu, MODE_SetLanguageParagraphMenu );
 257     }
 258     else if ( m_aCommandURL == ".uno:SetLanguageAllTextMenu" )
 259     {
 260         fillPopupMenu(m_xPopupMenu, MODE_SetLanguageAllTextMenu );
 261     }
 262 }
 263
 264 // XInitialization
 265 void SAL_CALL LanguageSelectionMenuController::initialize( const Sequence< Any >& aArguments )
 266 {
 267     osl::MutexGuard aLock( m_aMutex );
 268
 269     bool bInitialized( m_bInitialized );
 270     if ( !bInitialized )
 271     {
 272         svt::PopupMenuControllerBase::initialize(aArguments);
 273
 274         if ( m_bInitialized )
 275         {
 276             m_aLangStatusCommandURL               = ".uno:LanguageStatus";
 277             m_aMenuCommandURL_Lang                = m_aLangStatusCommandURL;
 278             m_aMenuCommandURL_Font                = ".uno:FontDialog";
 279             m_aMenuCommandURL_CharDlgForParagraph = ".uno:FontDialogForParagraph";
 280         }
 281     }
 282 }
 283
 284 }
 285
 286 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
 287 framework_LanguageSelectionMenuController_get_implementation(
 288     css::uno::XComponentContext* context, css::uno::Sequence<css::uno::Any> const& )
 289 {
 290     return cppu::acquire(new framework::LanguageSelectionMenuController(context));
 291 }
 292
 293
 294 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */