sw/inc/viscrs.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 #pragma once
  20
  21 #include <config_feature_desktop.h>
  22
  23 #include <vcl/cursor.hxx>
  24 #include "swcrsr.hxx"
  25 #include "swrect.hxx"
  26 #include "swregion.hxx"
  27 #include "swdllapi.h"
  28
  29 #include <optional>
  30
  31 namespace sdr::overlay { class OverlaySelection; }
  32
  33 class SwCursorShell;
  34 class SfxViewShell;
  35 class SwContentControlButton;
  36
  37 // From here classes/methods for non-text cursor.
  38
  39 class SW_DLLPUBLIC SwVisibleCursor
  40 {
  41     friend void InitCore();
  42     friend void FinitCore();
  43
  44     const SwCursorShell* m_pCursorShell;
  45     vcl::Cursor m_aTextCursor;
  46
  47     /// For LibreOfficeKit only - remember what page we were at the last time.
  48     sal_uInt16 m_nPageLastTime;
  49     SwRect m_aLastLOKRect;
  50
  51     bool m_bIsVisible;
  52     bool m_bIsDragCursor;
  53
  54 public:
  55     SwVisibleCursor( const SwCursorShell * pCShell );
  56     ~SwVisibleCursor();
  57
  58     void Show();
  59     void Hide();
  60
  61     bool IsVisible() const { return m_bIsVisible; }
  62     void SetDragCursor( bool bFlag = true ) { m_bIsDragCursor = bFlag; }
  63     void SetPosAndShow(SfxViewShell const * pViewShell);
  64     const vcl::Cursor& GetTextCursor() const;
  65
  66     std::optional<OString> getLOKPayload(int nType, int nViewId) const;
  67 };
  68
  69 // From here classes/methods for selections.
  70
  71 namespace sw::overlay { class OverlayRangesOutline; }
  72 class MapMode;
  73
  74 /**
  75  * SwSelPaintRects is a base class of SwShellCursor, which stores the overlay for the
  76  * cursor/selection: a list of rectangles to be painted as an overlay. It is also capable of
  77  * painting other overlays as needed (text input, content control).
  78  */
  79 class SwSelPaintRects : public SwRects
  80 {
  81     friend void InitCore();
  82     friend void FinitCore();
  83
  84     static tools::Long s_nPixPtX, s_nPixPtY;
  85     static MapMode *s_pMapMode;
  86
  87     const SwCursorShell* m_pCursorShell;
  88
  89 #if HAVE_FEATURE_DESKTOP || defined(ANDROID)
  90     std::unique_ptr<sdr::overlay::OverlaySelection> m_pCursorOverlay;
  91 #endif
  92
  93     bool m_bShowTextInputFieldOverlay;
  94     std::unique_ptr<sw::overlay::OverlayRangesOutline> m_pTextInputFieldOverlay;
  95     bool m_bShowContentControlOverlay;
  96     std::unique_ptr<sw::overlay::OverlayRangesOutline> m_pContentControlOverlay;
  97     VclPtr<SwContentControlButton> m_pContentControlButton;
  98
  99     void HighlightInputField();
 100     void HighlightContentControl();
 101
 102 public:
 103     SwSelPaintRects( const SwCursorShell& rCSh );
 104     virtual ~SwSelPaintRects();
 105
 106     virtual void FillRects() = 0;
 107     /// Fill rStart and rEnd with a rectangle that represents the start and end for selection handles.
 108     virtual void FillStartEnd(SwRect& rStart, SwRect& rEnd) const = 0;
 109
 110     // #i75172# in SwCursorShell::CreateCursor() the content of SwSelPaintRects is exchanged. To
 111     // make a complete swap access to m_pCursorOverlay is needed there
 112     void swapContent(SwSelPaintRects& rSwap);
 113
 114     void Show(std::vector<OString>* pSelectionRectangles = nullptr);
 115     void Hide();
 116     void Invalidate( const SwRect& rRect );
 117
 118     void SetShowTextInputFieldOverlay( const bool bShow )
 119     {
 120         m_bShowTextInputFieldOverlay = bShow;
 121     }
 122
 123     void SetShowContentControlOverlay(const bool bShow) { m_bShowContentControlOverlay = bShow; }
 124
 125     const VclPtr<SwContentControlButton>& GetContentControlButton() const;
 126
 127     const SwCursorShell* GetShell() const { return m_pCursorShell; }
 128     // check current MapMode of the shell and set possibly the static members.
 129     // Optional set the parameters pX, pY
 130     static void Get1PixelInLogic( const SwViewShell& rSh,
 131                                     tools::Long* pX = nullptr, tools::Long* pY = nullptr );
 132
 133     std::optional<OString> getLOKPayload(int nType, int nViewId) const;
 134 };
 135
 136 /// Represents the current text cursor of one opened edit window.
 137 ///
 138 /// See SwShellTableCursor for a table cursor that extends this class.
 139 class SW_DLLPUBLIC SwShellCursor : public virtual SwCursor, public SwSelPaintRects
 140 {
 141 private:
 142     // Document positions of start/end characters of a SSelection.
 143     Point m_MarkPt;
 144     Point m_PointPt;
 145     const SwPosition* m_pInitialPoint; // For assignment of GetPoint() to m_PointPt.
 146
 147     using SwCursor::UpDown;
 148
 149 public:
 150     SwShellCursor( const SwCursorShell& rCursorSh, const SwPosition &rPos );
 151     SwShellCursor( const SwCursorShell& rCursorSh, const SwPosition &rPos,
 152                     const Point& rPtPos, SwPaM* pRing );
 153     // note: *intentionally* links the new shell cursor into the old one's Ring
 154     SwShellCursor( SwShellCursor& );
 155     virtual ~SwShellCursor() override;
 156
 157     virtual void FillRects() override;   // For Table- and normal cursors.
 158     /// @see SwSelPaintRects::FillStartEnd(), override for text selections.
 159     virtual void FillStartEnd(SwRect& rStart, SwRect& rEnd) const override;
 160
 161     void Show(SfxViewShell const * pViewShell); // Update and display all selections.
 162     void Hide();            // Hide all selections.
 163     void Invalidate( const SwRect& rRect );
 164
 165     const Point& GetPtPos() const   { return (SwPaM::GetPoint() == m_pInitialPoint) ? m_PointPt : m_MarkPt; }
 166           Point& GetPtPos()         { return (SwPaM::GetPoint() == m_pInitialPoint) ? m_PointPt : m_MarkPt; }
 167     const Point& GetMkPos() const   { return (SwPaM::GetMark() == m_pInitialPoint) ? m_PointPt : m_MarkPt; }
 168           Point& GetMkPos()         { return (SwPaM::GetMark() == m_pInitialPoint) ? m_PointPt : m_MarkPt; }
 169     const Point& GetSttPos() const  { return (SwPaM::Start() == m_pInitialPoint) ? m_PointPt : m_MarkPt; }
 170           Point& GetSttPos()        { return (SwPaM::Start() == m_pInitialPoint) ? m_PointPt : m_MarkPt; }
 171     const Point& GetEndPos() const  { return (SwPaM::End() == m_pInitialPoint) ? m_PointPt : m_MarkPt; }
 172           Point& GetEndPos()        { return (SwPaM::End() == m_pInitialPoint) ? m_PointPt : m_MarkPt; }
 173
 174     virtual void SetMark() override;
 175
 176     virtual SwCursor* Create( SwPaM* pRing = nullptr ) const override;
 177
 178     virtual short MaxReplaceArived() override; //returns RET_YES/RET_CANCEL/RET_NO
 179     virtual void SaveTableBoxContent( const SwPosition* pPos ) override;
 180
 181     bool UpDown( bool bUp, sal_uInt16 nCnt );
 182
 183     // true: Cursor can be set to this position.
 184     virtual bool IsAtValidPos( bool bPoint = true ) const override;
 185
 186     virtual bool IsReadOnlyAvailable() const override;
 187
 188     SwShellCursor* GetNext()             { return dynamic_cast<SwShellCursor *>(GetNextInRing()); }
 189     const SwShellCursor* GetNext() const { return dynamic_cast<SwShellCursor const *>(GetNextInRing()); }
 190     SwShellCursor* GetPrev()             { return dynamic_cast<SwShellCursor *>(GetPrevInRing()); }
 191     const SwShellCursor* GetPrev() const { return dynamic_cast<SwShellCursor const *>(GetPrevInRing()); }
 192 };
 193
 194 class SwShellTableCursor final : public virtual SwShellCursor, public virtual SwTableCursor
 195 {
 196     /// Left edge of the selection start (top left cell).
 197     SwRect m_aStart;
 198     /// Right edge of the selection end (bottom right cell).
 199     SwRect m_aEnd;
 200     // The Selection has the same order as the table boxes, i.e.
 201     // if something is deleted from the one array at a certain position
 202     // it has to be deleted from the other one as well!!
 203
 204 public:
 205     SwShellTableCursor( const SwCursorShell& rCursorSh, const SwPosition& rPos );
 206     SwShellTableCursor( const SwCursorShell& rCursorSh,
 207                     const SwPosition &rMkPos, const Point& rMkPt,
 208                     const SwPosition &rPtPos, const Point& rPtPt );
 209     virtual ~SwShellTableCursor() override;
 210
 211     virtual void FillRects() override;   // For table and normal cursor.
 212     /// @see SwSelPaintRects::FillStartEnd(), override for table selections.
 213     virtual void FillStartEnd(SwRect& rStart, SwRect& rEnd) const override;
 214
 215     // Check if SPoint is within table SSelection.
 216     bool Contains( const Point& rPt ) const;
 217
 218     virtual void SetMark() override;
 219     virtual SwCursor* Create( SwPaM* pRing = nullptr ) const override;
 220
 221     virtual short MaxReplaceArived() override; //returns RET_YES/RET_CANCEL/RET_NO
 222     virtual void SaveTableBoxContent( const SwPosition* pPos ) override;
 223
 224     // true: Cursor can be set to this position.
 225     virtual bool IsAtValidPos( bool bPoint = true ) const override;
 226
 227     SwShellTableCursor* GetNext()             { return dynamic_cast<SwShellTableCursor *>(GetNextInRing()); }
 228     const SwShellTableCursor* GetNext() const { return dynamic_cast<SwShellTableCursor const *>(GetNextInRing()); }
 229     SwShellTableCursor* GetPrev()             { return dynamic_cast<SwShellTableCursor *>(GetPrevInRing()); }
 230     const SwShellTableCursor* GetPrev() const { return dynamic_cast<SwShellTableCursor const *>(GetPrevInRing()); }
 231 };
 232
 233
 234 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */