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