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