1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#pragma once
#include <vcl/transfer.hxx>
#include "viewutil.hxx"
#include "viewdata.hxx"
#include "cbutton.hxx"
#include "checklistmenu.hxx"
#include <com/sun/star/sheet/DataPilotFieldOrientation.hpp>
#include <o3tl/deleter.hxx>
#include <vcl/window.hxx>
#include <memory>
#include <vector>
namespace editeng {
struct MisspellRanges;
}
namespace sc {
class SpellCheckContext;
}
namespace sdr::overlay { class OverlayManager; }
class FmFormView;
struct ScTableInfo;
struct ScDragData;
class ScDPObject;
class ScDPFieldButton;
class ScOutputData;
class SdrObject;
class SdrEditView;
class ScNoteMarker;
class SdrHdlList;
class ScTransferObj;
struct SpellCallbackInfo;
class ScLokRTLContext;
// mouse status (nMouseStatus)
#define SC_GM_NONE 0
#define SC_GM_TABDOWN 1
#define SC_GM_DBLDOWN 2
#define SC_GM_FILTER 3
#define SC_GM_IGNORE 4
#define SC_GM_WATERUNDO 5
#define SC_GM_URLDOWN 6
// page drag mode
#define SC_PD_NONE 0
#define SC_PD_RANGE_L 1
#define SC_PD_RANGE_R 2
#define SC_PD_RANGE_T 4
#define SC_PD_RANGE_B 8
#define SC_PD_RANGE_TL (SC_PD_RANGE_T|SC_PD_RANGE_L)
#define SC_PD_RANGE_TR (SC_PD_RANGE_T|SC_PD_RANGE_R)
#define SC_PD_RANGE_BL (SC_PD_RANGE_B|SC_PD_RANGE_L)
#define SC_PD_RANGE_BR (SC_PD_RANGE_B|SC_PD_RANGE_R)
#define SC_PD_BREAK_H 16
#define SC_PD_BREAK_V 32
// predefines
namespace sdr::overlay { class OverlayObjectList; }
class ScFilterListBox;
class SAL_DLLPUBLIC_RTTI ScGridWindow : public vcl::Window, public DropTargetHelper, public DragSourceHelper
{
// ScFilterListBox is always used for selection list
friend class ScFilterListBox;
enum RfCorner
{
NONE,
LEFT_UP,
RIGHT_UP,
LEFT_DOWN,
RIGHT_DOWN
};
std::unique_ptr<sdr::overlay::OverlayObjectList> mpOOCursors;
std::unique_ptr<sdr::overlay::OverlayObjectList> mpOOSelection;
std::unique_ptr<sdr::overlay::OverlayObjectList> mpOOSelectionBorder;
std::unique_ptr<sdr::overlay::OverlayObjectList> mpOOAutoFill;
std::unique_ptr<sdr::overlay::OverlayObjectList> mpOODragRect;
std::unique_ptr<sdr::overlay::OverlayObjectList> mpOOHeader;
std::unique_ptr<sdr::overlay::OverlayObjectList> mpOOShrink;
std::unique_ptr<sdr::overlay::OverlayObjectList> mpOOSparklineGroup;
std::optional<tools::Rectangle> mpAutoFillRect;
/// LibreOfficeKit needs a persistent FmFormView for tiled rendering,
/// otherwise the invalidations from drawinglayer do not work.
std::unique_ptr<FmFormView> mpLOKDrawView;
struct MouseEventState;
/**
* Stores current visible column and row ranges, used to avoid expensive
* operations on objects that are outside visible area.
*/
struct VisibleRange
{
SCCOL mnCol1;
SCCOL mnCol2;
SCROW mnRow1;
SCROW mnRow2;
VisibleRange(const ScDocument&);
bool isInside(SCCOL nCol, SCROW nRow) const;
bool set(SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW nRow2);
};
VisibleRange maVisibleRange;
struct LOKCursorEntry
{
Fraction aScaleX;
Fraction aScaleY;
tools::Rectangle aRect;
};
// Stores the last cursor position in twips for all
// zoom levels demanded from a ScGridWindow instance.
std::vector<LOKCursorEntry> maLOKLastCursor;
std::shared_ptr<sc::SpellCheckContext> mpSpellCheckCxt;
ScViewData& mrViewData;
ScSplitPos eWhich;
ScHSplitPos eHWhich;
ScVSplitPos eVWhich;
std::unique_ptr<ScNoteMarker, o3tl::default_delete<ScNoteMarker>> mpNoteMarker;
std::shared_ptr<ScFilterListBox> mpFilterBox;
std::unique_ptr<ScCheckListMenuControl> mpAutoFilterPopup;
std::unique_ptr<ScCheckListMenuControl> mpDPFieldPopup;
std::unique_ptr<ScDPFieldButton> mpFilterButton;
ScCheckListMenuControl::ResultType aSaveAutoFilterResult;
sal_uInt16 nCursorHideCount;
sal_uInt16 nButtonDown;
sal_uInt8 nMouseStatus;
enum class ScNestedButtonState { NONE, Down, Up };
ScNestedButtonState nNestedButtonState; // track nested button up/down calls
tools::Long nDPField;
ScDPObject* pDragDPObj; //! name?
sal_uInt16 nRFIndex;
SCCOL nRFAddX;
SCROW nRFAddY;
sal_uInt16 nPagebreakMouse; // Page break mode, Drag
SCCOLROW nPagebreakBreak;
SCCOLROW nPagebreakPrev;
ScRange aPagebreakSource;
ScRange aPagebreakDrag;
SvtScriptType nPageScript;
SCCOL nDragStartX;
SCROW nDragStartY;
SCCOL nDragEndX;
SCROW nDragEndY;
InsCellCmd meDragInsertMode;
ScDDComboBoxButton aComboButton;
Point aCurMousePos;
sal_uInt16 nPaintCount;
tools::Rectangle aRepaintPixel;
ScAddress aAutoMarkPos;
ScAddress aListValPos;
tools::Rectangle aInvertRect;
RfCorner aRFSelectedCorned;
Timer maShowPageBreaksTimer;
bool bEEMouse:1; // Edit Engine has mouse
bool bDPMouse:1; // DataPilot D&D (new Pivot table)
bool bRFMouse:1; // RangeFinder drag
bool bRFSize:1;
bool bPagebreakDrawn:1;
bool bDragRect:1;
bool bIsInPaint:1;
bool bNeedsRepaint:1;
bool bAutoMarkVisible:1;
bool bListValButton:1;
bool bInitialPageBreaks:1;
DECL_DLLPRIVATE_LINK( PopupModeEndHdl, weld::Popover&, void );
DECL_DLLPRIVATE_LINK( PopupSpellingHdl, SpellCallbackInfo&, void );
bool TestMouse( const MouseEvent& rMEvt, bool bAction );
bool DoPageFieldSelection( SCCOL nCol, SCROW nRow );
bool DoAutoFilterButton( SCCOL nCol, SCROW nRow, const MouseEvent& rMEvt );
void DoPushPivotButton( SCCOL nCol, SCROW nRow, const MouseEvent& rMEvt, bool bButton, bool bPopup );
void DPMouseMove( const MouseEvent& rMEvt );
void DPMouseButtonUp( const MouseEvent& rMEvt );
void DPTestMouse( const MouseEvent& rMEvt, bool bMove );
/**
* Check if the mouse click is on a field popup button.
*
* @return true if the field popup menu has been launched and no further
* mouse event handling is necessary, false otherwise.
*/
bool DPTestFieldPopupArrow(const MouseEvent& rMEvt, const ScAddress& rPos, const ScAddress& rDimPos, ScDPObject* pDPObj);
void DPLaunchFieldPopupMenu(const Point& rScrPos, const Size& rScrSize, const ScAddress& rPos, ScDPObject* pDPObj);
void RFMouseMove( const MouseEvent& rMEvt, bool bUp );
void PagebreakMove( const MouseEvent& rMEvt, bool bUp );
void UpdateDragRect( bool bShowRange, const tools::Rectangle& rPosRect );
bool IsAutoFilterActive( SCCOL nCol, SCROW nRow, SCTAB nTab );
void FilterSelect( sal_uLong nSel );
void ExecDataSelect( SCCOL nCol, SCROW nRow, const OUString& rStr );
bool HasScenarioButton( const Point& rPosPixel, ScRange& rScenRange );
void DropScroll( const Point& rMousePos );
sal_Int8 AcceptPrivateDrop( const AcceptDropEvent& rEvt, const ScDragData& rData );
sal_Int8 ExecutePrivateDrop( const ExecuteDropEvent& rEvt, const ScDragData& rData );
sal_Int8 DropTransferObj( ScTransferObj* pTransObj, SCCOL nDestPosX, SCROW nDestPosY,
const Point& rLogicPos, sal_Int8 nDndAction );
void HandleMouseButtonDown( const MouseEvent& rMEvt, MouseEventState& rState );
bool DrawMouseButtonDown(const MouseEvent& rMEvt);
bool DrawMouseButtonUp(const MouseEvent& rMEvt);
bool DrawMouseMove(const MouseEvent& rMEvt);
bool DrawKeyInput(const KeyEvent& rKEvt, vcl::Window* pWin);
bool DrawCommand(const CommandEvent& rCEvt);
bool DrawHasMarkedObj();
void DrawEndAction();
void DrawMarkDropObj( SdrObject* pObj );
bool IsMyModel(const SdrEditView* pSdrView);
void DrawRedraw( ScOutputData& rOutputData, SdrLayerID nLayer );
void DrawSdrGrid( const tools::Rectangle& rDrawingRect, OutputDevice* pContentDev );
void DrawAfterScroll();
tools::Rectangle GetListValButtonRect( const ScAddress& rButtonPos );
void DrawHiddenIndicator( SCCOL nX1, SCROW nY1, SCCOL nX2, SCROW nY2, vcl::RenderContext& rRenderContext);
void DrawPagePreview( SCCOL nX1, SCROW nY1, SCCOL nX2, SCROW nY2, vcl::RenderContext& rRenderContext);
bool GetEditUrl( const Point& rPos,
OUString* pName=nullptr, OUString* pUrl=nullptr, OUString* pTarget=nullptr );
bool HitRangeFinder( const Point& rMouse, RfCorner& rCorner, sal_uInt16* pIndex,
SCCOL* pAddX, SCROW* pAddY );
sal_uInt16 HitPageBreak( const Point& rMouse, ScRange* pSource,
SCCOLROW* pBreak, SCCOLROW* pPrev );
/** The cell may be covered by text that overflows from a previous cell.
@return if true, the given cell is covered by (overflowing) text and
rTextStartPosX returns the column where the text that overflows
starts.
*/
bool IsCellCoveredByText(SCCOL nPosX, SCROW nPosY, SCTAB nTab, SCCOL &rTextStartPosX);
void PasteSelection( const Point& rPosPixel );
void SelectForContextMenu( const Point& rPosPixel, SCCOL nCellX, SCROW nCellY );
void GetSelectionRects( ::std::vector< tools::Rectangle >& rPixelRects ) const;
void GetSelectionRectsPrintTwips(::std::vector< tools::Rectangle >& rRects) const;
void GetPixelRectsFor( const ScMarkData &rMarkData,
::std::vector< tools::Rectangle >& rPixelRects ) const;
void GetRectsAnyFor(const ScMarkData &rMarkData,
::std::vector< tools::Rectangle >& rRects, bool bInPrintTwips) const;
void UpdateKitSelection(const std::vector<tools::Rectangle>& rRectangles,
std::vector<tools::Rectangle>* pLogicRects = nullptr);
bool NeedLOKCursorInvalidation(const tools::Rectangle& rCursorRect,
const Fraction aScaleX, const Fraction aScaleY);
void InvalidateLOKViewCursor(const tools::Rectangle& rCursorRect,
const Fraction aScaleX, const Fraction aScaleY);
void SetupInitialPageBreaks(const ScDocument& rDoc, SCTAB nTab);
DECL_DLLPRIVATE_LINK(InitiatePageBreaksTimer, Timer*, void);
protected:
virtual void PrePaint(vcl::RenderContext& rRenderContext) override;
virtual void Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect) override;
virtual void GetFocus() override;
virtual void LoseFocus() override;
virtual void RequestHelp( const HelpEvent& rEvt ) override;
virtual sal_Int8 AcceptDrop( const AcceptDropEvent& rEvt ) override;
virtual sal_Int8 ExecuteDrop( const ExecuteDropEvent& rEvt ) override;
virtual void StartDrag( sal_Int8 nAction, const Point& rPosPixel ) override;
public:
enum class AutoFilterMode
{
Normal,
Empty,
NonEmpty,
Top10,
Bottom10,
Custom,
TextColor,
BackgroundColor,
SortAscending,
SortDescending,
Clear
};
ScGridWindow( vcl::Window* pParent, ScViewData& rData, ScSplitPos eWhichPos );
virtual ~ScGridWindow() override;
virtual void dispose() override;
virtual void KeyInput(const KeyEvent& rKEvt) override;
// #i70788# flush and get overlay
rtl::Reference<sdr::overlay::OverlayManager> getOverlayManager() const;
void flushOverlayManager();
virtual OUString GetSurroundingText() const override;
virtual Selection GetSurroundingTextSelection() const override;
virtual bool DeleteSurroundingText(const Selection& rSelection) override;
virtual void Command( const CommandEvent& rCEvt ) override;
virtual void DataChanged( const DataChangedEvent& rDCEvt ) override;
virtual void MouseButtonDown( const MouseEvent& rMEvt ) override;
virtual void MouseButtonUp( const MouseEvent& rMEvt ) override;
virtual void MouseMove( const MouseEvent& rMEvt ) override;
virtual bool PreNotify( NotifyEvent& rNEvt ) override;
virtual void Tracking( const TrackingEvent& rTEvt ) override;
void PaintTile( VirtualDevice& rDevice,
int nOutputWidth, int nOutputHeight,
int nTilePosX, int nTilePosY,
tools::Long nTileWidth, tools::Long nTileHeight );
/// @see Window::LogicInvalidate().
void LogicInvalidate(const tools::Rectangle* pRectangle) override;
/// Update the cell selection according to what handles have been dragged.
/// @see vcl::ITiledRenderable::setTextSelection() for the values of nType.
/// Coordinates are in pixels.
void SetCellSelectionPixel(int nType, int nPixelX, int nPixelY);
/// Get the cell selection, coordinates are in logic units.
void GetCellSelection(std::vector<tools::Rectangle>& rLogicRects);
virtual css::uno::Reference< css::accessibility::XAccessible > CreateAccessible() override;
void FakeButtonUp();
const Point& GetMousePosPixel() const { return aCurMousePos; }
void UpdateStatusPosSize();
void ClickExtern();
using Window::SetPointer;
void MoveMouseStatus( ScGridWindow &rDestWin );
void ScrollPixel( tools::Long nDifX, tools::Long nDifY );
void UpdateEditViewPos();
void UpdateFormulas(SCCOL nX1 = -1, SCROW nY1 = -1, SCCOL nX2 = -1, SCROW nY2 = -1);
void ShowFilterMenu(weld::Window* pParent, const tools::Rectangle& rCellRect, bool bLayoutRTL);
void LaunchDataSelectMenu( SCCOL nCol, SCROW nRow );
void DoScenarioMenu( const ScRange& rScenRange );
void LaunchAutoFilterMenu(SCCOL nCol, SCROW nRow);
void RefreshAutoFilterButton(const ScAddress& rPos);
void UpdateAutoFilterFromMenu(AutoFilterMode eMode);
void LaunchPageFieldMenu( SCCOL nCol, SCROW nRow );
void LaunchDPFieldMenu( SCCOL nCol, SCROW nRow );
css::sheet::DataPilotFieldOrientation GetDPFieldOrientation( SCCOL nCol, SCROW nRow ) const;
void DPLaunchFieldPopupMenu(const Point& rScrPos, const Size& rScrSize,
tools::Long nDimIndex, ScDPObject* pDPObj);
void DrawButtons(SCCOL nX1, SCCOL nX2, const ScTableInfo& rTabInfo, OutputDevice* pContentDev,
const ScLokRTLContext* pLokRTLContext);
using Window::Draw;
void Draw( SCCOL nX1, SCROW nY1, SCCOL nX2, SCROW nY2,
ScUpdateMode eMode );
/// Draw content of the gridwindow; shared between the desktop and the tiled rendering.
void DrawContent(OutputDevice &rDevice, const ScTableInfo& rTableInfo, ScOutputData& aOutputData, bool bLogicText);
void CreateAnchorHandle(SdrHdlList& rHdl, const ScAddress& rAddress);
void HideCursor();
void ShowCursor();
void UpdateAutoFillMark(bool bMarked, const ScRange& rMarkRange);
void UpdateListValPos( bool bVisible, const ScAddress& rPos );
bool ShowNoteMarker( SCCOL nPosX, SCROW nPosY, bool bKeyboard );
void HideNoteMarker();
/// MapMode for the drawinglayer objects.
MapMode GetDrawMapMode( bool bForce = false );
void StopMarking();
void UpdateInputContext();
bool NeedsRepaint() const { return bNeedsRepaint; }
void DoInvertRect( const tools::Rectangle& rPixel );
void CheckNeedsRepaint();
void UpdateDPFromFieldPopupMenu();
bool UpdateVisibleRange();
void CursorChanged();
void DrawLayerCreated();
void SetAutoSpellContext( const std::shared_ptr<sc::SpellCheckContext> &ctx );
void ResetAutoSpell();
void ResetAutoSpellForContentChange();
void SetAutoSpellData( SCCOL nPosX, SCROW nPosY, const std::vector<editeng::MisspellRanges>* pRanges );
const std::vector<editeng::MisspellRanges>* GetAutoSpellData( SCCOL nPosX, SCROW nPosY );
bool InsideVisibleRange( SCCOL nPosX, SCROW nPosY );
void UpdateSparklineGroupOverlay();
void DeleteSparklineGroupOverlay();
void DeleteCopySourceOverlay();
void UpdateCopySourceOverlay();
void DeleteCursorOverlay();
void UpdateCursorOverlay();
void DeleteSelectionOverlay();
void UpdateSelectionOverlay();
void DeleteAutoFillOverlay();
void UpdateAutoFillOverlay();
void DeleteDragRectOverlay();
void UpdateDragRectOverlay();
void DeleteHeaderOverlay();
void UpdateHeaderOverlay();
void DeleteShrinkOverlay();
void UpdateShrinkOverlay();
void UpdateAllOverlays();
/// get Cell cursor in this view's co-ordinate system @see ScModelObj::getCellCursor().
OString getCellCursor() const;
void notifyKitCellCursor() const;
void notifyKitCellViewCursor(const SfxViewShell* pForShell) const;
void updateKitCellCursor(const SfxViewShell* pOtherShell) const;
/// notify this view with new positions for other view's cursors (after zoom)
void updateKitOtherCursors() const;
void updateOtherKitSelections() const;
void notifyKitCellFollowJump() const;
/// Same as MouseButtonDown(), but coordinates are in logic unit.
virtual void LogicMouseButtonDown(const MouseEvent& rMouseEvent) override;
/// Same as MouseButtonUp(), but coordinates are in logic unit.
virtual void LogicMouseButtonUp(const MouseEvent& rMouseEvent) override;
/// Same as MouseMove(), but coordinates are in logic unit.
virtual void LogicMouseMove(const MouseEvent& rMouseEvent) override;
ScViewData& getViewData();
virtual FactoryFunction GetUITestFactory() const override;
void updateLOKValListButton(bool bVisible, const ScAddress& rPos) const;
void updateLOKInputHelp(const OUString& title, const OUString& content) const;
void initiatePageBreaks();
protected:
void ImpCreateOverlayObjects();
void ImpDestroyOverlayObjects();
private:
#ifdef DBG_UTIL
void dumpCellProperties();
void dumpColumnInformationPixel();
void dumpColumnInformationHmm();
void dumpGraphicInformation();
void dumpColumnCellStorage();
#endif
};
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|