cui/source/tabpages/macroass.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 <macroass.hxx>
  21
  22 #include <osl/diagnose.h>
  23 #include <basic/basmgr.hxx>
  24 #include <comphelper/string.hxx>
  25 #include <comphelper/processfactory.hxx>
  26 #include <svl/macitem.hxx>
  27 #include <svx/dialogs.hrc>
  28 #include <svx/svxids.hrc>
  29 #include <tools/debug.hxx>
  30 #include <vcl/idle.hxx>
  31 #include <cfgutil.hxx>
  32 #include <sfx2/app.hxx>
  33 #include <sfx2/evntconf.hxx>
  34 #include <sfx2/objsh.hxx>
  35 #include <headertablistbox.hxx>
  36
  37 using ::com::sun::star::uno::Reference;
  38 using ::com::sun::star::frame::XFrame;
  39
  40 class SfxMacroTabPage_Impl
  41 {
  42 public:
  43     SfxMacroTabPage_Impl();
  44
  45     OUString                               m_aStaticMacroLBLabel;
  46     std::unique_ptr<weld::Button>          m_xAssignPB;
  47     std::unique_ptr<weld::Button>          m_xDeletePB;
  48     std::unique_ptr<MacroEventListBox>     m_xEventLB;
  49     std::unique_ptr<weld::Widget>          m_xGroupFrame;
  50     std::unique_ptr<CuiConfigGroupListBox> m_xGroupLB;
  51     std::unique_ptr<weld::Frame>           m_xMacroFrame;
  52     std::unique_ptr<CuiConfigFunctionListBox> m_xMacroLB;
  53
  54     Idle                            m_aFillGroupIdle;
  55     bool                            m_bGotEvents;
  56 };
  57
  58 SfxMacroTabPage_Impl::SfxMacroTabPage_Impl()
  59     : m_bGotEvents(false)
  60 {
  61 }
  62
  63 static sal_uInt16 aPageRg[] = {
  64     SID_ATTR_MACROITEM, SID_ATTR_MACROITEM,
  65     0
  66 };
  67
  68 static OUString ConvertToUIName_Impl( SvxMacro const *pMacro )
  69 {
  70     OUString aName( pMacro->GetMacName() );
  71     if ( pMacro->GetLanguage() != "JavaScript" )
  72     {
  73         const sal_Int32 nCount = comphelper::string::getTokenCount(aName, '.');
  74         OUString aEntry = aName.getToken( nCount-1, '.' );
  75         if ( nCount > 2 )
  76         {
  77             aEntry += "(" + aName.getToken( 0, '.' ) + "." + aName.getToken( nCount-2, '.' ) + ")";
  78         }
  79         return aEntry;
  80     }
  81     else
  82         return aName;
  83 }
  84
  85 void SfxMacroTabPage::EnableButtons()
  86 {
  87     // don't do anything as long as the eventbox is empty
  88     weld::TreeView& rTreeView = mpImpl->m_xEventLB->GetListBox();
  89     int nSelected = rTreeView.get_selected_index();
  90     if (nSelected != -1)
  91     {
  92         // get bound macro
  93         const SvxMacro* pM = aTbl.Get(static_cast<SvMacroItemId>(rTreeView.get_selected_id().toInt32()));
  94         mpImpl->m_xDeletePB->set_sensitive(nullptr != pM);
  95
  96         OUString sEventMacro = rTreeView.get_text(nSelected, 1);
  97
  98         OUString sScriptURI = mpImpl->m_xMacroLB->GetSelectedScriptURI();
  99         mpImpl->m_xAssignPB->set_sensitive(!sScriptURI.equalsIgnoreAsciiCase(sEventMacro));
 100     }
 101     else
 102         mpImpl->m_xAssignPB->set_sensitive(false);
 103 }
 104
 105 SfxMacroTabPage::SfxMacroTabPage(TabPageParent pParent, const Reference< XFrame >& rxDocumentFrame, const SfxItemSet& rAttrSet )
 106     : SfxTabPage(pParent, "cui/ui/eventassignpage.ui", "EventAssignPage", &rAttrSet)
 107 {
 108     mpImpl.reset(new SfxMacroTabPage_Impl);
 109
 110     mpImpl->m_aFillGroupIdle.SetInvokeHandler( LINK( this, SfxMacroTabPage, TimeOut_Impl ) );
 111     mpImpl->m_aFillGroupIdle.SetPriority( TaskPriority::HIGHEST );
 112     mpImpl->m_aFillGroupIdle.SetDebugName( "SfxMacroTabPage m_aFillGroupIdle" );
 113
 114     mpImpl->m_xEventLB.reset(new MacroEventListBox(m_xBuilder->weld_tree_view("assignments")));
 115     mpImpl->m_xAssignPB = m_xBuilder->weld_button("assign");
 116     mpImpl->m_xDeletePB = m_xBuilder->weld_button("delete");
 117     mpImpl->m_xGroupFrame = m_xBuilder->weld_widget("groupframe");
 118     mpImpl->m_xGroupLB.reset(new CuiConfigGroupListBox(m_xBuilder->weld_tree_view("libraries")));
 119     mpImpl->m_xMacroFrame = m_xBuilder->weld_frame("macroframe");
 120     mpImpl->m_aStaticMacroLBLabel = mpImpl->m_xMacroFrame->get_label();
 121     mpImpl->m_xMacroLB.reset(new CuiConfigFunctionListBox(m_xBuilder->weld_tree_view("macros")));
 122
 123     SetFrame( rxDocumentFrame );
 124
 125     InitAndSetHandler();
 126
 127     ScriptChanged();
 128 }
 129
 130 SfxMacroTabPage::~SfxMacroTabPage()
 131 {
 132     disposeOnce();
 133 }
 134
 135 void SfxMacroTabPage::dispose()
 136 {
 137     mpImpl.reset();
 138     SfxTabPage::dispose();
 139 }
 140
 141 void SfxMacroTabPage::AddEvent(const OUString& rEventName, SvMacroItemId nEventId)
 142 {
 143     weld::TreeView& rTreeView = mpImpl->m_xEventLB->GetListBox();
 144     rTreeView.append(OUString::number(static_cast<sal_Int32>(nEventId)), rEventName);
 145
 146     // if the table is valid already
 147     SvxMacro* pM = aTbl.Get(nEventId);
 148     if (pM)
 149     {
 150         OUString sNew(ConvertToUIName_Impl(pM));
 151         rTreeView.set_text(rTreeView.n_children() - 1, sNew, 1);
 152     }
 153 }
 154
 155 void SfxMacroTabPage::ScriptChanged()
 156 {
 157     // get new areas and their functions
 158     mpImpl->m_xGroupFrame->show();
 159     mpImpl->m_xMacroFrame->show();
 160
 161     EnableButtons();
 162 }
 163
 164 bool SfxMacroTabPage::FillItemSet( SfxItemSet* rSet )
 165 {
 166     SvxMacroItem aItem( GetWhich( aPageRg[0] ) );
 167     const_cast<SvxMacroTableDtor&>(aItem.GetMacroTable()) = aTbl;
 168
 169     const SfxPoolItem* pItem;
 170     if( SfxItemState::SET != GetItemSet().GetItemState( aItem.Which(), true, &pItem )
 171         || aItem != *static_cast<const SvxMacroItem*>(pItem) )
 172     {
 173         rSet->Put( aItem );
 174         return true;
 175     }
 176     return false;
 177 }
 178
 179 void SfxMacroTabPage::LaunchFillGroup()
 180 {
 181     if (! mpImpl->m_aFillGroupIdle.IsActive() )
 182         mpImpl->m_aFillGroupIdle.Start();
 183 }
 184
 185 void SfxMacroTabPage::ActivatePage( const SfxItemSet& )
 186 {
 187     LaunchFillGroup();
 188 }
 189
 190 void SfxMacroTabPage::PageCreated(const SfxAllItemSet& aSet)
 191 {
 192     const SfxPoolItem* pEventsItem;
 193     if( !mpImpl->m_bGotEvents && SfxItemState::SET == aSet.GetItemState( SID_EVENTCONFIG, true, &pEventsItem ) )
 194     {
 195         mpImpl->m_bGotEvents = true;
 196         const SfxEventNamesList& rList = static_cast<const SfxEventNamesItem*>(pEventsItem)->GetEvents();
 197         for ( size_t nNo = 0, nCnt = rList.size(); nNo < nCnt; ++nNo )
 198         {
 199             const SfxEventName &rOwn = rList.at(nNo);
 200             AddEvent( rOwn.maUIName, rOwn.mnId );
 201         }
 202     }
 203 }
 204
 205 void SfxMacroTabPage::Reset( const SfxItemSet* rSet )
 206 {
 207     const SfxPoolItem* pItem;
 208     if( SfxItemState::SET == rSet->GetItemState( GetWhich( aPageRg[0] ), true, &pItem ))
 209         aTbl = static_cast<const SvxMacroItem*>(pItem)->GetMacroTable();
 210
 211     const SfxPoolItem* pEventsItem;
 212     if( !mpImpl->m_bGotEvents && SfxItemState::SET == rSet->GetItemState( SID_EVENTCONFIG, true, &pEventsItem ) )
 213     {
 214         mpImpl->m_bGotEvents = true;
 215         const SfxEventNamesList& rList = static_cast<const SfxEventNamesItem*>(pEventsItem)->GetEvents();
 216         for ( size_t nNo = 0, nCnt = rList.size(); nNo < nCnt; ++nNo )
 217         {
 218             const SfxEventName &rOwn = rList.at(nNo);
 219             AddEvent( rOwn.maUIName, rOwn.mnId );
 220         }
 221     }
 222
 223     FillEvents();
 224
 225     weld::TreeView& rListBox = mpImpl->m_xEventLB->GetListBox();
 226     std::unique_ptr<weld::TreeIter> xIter(rListBox.make_iterator());
 227     if (rListBox.get_iter_first(*xIter))
 228         rListBox.set_cursor(*xIter);
 229 }
 230
 231 bool SfxMacroTabPage::IsReadOnly() const
 232 {
 233     return false;
 234 }
 235
 236 IMPL_LINK_NOARG(SfxMacroTabPage, SelectEvent_Impl, weld::TreeView&, void)
 237 {
 238     weld::TreeView& rListBox = mpImpl->m_xEventLB->GetListBox();
 239     int nSelected = rListBox.get_selected_index();
 240     if (nSelected == -1)
 241     {
 242         DBG_ASSERT(nSelected != -1, "Where does the empty entry come from?");
 243         return;
 244     }
 245
 246     ScriptChanged();
 247     EnableButtons();
 248 }
 249
 250 IMPL_LINK_NOARG(SfxMacroTabPage, SelectGroup_Impl, weld::TreeView&, void)
 251 {
 252     mpImpl->m_xGroupLB->GroupSelected();
 253     const OUString sScriptURI = mpImpl->m_xMacroLB->GetSelectedScriptURI();
 254     OUString       aLabelText;
 255     if( !sScriptURI.isEmpty() )
 256         aLabelText = mpImpl->m_aStaticMacroLBLabel;
 257     mpImpl->m_xMacroFrame->set_label( aLabelText );
 258
 259     EnableButtons();
 260 }
 261
 262 IMPL_LINK_NOARG(SfxMacroTabPage, SelectMacro_Impl, weld::TreeView&, void)
 263 {
 264     EnableButtons();
 265 }
 266
 267 IMPL_LINK(SfxMacroTabPage, AssignDeleteClickHdl_Impl, weld::Button&, rBtn, void)
 268 {
 269     AssignDeleteHdl(&rBtn);
 270 }
 271
 272 IMPL_LINK(SfxMacroTabPage, AssignDeleteHdl_Impl, weld::TreeView&, rBtn, void)
 273 {
 274     AssignDeleteHdl(&rBtn);
 275 }
 276
 277 void SfxMacroTabPage::AssignDeleteHdl(const weld::Widget* pBtn)
 278 {
 279     weld::TreeView& rListBox = mpImpl->m_xEventLB->GetListBox();
 280     int nSelected = rListBox.get_selected_index();
 281     if (nSelected == -1)
 282     {
 283         DBG_ASSERT(nSelected != -1, "Where does the empty entry come from?");
 284         return;
 285     }
 286
 287     const bool bAssEnabled = pBtn != mpImpl->m_xDeletePB.get() && mpImpl->m_xAssignPB->get_sensitive();
 288
 289     // remove from the table
 290     SvMacroItemId nEvent = static_cast<SvMacroItemId>(rListBox.get_selected_id().toInt32());
 291     aTbl.Erase( nEvent );
 292
 293     OUString sScriptURI;
 294     if( bAssEnabled )
 295     {
 296         sScriptURI = mpImpl->m_xMacroLB->GetSelectedScriptURI();
 297         if( sScriptURI.startsWith( "vnd.sun.star.script:" ) )
 298         {
 299             aTbl.Insert(
 300                 nEvent, SvxMacro( sScriptURI, SVX_MACRO_LANGUAGE_SF ) );
 301         }
 302         else
 303         {
 304             OSL_ENSURE( false, "SfxMacroTabPage::AssignDeleteHdl_Impl: this branch is *not* dead? (out of interest: tell fs, please!)" );
 305             aTbl.Insert(
 306                 nEvent, SvxMacro( sScriptURI, SVX_MACRO_LANGUAGE_STARBASIC ) );
 307         }
 308     }
 309
 310     rListBox.set_text(nSelected, sScriptURI, 1);
 311
 312     EnableButtons();
 313 }
 314
 315 IMPL_LINK( SfxMacroTabPage, TimeOut_Impl, Timer*,, void )
 316 {
 317     // FillMacroList() can take a long time -> show wait cursor and disable input
 318     weld::Window* pDialog = GetDialogFrameWeld();
 319     // perhaps the tabpage is part of a SingleTabDialog then pDialog == nullptr
 320     std::unique_ptr<weld::WaitObject> xWait(pDialog ? new weld::WaitObject(pDialog) : nullptr);
 321     // fill macro list
 322     mpImpl->m_xGroupLB->Init(comphelper::getProcessComponentContext(), GetFrame(),
 323                              OUString(), false);
 324 }
 325
 326 void SfxMacroTabPage::InitAndSetHandler()
 327 {
 328     weld::TreeView& rListBox = mpImpl->m_xEventLB->GetListBox();
 329     Link<weld::TreeView&,void> aLnk(LINK(this, SfxMacroTabPage, AssignDeleteHdl_Impl));
 330     mpImpl->m_xMacroLB->connect_row_activated( aLnk);
 331     mpImpl->m_xDeletePB->connect_clicked(LINK(this, SfxMacroTabPage, AssignDeleteClickHdl_Impl));
 332     mpImpl->m_xAssignPB->connect_clicked(LINK(this, SfxMacroTabPage, AssignDeleteClickHdl_Impl));
 333     rListBox.connect_row_activated(aLnk);
 334
 335     rListBox.connect_changed(LINK(this, SfxMacroTabPage, SelectEvent_Impl));
 336     mpImpl->m_xGroupLB->connect_changed(LINK(this, SfxMacroTabPage, SelectGroup_Impl));
 337     mpImpl->m_xMacroLB->connect_changed(LINK(this, SfxMacroTabPage, SelectMacro_Impl));
 338
 339     std::vector<int> aWidths;
 340     aWidths.push_back(rListBox.get_approximate_digit_width() * 35);
 341     rListBox.set_column_fixed_widths(aWidths);
 342
 343     mpImpl->m_xEventLB->show();
 344
 345     mpImpl->m_xEventLB->set_sensitive(true);
 346     mpImpl->m_xGroupLB->set_sensitive(true);
 347     mpImpl->m_xMacroLB->set_sensitive(true);
 348
 349     mpImpl->m_xGroupLB->SetFunctionListBox(mpImpl->m_xMacroLB.get());
 350 }
 351
 352 void SfxMacroTabPage::FillEvents()
 353 {
 354     weld::TreeView& rListBox = mpImpl->m_xEventLB->GetListBox();
 355
 356     int nEntryCnt = rListBox.n_children();
 357
 358     // get events from the table and fill the EventListBox respectively
 359     for (int n = 0 ; n < nEntryCnt; ++n)
 360     {
 361         OUString sOld = rListBox.get_text(n, 1);
 362         OUString sNew;
 363         SvMacroItemId nEventId = static_cast<SvMacroItemId>(rListBox.get_id(n).toInt32());
 364         if (aTbl.IsKeyValid(nEventId))
 365             sNew = ConvertToUIName_Impl(aTbl.Get(nEventId));
 366
 367         if (sOld == sNew)
 368             continue;
 369
 370         rListBox.set_text(n, sNew, 1);
 371     }
 372 }
 373
 374 namespace
 375 {
 376     VclPtr<SfxMacroTabPage> CreateSfxMacroTabPage(TabPageParent pParent, const SfxItemSet& rAttrSet)
 377     {
 378         return VclPtr<SfxMacroTabPage>::Create( pParent, nullptr, rAttrSet );
 379     }
 380 }
 381
 382 VclPtr<SfxTabPage> SfxMacroTabPage::Create(TabPageParent pParent, const SfxItemSet* rAttrSet)
 383 {
 384     return CreateSfxMacroTabPage(pParent, *rAttrSet);
 385 }
 386
 387 SfxMacroAssignDlg::SfxMacroAssignDlg(weld::Widget* pParent,
 388     const Reference< XFrame >& rxDocumentFrame, const SfxItemSet& rSet)
 389     : SfxSingleTabDialogController(pParent, &rSet,"cui/ui/eventassigndialog.ui",
 390                                    "EventAssignDialog")
 391 {
 392     TabPageParent pPageParent(get_content_area(), this);
 393     VclPtr<SfxMacroTabPage> pPage = CreateSfxMacroTabPage(pPageParent, rSet);
 394     pPage->SetFrame(rxDocumentFrame);
 395     SetTabPage(pPage);
 396     pPage->LaunchFillGroup();
 397 }
 398
 399 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */