LibreOffice Module sc (master)  1
tabvwshe.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 <comphelper/string.hxx>
21 #include <comphelper/lok.hxx>
22 #include <editeng/eeitem.hxx>
23 #include <osl/diagnose.h>
24 
25 #include <editeng/editview.hxx>
26 #include <editeng/flditem.hxx>
27 #include <svx/hlnkitem.hxx>
28 #include <svl/srchitem.hxx>
29 #include <sfx2/dispatch.hxx>
30 #include <sfx2/request.hxx>
31 #include <svl/stritem.hxx>
32 
33 #include <tabvwsh.hxx>
34 #include <sc.hrc>
35 #include <scmod.hxx>
36 #include <impex.hxx>
37 #include <editsh.hxx>
38 #include <dociter.hxx>
39 #include <inputhdl.hxx>
40 #include <document.hxx>
41 
42 OUString ScTabViewShell::GetSelectionText( bool bWholeWord )
43 {
44  OUString aStrSelection;
45 
46  if ( pEditShell && pEditShell.get() == GetMySubShell() )
47  {
48  aStrSelection = pEditShell->GetSelectionText( bWholeWord );
49  }
50  else
51  {
52  ScRange aRange;
53 
54  if ( GetViewData().GetSimpleArea( aRange ) == SC_MARK_SIMPLE )
55  {
57  if ( bInFormatDialog && aRange.aStart.Row() != aRange.aEnd.Row() )
58  {
59  // limit range to one data row
60  // (only when the call comes from a format dialog)
61  ScHorizontalCellIterator aIter( rDoc, aRange.aStart.Tab(),
62  aRange.aStart.Col(), aRange.aStart.Row(),
63  aRange.aEnd.Col(), aRange.aEnd.Row() );
64  SCCOL nCol;
65  SCROW nRow;
66  if ( aIter.GetNext( nCol, nRow ) )
67  {
68  aRange.aStart.SetCol( nCol );
69  aRange.aStart.SetRow( nRow );
70  aRange.aEnd.SetRow( nRow );
71  }
72  else
73  aRange.aEnd = aRange.aStart;
74  }
75  else
76  {
77  // #i111531# with 1M rows it was necessary to limit the range
78  // to the actually used data area.
79  SCCOL nCol1, nCol2;
80  SCROW nRow1, nRow2;
81  SCTAB nTab1, nTab2;
82  aRange.GetVars( nCol1, nRow1, nTab1, nCol2, nRow2, nTab2);
83  bool bShrunk;
84  rDoc.ShrinkToUsedDataArea( bShrunk, nTab1, nCol1, nRow1, nCol2, nRow2, false);
85  if (bShrunk)
86  {
87  aRange.aStart.SetCol( nCol1 );
88  aRange.aStart.SetRow( nRow1 );
89  aRange.aEnd.SetCol( nCol2 );
90  aRange.aEnd.SetRow( nRow2 );
91  }
92  }
93 
94  ScImportExport aObj( rDoc, aRange );
95  aObj.SetFormulas( GetViewData().GetOptions().GetOption( VOPT_FORMULAS ) );
96  OUString aExportOUString;
97  /* TODO: STRING_TSVC under some circumstances? */
98  aObj.ExportString( aExportOUString, SotClipboardFormatId::STRING );
99  aStrSelection = convertLineEnd(aExportOUString, LINEEND_CR);
100 
101  // replace Tab/CR with space, if for dialog or through Basic/SelectionTextExt,
102  // or when it is a single row.
103  // Otherwise keep Tabs in multi-row (for instance mail or Basic/SelectionText).
104  // for mail the Tabs are then later changed into (multiple) spaces.
105 
106  if ( bInFormatDialog || bWholeWord || aRange.aEnd.Row() == aRange.aStart.Row() )
107  {
108  aStrSelection = aStrSelection.replaceAll("\r", " ");
109  aStrSelection = aStrSelection.replaceAll("\t", " ");
110  aStrSelection = comphelper::string::stripEnd(aStrSelection, ' ');
111  }
112  }
113  }
114 
115  return aStrSelection;
116 }
117 
119 {
120  bool bRet = false;
121 
122  if (pEditShell && pEditShell.get() == GetMySubShell())
123  {
124  bRet = pEditShell->ShouldDisableEditHyperlink();
125  }
126 
127  return bRet;
128 }
129 
131 {
132  if (pEditShell && pEditShell.get() == GetMySubShell())
133  {
134  pEditShell->EnableEditHyperlink();
135  }
136 }
137 
138 void ScTabViewShell::InsertURL( const OUString& rName, const OUString& rURL, const OUString& rTarget,
139  sal_uInt16 nMode )
140 {
141  SvxLinkInsertMode eMode = static_cast<SvxLinkInsertMode>(nMode);
142  bool bAsText = ( eMode != HLINK_BUTTON ); // default is now text
143 
144  if ( bAsText )
145  {
146  if ( GetViewData().IsActive() )
147  {
148  // if the view is active, always use InsertURLField, which starts EditMode
149  // and selects the URL, so it can be changed from the URL bar / dialog
150 
151  InsertURLField( rName, rURL, rTarget );
152  }
153  else
154  {
155  // if the view is not active, InsertURLField doesn't work
156  // -> use InsertBookmark to directly manipulate cell content
157  // bTryReplace=sal_True -> if cell contains only one URL, replace it
158 
159  SCCOL nPosX = GetViewData().GetCurX();
160  SCROW nPosY = GetViewData().GetCurY();
161  InsertBookmark( rName, rURL, nPosX, nPosY, &rTarget, true );
162  }
163  }
164  else
165  {
166  SC_MOD()->InputEnterHandler();
167  InsertURLButton( rName, rURL, rTarget, nullptr );
168  }
169 }
170 
172 {
173  ESelection aSel = rView.GetSelection();
174  if ( aSel.nStartPos == aSel.nEndPos && aSel.nStartPos > 0 )
175  {
176  // Cursor is behind the inserted field -> extend selection to the left
177 
178  --aSel.nStartPos;
179  rView.SetSelection( aSel );
180  }
181 }
182 
183 void ScTabViewShell::InsertURLField( const OUString& rName, const OUString& rURL, const OUString& rTarget )
184 {
185  SvxURLField aURLField( rURL, rName, SvxURLFormat::Repr );
186  aURLField.SetTargetFrame( rTarget );
187  SvxFieldItem aURLItem( aURLField, EE_FEATURE_FIELD );
188 
189  ScViewData& rViewData = GetViewData();
190  ScModule* pScMod = SC_MOD();
191  ScInputHandler* pHdl = pScMod->GetInputHdl( rViewData.GetViewShell() );
192 
193  bool bSelectFirst = false;
194  bool bIsEditMode = pScMod->IsEditMode();
195  int nSelInd = 1;
196  OUString sSeltext(GetSelectionText());
197 
198  if ( !bIsEditMode )
199  {
200  if ( !SelectionEditable() )
201  {
202  // no error message (may be called from drag&drop)
203  return;
204  }
205 
206  // single url in cell is shown in the dialog and replaced
207  bSelectFirst = HasBookmarkAtCursor( nullptr );
208  pScMod->SetInputMode( SC_INPUT_TABLE );
209  }
210 
211  EditView* pTopView = pHdl->GetTopView();
212  EditView* pTableView = pHdl->GetTableView();
213  OSL_ENSURE( pTopView || pTableView, "No EditView" );
214 
215  // Check if user selected a whole cell by single click,
216  // cell has content, and user didn't change the name/text
217  // of the link something different than the content via the hyperlink dialog.
218  // If true, assign the given hyperlink to the whole content
219  // instead of inserting a duplicate, or appending the url.
220  if (comphelper::LibreOfficeKit::isActive() && !bIsEditMode && !bSelectFirst
221  && pTableView && !sSeltext.isEmpty() && sSeltext == rName)
222  {
223  nSelInd = sSeltext.getLength();
224  bSelectFirst = true;
225  }
226 
227  if ( bSelectFirst )
228  {
229  if ( pTopView )
230  pTopView->SetSelection( ESelection(0,0,0,1) );
231  if ( pTableView )
232  pTableView->SetSelection( ESelection(0,0,0,nSelInd) );
233  }
234 
235  pHdl->DataChanging();
236 
237  if ( pTopView )
238  {
239  pTopView->InsertField( aURLItem );
240  lcl_SelectFieldAfterInsert( *pTopView );
241  }
242  if ( pTableView )
243  {
244  pTableView->InsertField( aURLItem );
245  lcl_SelectFieldAfterInsert( *pTableView );
246  }
247 
248  pHdl->DataChanged();
249 }
250 
252 {
253  const SfxItemSet* pReqArgs = rReq.GetArgs();
254  sal_uInt16 nSlot = rReq.GetSlot();
255  const SfxPoolItem* pItem;
256 
257  switch ( nSlot )
258  {
259  case FID_SEARCH_NOW:
260  {
261  if ( pReqArgs &&
262  SfxItemState::SET == pReqArgs->GetItemState(SID_SEARCH_ITEM, false, &pItem) )
263  {
264  assert( dynamic_cast<const SvxSearchItem*>( pItem) && "wrong Item" );
265  const SvxSearchItem* pSearchItem = static_cast<const SvxSearchItem*>(pItem);
266 
267  ScGlobal::SetSearchItem( *pSearchItem );
268  SearchAndReplace( pSearchItem, true, rReq.IsAPI() );
269  rReq.Done();
270  }
271  }
272  break;
273 
274  case SID_SEARCH_ITEM:
275  if (pReqArgs && SfxItemState::SET ==
276  pReqArgs->GetItemState(SID_SEARCH_ITEM, false, &pItem))
277  {
278  // remember search item
279  assert( dynamic_cast<const SvxSearchItem*>( pItem) && "wrong Item" );
280  ScGlobal::SetSearchItem( *static_cast<const SvxSearchItem*>(pItem ));
281  }
282  else
283  {
284  OSL_FAIL("SID_SEARCH_ITEM without Parameter");
285  }
286  break;
287  case FID_SEARCH:
288  case FID_REPLACE:
289  case FID_REPLACE_ALL:
290  case FID_SEARCH_ALL:
291  {
292  if (pReqArgs && SfxItemState::SET == pReqArgs->GetItemState(nSlot, false, &pItem))
293  {
294  // get search item
295 
296  SvxSearchItem aSearchItem = ScGlobal::GetSearchItem();
297 
298  // fill search item
299 
300  aSearchItem.SetSearchString(static_cast<const SfxStringItem*>(pItem)->GetValue());
301  if(SfxItemState::SET == pReqArgs->GetItemState(FN_PARAM_1, false, &pItem))
302  aSearchItem.SetReplaceString(static_cast<const SfxStringItem*>(pItem)->GetValue());
303 
304  if (nSlot == FID_SEARCH)
305  aSearchItem.SetCommand(SvxSearchCmd::FIND);
306  else if(nSlot == FID_REPLACE)
307  aSearchItem.SetCommand(SvxSearchCmd::REPLACE);
308  else if(nSlot == FID_REPLACE_ALL)
309  aSearchItem.SetCommand(SvxSearchCmd::REPLACE_ALL);
310  else
311  aSearchItem.SetCommand(SvxSearchCmd::FIND_ALL);
312 
313  // execute request (which stores the SearchItem)
314 
315  aSearchItem.SetWhich(SID_SEARCH_ITEM);
316  GetViewData().GetDispatcher().ExecuteList(FID_SEARCH_NOW,
317  rReq.IsAPI() ? SfxCallMode::API|SfxCallMode::SYNCHRON :
318  SfxCallMode::RECORD,
319  { &aSearchItem });
320  }
321  else
322  {
324  SID_SEARCH_DLG, SfxCallMode::ASYNCHRON|SfxCallMode::RECORD );
325  }
326  }
327  break;
328  case FID_REPEAT_SEARCH:
329  {
330  // once more with ScGlobal::GetSearchItem()
331 
332  SvxSearchItem aSearchItem = ScGlobal::GetSearchItem();
333  aSearchItem.SetWhich(SID_SEARCH_ITEM);
334  GetViewData().GetDispatcher().ExecuteList( FID_SEARCH_NOW,
335  rReq.IsAPI() ? SfxCallMode::API|SfxCallMode::SYNCHRON :
336  SfxCallMode::RECORD,
337  { &aSearchItem });
338  }
339  break;
340 // case FID_SEARCH_COUNT:
341  }
342 }
343 
344 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
OString stripEnd(std::string_view rIn, char c)
const SfxPoolItem * ExecuteList(sal_uInt16 nSlot, SfxCallMode nCall, std::initializer_list< SfxPoolItem const * > args, std::initializer_list< SfxPoolItem const * > internalargs=std::initializer_list< SfxPoolItem const * >())
void SetTargetFrame(const OUString &rFrm)
ScAddress aStart
Definition: address.hxx:499
TOOLS_DLLPUBLIC OString convertLineEnd(const OString &rIn, LineEnd eLineEnd)
bool IsEditMode()
Definition: scmod.cxx:1341
SCROW Row() const
Definition: address.hxx:261
bool ExportString(OUString &, SotClipboardFormatId)
Definition: impex.cxx:324
std::string GetValue
bool DataChanging(sal_Unicode cTyped=0, bool bFromCommand=false)
Definition: inputhdl.cxx:2598
void SetSearchString(const OUString &rNewString)
SCROW GetCurY() const
Definition: viewdata.hxx:401
void EnableEditHyperlink()
force "Edit Hyperlink" to true, with the expectation that SID_EDIT_HYPERLINK is later Invalidated to ...
Definition: tabvwshe.cxx:130
ScAddress aEnd
Definition: address.hxx:500
void Done(bool bRemove=false)
ScDocument & GetDocument() const
Definition: viewdata.hxx:379
static void lcl_SelectFieldAfterInsert(EditView &rView)
Definition: tabvwshe.cxx:171
const SfxItemSet * GetArgs() const
void SetReplaceString(const OUString &rNewString)
LINEEND_CR
EditView * GetTableView()
Definition: inputhdl.hxx:236
std::unique_ptr< ScEditShell > pEditShell
Definition: tabvwsh.hxx:99
bool SelectionEditable(bool *pOnlyNotBecauseOfMatrix=nullptr)
Definition: viewfunc.cxx:261
virtual OUString GetSelectionText(bool bWholeWord=false) override
Definition: tabvwshe.cxx:42
bool HasBookmarkAtCursor(SvxHyperlinkItem *pContent)
Definition: viewfun4.cxx:754
Mode eMode
SCTAB Tab() const
Definition: address.hxx:270
void SetRow(SCROW nRowP)
Definition: address.hxx:274
bool SearchAndReplace(const SvxSearchItem *pSearchItem, bool bAddUndo, bool bIsApi)
Definition: viewfun2.cxx:1900
static SC_DLLPUBLIC void SetSearchItem(const SvxSearchItem &rNew)
Definition: global.cxx:226
sal_Int32 nEndPos
void SetCol(SCCOL nColP)
Definition: address.hxx:278
ScViewData & GetViewData()
Definition: tabview.hxx:333
bool ShrinkToUsedDataArea(bool &o_bShrunk, SCTAB nTab, SCCOL &rStartCol, SCROW &rStartRow, SCCOL &rEndCol, SCROW &rEndRow, bool bColumnsOnly, bool bStickyTopRow=false, bool bStickyLeftCol=false, ScDataAreaExtras *pDataAreaExtras=nullptr) const
Shrink a range to only include used data area.
Definition: document.cxx:1063
ScTabViewShell * GetViewShell() const
Definition: viewdata.hxx:356
void InsertField(const SvxFieldItem &rFld)
void InsertURL(const OUString &rName, const OUString &rURL, const OUString &rTarget, sal_uInt16 nMode)
Definition: tabvwshe.cxx:138
SfxItemState GetItemState(sal_uInt16 nWhich, bool bSrchInParent=true, const SfxPoolItem **ppItem=nullptr) const
void SetFormulas(bool b)
Definition: impex.hxx:132
HLINK_BUTTON
sal_Int16 SCCOL
Definition: types.hxx:21
#define SC_MOD()
Definition: scmod.hxx:250
void InsertBookmark(const OUString &rDescription, const OUString &rURL, SCCOL nPosX, SCROW nPosY, const OUString *pTarget=nullptr, bool bTryReplace=false)
Definition: viewfun4.cxx:695
SvxLinkInsertMode
void SetCommand(SvxSearchCmd nNewCommand)
bool IsActive() const
Definition: viewdata.hxx:381
bool bInFormatDialog
Definition: tabvwsh.hxx:144
void GetVars(SCCOL &nCol1, SCROW &nRow1, SCTAB &nTab1, SCCOL &nCol2, SCROW &nRow2, SCTAB &nTab2) const
Definition: address.hxx:692
void InsertURLField(const OUString &rName, const OUString &rURL, const OUString &rTarget)
Definition: tabvwshe.cxx:183
void ExecSearch(SfxRequest &rReq)
Definition: tabvwshe.cxx:251
SCCOL Col() const
Definition: address.hxx:266
void SetInputMode(ScInputMode eMode, const OUString *pInitText=nullptr)
Definition: scmod.cxx:1334
sal_Int32 SCROW
Definition: types.hxx:17
sal_uInt16 GetSlot() const
SfxShell * GetMySubShell() const
Definition: tabvwsh4.cxx:987
void SetWhich(sal_uInt16 nId)
SfxDispatcher & GetDispatcher()
Definition: viewdata.cxx:3102
void DataChanged(bool bFromTopNotify=false, bool bSetModified=true)
Definition: inputhdl.cxx:2610
void SetSelection(const ESelection &rNewSel)
ESelection GetSelection() const
constexpr sal_uInt16 EE_FEATURE_FIELD(EE_FEATURE_NOTCONV+1)
ScInputHandler * GetInputHdl(ScTabViewShell *pViewSh=nullptr, bool bUseRef=true)
Input-Handler.
Definition: scmod.cxx:1303
bool IsAPI() const
const SfxPoolItem * Execute(sal_uInt16 nSlot, SfxCallMode nCall=SfxCallMode::SLOT, const SfxPoolItem **pArgs=nullptr, sal_uInt16 nModi=0, const SfxPoolItem **pInternalArgs=nullptr)
bool ShouldDisableEditHyperlink() const
return true if "Edit Hyperlink" in context menu should be disabled
Definition: tabvwshe.cxx:118
void InsertURLButton(const OUString &rName, const OUString &rURL, const OUString &rTarget, const Point *pInsPos)
Definition: tabvwshg.cxx:42
EditView * GetTopView()
Definition: inputhdl.hxx:237
sal_Int16 SCTAB
Definition: types.hxx:22
SCCOL GetCurX() const
Definition: viewdata.hxx:400
sal_Int32 nStartPos
static SC_DLLPUBLIC const SvxSearchItem & GetSearchItem()
Definition: global.cxx:215