basctl/source/basicide/IDEComboBox.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 <strings.hrc>
  21 #include <basidesh.hxx>
  22 #include <basobj.hxx>
  23 #include <IDEComboBox.hxx>
  24 #include <iderdll.hxx>
  25 #include <iderid.hxx>
  26 #include <localizationmgr.hxx>
  27 #include <managelang.hxx>
  28
  29 #include <sfx2/dispatch.hxx>
  30 #include <sfx2/frame.hxx>
  31 #include <sfx2/sfxsids.hrc>
  32 #include <svtools/langtab.hxx>
  33 #include <tools/debug.hxx>
  34 #include <vcl/svapp.hxx>
  35 #include <vcl/toolbox.hxx>
  36 #include <vcl/event.hxx>
  37
  38 namespace basctl
  39 {
  40 using namespace ::com::sun::star;
  41 using namespace ::com::sun::star::lang;
  42 using namespace ::com::sun::star::uno;
  43
  44 /*! Macro for implementation two methods for LibBoxControl Class
  45  *
  46  * @code
  47  * SfxToolBoxControl* LibBoxControl::CreateImpl(sal_uInt16 nSlotId, sal_uInt16 nId, ToolBox& rTbx)
  48  * {
  49  *      return new LibBoxControl(nSlotId, nId, rTbx);
  50  * }
  51  *
  52  * void LibBoxControl::RegisterControl(sal_uInt16 nSlotId, SfxModule* pMod)
  53  * {
  54  *      SfxToolBoxControl::RegisterToolBoxControl(
  55  *          pMod, SfxTbxCtrlFactory(* LibBoxControl::CreateImpl, typeid(nItemClass), nSlotId));
  56  * }
  57  * @endcode
  58  * @see Macro SFX_DECL_TOOLBOX_CONTROL
  59  */
  60 SFX_IMPL_TOOLBOX_CONTROL(LibBoxControl, SfxStringItem);
  61
  62 LibBoxControl::LibBoxControl(sal_uInt16 nSlotId, sal_uInt16 nId, ToolBox& rTbx)
  63     : SfxToolBoxControl(nSlotId, nId, rTbx)
  64 {
  65 }
  66
  67 void LibBoxControl::StateChanged(sal_uInt16, SfxItemState eState, const SfxPoolItem* pState)
  68 {
  69     LibBox* pBox = static_cast<LibBox*>(GetToolBox().GetItemWindow(GetId()));
  70
  71     DBG_ASSERT(pBox, "Box not found");
  72     if (!pBox)
  73         return;
  74
  75     if (eState != SfxItemState::DEFAULT)
  76         pBox->set_sensitive(false);
  77     else
  78     {
  79         pBox->set_sensitive(true);
  80         pBox->Update(dynamic_cast<SfxStringItem const*>(pState));
  81     }
  82 }
  83
  84 VclPtr<InterimItemWindow> LibBoxControl::CreateItemWindow(vcl::Window* pParent)
  85 {
  86     return VclPtr<LibBox>::Create(pParent);
  87 }
  88
  89 DocListenerBox::DocListenerBox(vcl::Window* pParent)
  90     : InterimItemWindow(pParent, "modules/BasicIDE/ui/combobox.ui", "ComboBox")
  91     , m_xWidget(m_xBuilder->weld_combo_box("combobox"))
  92     , maNotifier(*this)
  93 {
  94     InitControlBase(m_xWidget.get());
  95
  96     m_xWidget->connect_changed(LINK(this, DocListenerBox, SelectHdl));
  97     m_xWidget->connect_key_press(LINK(this, DocListenerBox, KeyInputHdl));
  98 }
  99
 100 void DocListenerBox::set_sensitive(bool bSensitive)
 101 {
 102     Enable(bSensitive);
 103     m_xWidget->set_sensitive(bSensitive);
 104 }
 105
 106 IMPL_LINK(DocListenerBox, KeyInputHdl, const KeyEvent&, rKEvt, bool)
 107 {
 108     return HandleKeyInput(rKEvt);
 109 }
 110
 111 bool DocListenerBox::HandleKeyInput(const KeyEvent& rKEvt) { return ChildKeyInput(rKEvt); }
 112
 113 IMPL_LINK_NOARG(DocListenerBox, SelectHdl, weld::ComboBox&, void) { Select(); }
 114
 115 DocListenerBox::~DocListenerBox() { disposeOnce(); }
 116
 117 void DocListenerBox::dispose()
 118 {
 119     maNotifier.dispose();
 120     m_xWidget.reset();
 121     InterimItemWindow::dispose();
 122 }
 123
 124 /// Only calls FillBox(). Parameter is not used.
 125 void DocListenerBox::onDocumentCreated(const ScriptDocument& /*_rDoc*/) { FillBox(); }
 126
 127 /// Only calls FillBox(). Parameter is not used.
 128 void DocListenerBox::onDocumentOpened(const ScriptDocument& /*_rDoc*/) { FillBox(); }
 129
 130 /// Only calls FillBox(). Parameter is not used.
 131 void DocListenerBox::onDocumentSaveAsDone(const ScriptDocument& /*_rDoc*/) { FillBox(); }
 132
 133 /// Only calls FillBox(). Parameter is not used.
 134 void DocListenerBox::onDocumentClosed(const ScriptDocument& /*_rDoc*/) { FillBox(); }
 135
 136 /// Not interested in. Do nothing.
 137 void DocListenerBox::onDocumentSave(const ScriptDocument& /*_rDoc*/) {}
 138
 139 /// Not interested in. Do nothing.
 140 void DocListenerBox::onDocumentSaveDone(const ScriptDocument& /*_rDoc*/) {}
 141
 142 /// Not interested in. Do nothing.
 143 void DocListenerBox::onDocumentSaveAs(const ScriptDocument& /*_rDoc*/) {}
 144
 145 /// Not interested in. Do nothing.
 146 void DocListenerBox::onDocumentTitleChanged(const ScriptDocument& /*_rDoc*/) {}
 147
 148 /// Not interested in. Do nothing.
 149 void DocListenerBox::onDocumentModeChanged(const ScriptDocument& /*_rDoc*/) {}
 150
 151 LibBox::LibBox(vcl::Window* pParent)
 152     : DocListenerBox(pParent)
 153 {
 154     FillBox();
 155     mbIgnoreSelect = true; // do not yet transfer select of 0
 156     mbFillBox = true;
 157     m_xWidget->set_active(0);
 158     maCurrentText = m_xWidget->get_text(0);
 159     mbIgnoreSelect = false;
 160
 161     m_xWidget->connect_focus_in(LINK(this, LibBox, FocusInHdl));
 162     m_xWidget->connect_focus_out(LINK(this, LibBox, FocusOutHdl));
 163
 164     SetSizePixel(m_xWidget->get_preferred_size());
 165 }
 166
 167 LibBox::~LibBox() { disposeOnce(); }
 168
 169 void LibBox::dispose()
 170 {
 171     ClearBox();
 172     DocListenerBox::dispose();
 173 }
 174
 175 void LibBox::Update(const SfxStringItem* pItem)
 176 {
 177     //  if ( !pItem  || !pItem->GetValue().Len() )
 178     FillBox();
 179
 180     if (pItem)
 181     {
 182         maCurrentText = pItem->GetValue();
 183         if (maCurrentText.isEmpty())
 184             maCurrentText = IDEResId(RID_STR_ALL);
 185     }
 186
 187     if (m_xWidget->get_active_text() != maCurrentText)
 188         m_xWidget->set_active_text(maCurrentText);
 189 }
 190
 191 void LibBox::ReleaseFocus()
 192 {
 193     SfxViewShell* pCurSh = SfxViewShell::Current();
 194     DBG_ASSERT(pCurSh, "Current ViewShell not found!");
 195
 196     if (pCurSh)
 197     {
 198         vcl::Window* pShellWin = pCurSh->GetWindow();
 199         if (!pShellWin)
 200             pShellWin = Application::GetDefDialogParent();
 201
 202         pShellWin->GrabFocus();
 203     }
 204 }
 205
 206 void LibBox::FillBox()
 207 {
 208     m_xWidget->freeze();
 209     mbIgnoreSelect = true;
 210
 211     maCurrentText = m_xWidget->get_active_text();
 212
 213     ClearBox();
 214
 215     // create list box entries
 216     LibEntry* pEntry = new LibEntry(ScriptDocument::getApplicationScriptDocument(),
 217                                     LIBRARY_LOCATION_UNKNOWN, OUString());
 218     OUString sId(OUString::number(reinterpret_cast<sal_Int64>(pEntry)));
 219     m_xWidget->append(sId, IDEResId(RID_STR_ALL));
 220
 221     InsertEntries(ScriptDocument::getApplicationScriptDocument(), LIBRARY_LOCATION_USER);
 222     InsertEntries(ScriptDocument::getApplicationScriptDocument(), LIBRARY_LOCATION_SHARE);
 223
 224     ScriptDocuments aDocuments(
 225         ScriptDocument::getAllScriptDocuments(ScriptDocument::DocumentsSorted));
 226     for (auto const& doc : aDocuments)
 227     {
 228         InsertEntries(doc, LIBRARY_LOCATION_DOCUMENT);
 229     }
 230
 231     m_xWidget->thaw();
 232
 233     int nIndex = m_xWidget->find_text(maCurrentText);
 234     if (nIndex != -1)
 235         m_xWidget->set_active(nIndex);
 236     else
 237         m_xWidget->set_active(0);
 238     maCurrentText = m_xWidget->get_active_text();
 239     mbIgnoreSelect = false;
 240 }
 241
 242 void LibBox::InsertEntries(const ScriptDocument& rDocument, LibraryLocation eLocation)
 243 {
 244     // get a sorted list of library names
 245     Sequence<OUString> aLibNames = rDocument.getLibraryNames();
 246     sal_Int32 nLibCount = aLibNames.getLength();
 247     const OUString* pLibNames = aLibNames.getConstArray();
 248
 249     for (sal_Int32 i = 0; i < nLibCount; ++i)
 250     {
 251         OUString aLibName = pLibNames[i];
 252         if (eLocation == rDocument.getLibraryLocation(aLibName))
 253         {
 254             OUString aName(rDocument.getTitle(eLocation));
 255             OUString aEntryText(CreateMgrAndLibStr(aName, aLibName));
 256             LibEntry* pEntry = new LibEntry(rDocument, eLocation, aLibName);
 257             m_xWidget->append(OUString::number(reinterpret_cast<sal_Int64>(pEntry)), aEntryText);
 258         }
 259     }
 260 }
 261
 262 bool LibBox::HandleKeyInput(const KeyEvent& rKEvt)
 263 {
 264     bool bDone = false;
 265
 266     sal_uInt16 nKeyCode = rKEvt.GetKeyCode().GetCode();
 267     switch (nKeyCode)
 268     {
 269         case KEY_RETURN:
 270         {
 271             NotifyIDE();
 272             bDone = true;
 273         }
 274         break;
 275         case KEY_ESCAPE:
 276         {
 277             m_xWidget->set_active_text(maCurrentText);
 278             ReleaseFocus();
 279             bDone = true;
 280         }
 281         break;
 282     }
 283
 284     return bDone || DocListenerBox::HandleKeyInput(rKEvt);
 285 }
 286
 287 IMPL_LINK_NOARG(LibBox, FocusInHdl, weld::Widget&, void)
 288 {
 289     if (mbFillBox)
 290     {
 291         FillBox();
 292         mbFillBox = false;
 293     }
 294 }
 295
 296 IMPL_LINK_NOARG(LibBox, FocusOutHdl, weld::Widget&, void)
 297 {
 298     // comboboxes can be comprised of multiple widgets, ensure all have lost focus
 299     if (m_xWidget && !m_xWidget->has_focus())
 300         mbFillBox = true;
 301 }
 302
 303 void LibBox::Select()
 304 {
 305     if (m_xWidget->changed_by_direct_pick())
 306     {
 307         if (!mbIgnoreSelect)
 308             NotifyIDE();
 309         else
 310             m_xWidget->set_active_text(maCurrentText); // (Select after Escape)
 311     }
 312 }
 313
 314 void LibBox::NotifyIDE()
 315 {
 316     LibEntry* pEntry = reinterpret_cast<LibEntry*>(m_xWidget->get_active_id().toInt64());
 317     if (pEntry)
 318     {
 319         const ScriptDocument& aDocument(pEntry->GetDocument());
 320         SfxUnoAnyItem aDocumentItem(SID_BASICIDE_ARG_DOCUMENT_MODEL,
 321                                     uno::Any(aDocument.getDocumentOrNull()));
 322         const OUString& aLibName = pEntry->GetLibName();
 323         SfxStringItem aLibNameItem(SID_BASICIDE_ARG_LIBNAME, aLibName);
 324         if (SfxDispatcher* pDispatcher = GetDispatcher())
 325             pDispatcher->ExecuteList(SID_BASICIDE_LIBSELECTED, SfxCallMode::SYNCHRON,
 326                                      { &aDocumentItem, &aLibNameItem });
 327     }
 328     ReleaseFocus();
 329 }
 330
 331 void LibBox::ClearBox()
 332 {
 333     sal_Int32 nCount = m_xWidget->get_count();
 334     for (sal_Int32 i = 0; i < nCount; ++i)
 335     {
 336         LibEntry* pEntry = reinterpret_cast<LibEntry*>(m_xWidget->get_id(i).toInt64());
 337         delete pEntry;
 338     }
 339     m_xWidget->clear();
 340 }
 341
 342 // class LanguageBoxControl ----------------------------------------------
 343
 344 /*! Macro for implementation two methods for LanguageBoxControl Class
 345  *
 346  * @code
 347  * SfxToolBoxControl* LanguageBoxControl::CreateImpl(sal_uInt16 nSlotId, sal_uInt16 nId, ToolBox& rTbx)
 348  * {
 349  *      return new LanguageBoxControl(nSlotId, nId, rTbx);
 350  * }
 351  *
 352  * void LanguageBoxControl::RegisterControl(sal_uInt16 nSlotId, SfxModule* pMod)
 353  * {
 354  *      SfxToolBoxControl::RegisterToolBoxControl(
 355  *          pMod, SfxTbxCtrlFactory(* LanguageBoxControl::CreateImpl, typeid(nItemClass), nSlotId));
 356  * }
 357  * @endcode
 358  * @see Macro SFX_DECL_TOOLBOX_CONTROL
 359  */
 360 SFX_IMPL_TOOLBOX_CONTROL(LanguageBoxControl, SfxStringItem);
 361
 362 LanguageBoxControl::LanguageBoxControl(sal_uInt16 nSlotId, sal_uInt16 nId, ToolBox& rTbx)
 363     : SfxToolBoxControl(nSlotId, nId, rTbx)
 364 {
 365 }
 366
 367 void LanguageBoxControl::StateChanged(sal_uInt16, SfxItemState eState, const SfxPoolItem* pItem)
 368 {
 369     if (LanguageBox* pBox = static_cast<LanguageBox*>(GetToolBox().GetItemWindow(GetId())))
 370     {
 371         if (eState != SfxItemState::DEFAULT)
 372             pBox->set_sensitive(false);
 373         else
 374         {
 375             pBox->set_sensitive(true);
 376             pBox->Update(dynamic_cast<SfxStringItem const*>(pItem));
 377         }
 378     }
 379 }
 380
 381 VclPtr<InterimItemWindow> LanguageBoxControl::CreateItemWindow(vcl::Window* pParent)
 382 {
 383     return VclPtr<LanguageBox>::Create(pParent);
 384 }
 385
 386 // class basctl::LanguageBox -----------------------------------------------
 387 LanguageBox::LanguageBox(vcl::Window* pParent)
 388     : DocListenerBox(pParent)
 389     , msNotLocalizedStr(IDEResId(RID_STR_TRANSLATION_NOTLOCALIZED))
 390     , msDefaultLanguageStr(IDEResId(RID_STR_TRANSLATION_DEFAULT))
 391     , mbIgnoreSelect(false)
 392 {
 393     FillBox();
 394
 395     SetSizePixel(m_xWidget->get_preferred_size());
 396 }
 397
 398 LanguageBox::~LanguageBox() { disposeOnce(); }
 399
 400 void LanguageBox::dispose()
 401 {
 402     ClearBox();
 403     DocListenerBox::dispose();
 404 }
 405
 406 void LanguageBox::FillBox()
 407 {
 408     m_xWidget->freeze();
 409     mbIgnoreSelect = true;
 410     msCurrentText = m_xWidget->get_active_text();
 411     ClearBox();
 412
 413     sal_Int32 nSelPos = -1;
 414
 415     std::shared_ptr<LocalizationMgr> pCurMgr(GetShell()->GetCurLocalizationMgr());
 416     if (pCurMgr->isLibraryLocalized())
 417     {
 418         set_sensitive(true);
 419         Locale aDefaultLocale = pCurMgr->getStringResourceManager()->getDefaultLocale();
 420         Locale aCurrentLocale = pCurMgr->getStringResourceManager()->getCurrentLocale();
 421         Sequence<Locale> aLocaleSeq = pCurMgr->getStringResourceManager()->getLocales();
 422         const Locale* pLocale = aLocaleSeq.getConstArray();
 423         sal_Int32 i, nCount = aLocaleSeq.getLength();
 424         for (i = 0; i < nCount; ++i)
 425         {
 426             bool bIsDefault = localesAreEqual(aDefaultLocale, pLocale[i]);
 427             bool bIsCurrent = localesAreEqual(aCurrentLocale, pLocale[i]);
 428             LanguageType eLangType = LanguageTag::convertToLanguageType(pLocale[i]);
 429             OUString sLanguage = SvtLanguageTable::GetLanguageString(eLangType);
 430             if (bIsDefault)
 431             {
 432                 sLanguage += " " + msDefaultLanguageStr;
 433             }
 434             LanguageEntry* pEntry = new LanguageEntry(pLocale[i], bIsDefault);
 435             OUString sId(OUString::number(reinterpret_cast<sal_Int64>(pEntry)));
 436             m_xWidget->append(sId, sLanguage);
 437
 438             if (bIsCurrent)
 439                 nSelPos = i;
 440         }
 441
 442         if (nSelPos != -1)
 443             msCurrentText = m_xWidget->get_text(nSelPos);
 444     }
 445     else
 446     {
 447         m_xWidget->append_text(msNotLocalizedStr);
 448         nSelPos = 0;
 449         set_sensitive(false);
 450     }
 451
 452     m_xWidget->thaw();
 453     m_xWidget->set_active(nSelPos);
 454     mbIgnoreSelect = false;
 455 }
 456
 457 void LanguageBox::ClearBox()
 458 {
 459     sal_Int32 nCount = m_xWidget->get_count();
 460     for (sal_Int32 i = 0; i < nCount; ++i)
 461     {
 462         LanguageEntry* pEntry = reinterpret_cast<LanguageEntry*>(m_xWidget->get_id(i).toInt64());
 463         delete pEntry;
 464     }
 465     m_xWidget->clear();
 466 }
 467
 468 void LanguageBox::SetLanguage()
 469 {
 470     LanguageEntry* pEntry = reinterpret_cast<LanguageEntry*>(m_xWidget->get_active_id().toInt64());
 471     if (pEntry)
 472         GetShell()->GetCurLocalizationMgr()->handleSetCurrentLocale(pEntry->m_aLocale);
 473 }
 474
 475 void LanguageBox::Select()
 476 {
 477     if (!mbIgnoreSelect)
 478         SetLanguage();
 479     else
 480         m_xWidget->set_active_text(msCurrentText); // Select after Escape
 481 }
 482
 483 bool LanguageBox::HandleKeyInput(const KeyEvent& rKEvt)
 484 {
 485     bool bDone = false;
 486
 487     sal_uInt16 nKeyCode = rKEvt.GetKeyCode().GetCode();
 488     switch (nKeyCode)
 489     {
 490         case KEY_RETURN:
 491         {
 492             SetLanguage();
 493             bDone = true;
 494         }
 495         break;
 496         case KEY_ESCAPE:
 497         {
 498             m_xWidget->set_active_text(msCurrentText);
 499             bDone = true;
 500         }
 501         break;
 502     }
 503
 504     return bDone || DocListenerBox::HandleKeyInput(rKEvt);
 505 }
 506
 507 void LanguageBox::Update(const SfxStringItem* pItem)
 508 {
 509     FillBox();
 510
 511     if (pItem && !pItem->GetValue().isEmpty())
 512     {
 513         msCurrentText = pItem->GetValue();
 514         if (m_xWidget->get_active_text() != msCurrentText)
 515             m_xWidget->set_active_text(msCurrentText);
 516     }
 517 }
 518
 519 } // namespace basctl
 520
 521 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */