sc/source/ui/inc/gridwin.hxx

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