include/svx/sdr/table/tablecontroller.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_SVX_SDR_TABLE_TABLECONTROLLER_HXX
  21 #define INCLUDED_SVX_SDR_TABLE_TABLECONTROLLER_HXX
  22
  23 #include <com/sun/star/util/XModifyListener.hpp>
  24 #include <rtl/ref.hxx>
  25
  26 #include <svx/sdr/overlay/overlayobjectlist.hxx>
  27 #include <svx/selectioncontroller.hxx>
  28 #include <svx/svdotable.hxx>
  29 #include <svx/svdview.hxx>
  30 #include <optional>
  31 #include <unotools/weakref.hxx>
  32
  33 struct ImplSVEvent;
  34 class SdrView;
  35 class SdrObject;
  36 class SfxItemSet;
  37 class SvxBoxInfoItem;
  38 class SvxBoxItem;
  39
  40 namespace sdr::table {
  41
  42 class SvxTableControllerModifyListener;
  43 class TableModel;
  44
  45 class SVXCORE_DLLPUBLIC SvxTableController final : public sdr::SelectionController
  46 {
  47 public:
  48     SVX_DLLPRIVATE SvxTableController(
  49         SdrView& rView,
  50         const SdrTableObj& rObj);
  51     SVX_DLLPRIVATE virtual ~SvxTableController() override;
  52
  53     // from sdr::SelectionController
  54     SVX_DLLPRIVATE virtual bool onKeyInput(const KeyEvent& rKEvt, vcl::Window* pWin) override;
  55     SVX_DLLPRIVATE virtual bool onMouseButtonDown(const MouseEvent& rMEvt, vcl::Window* pWin) override;
  56     SVX_DLLPRIVATE virtual bool onMouseButtonUp(const MouseEvent& rMEvt, vcl::Window* pWin) override;
  57     SVX_DLLPRIVATE virtual bool onMouseMove(const MouseEvent& rMEvt, vcl::Window* pWin) override;
  58
  59     SVX_DLLPRIVATE bool HasMarked() const;
  60     SVX_DLLPRIVATE virtual bool DeleteMarked() override;
  61
  62     SVX_DLLPRIVATE virtual void onSelectionHasChanged() override;
  63     SVX_DLLPRIVATE virtual void onSelectAll() override;
  64
  65     SVX_DLLPRIVATE virtual void GetState( SfxItemSet& rSet ) override;
  66     virtual void Execute( SfxRequest& rReq ) override;
  67
  68     SVX_DLLPRIVATE virtual bool GetStyleSheet( SfxStyleSheet* &rpStyleSheet ) const override;
  69     SVX_DLLPRIVATE virtual bool SetStyleSheet( SfxStyleSheet* pStyleSheet, bool bDontRemoveHardAttr ) override;
  70
  71     SVX_DLLPRIVATE virtual bool ApplyFormatPaintBrush( SfxItemSet& rFormatSet, sal_Int16 nDepth, bool bNoCharacterFormats, bool bNoParagraphFormats ) override;
  72
  73     // slots
  74     SVX_DLLPRIVATE void onInsert( sal_uInt16 nSId, const SfxItemSet* pArgs = nullptr );
  75     SVX_DLLPRIVATE void onDelete( sal_uInt16 nSId );
  76     SVX_DLLPRIVATE void onSelect( sal_uInt16 nSId );
  77     SVX_DLLPRIVATE void onFormatTable(const SfxRequest& rReq);
  78     SVX_DLLPRIVATE void MergeMarkedCells();
  79     SVX_DLLPRIVATE void SplitMarkedCells(const SfxRequest& rReq);
  80     SVX_DLLPRIVATE void DistributeColumns( const bool bOptimize, const bool bMinimize );
  81     SVX_DLLPRIVATE void DistributeRows( const bool bOptimize, const bool bMinimize );
  82     SVX_DLLPRIVATE void SetVertical( sal_uInt16 nSId );
  83     SVX_DLLPRIVATE void changeTableEdge(const SfxRequest& rReq);
  84
  85     SVX_DLLPRIVATE static rtl::Reference< sdr::SelectionController > create(
  86         SdrView& rView,
  87         const SdrTableObj& rObj,
  88         const rtl::Reference< sdr::SelectionController >& xRefController);
  89
  90     static SvxBoxItem TextDistancesToSvxBoxItem(const SfxItemSet& rAttrSet);
  91     static void SvxBoxItemToTextDistances(const SvxBoxItem& pOriginalItem, SfxItemSet& rAttrSet);
  92
  93     SVX_DLLPRIVATE void MergeAttrFromSelectedCells(SfxItemSet& rAttr, bool bOnlyHardAttr) const;
  94     SVX_DLLPRIVATE void SetAttrToSelectedCells(const SfxItemSet& rAttr, bool bReplaceAll);
  95     void SetAttrToSelectedShape(const SfxItemSet& rAttr);
  96     /** Fill the values that are common for all selected cells.
  97       *
  98       * This lets the Borders dialog to display the line arrangement
  99       * properly.
 100       */
 101     SVX_DLLPRIVATE void FillCommonBorderAttrFromSelectedCells(SvxBoxItem& rBox, SvxBoxInfoItem& rBoxInfo) const;
 102
 103     SVX_DLLPRIVATE virtual bool GetAttributes(SfxItemSet& rTargetSet, bool bOnlyHardAttr) const override;
 104     SVX_DLLPRIVATE virtual bool SetAttributes(const SfxItemSet& rSet, bool bReplaceAll) override;
 105
 106     SVX_DLLPRIVATE virtual rtl::Reference<SdrObject> GetMarkedSdrObjClone( SdrModel& rTargetModel ) override;
 107     SVX_DLLPRIVATE virtual bool PasteObjModel( const SdrModel& rModel ) override;
 108
 109     SVX_DLLPRIVATE virtual bool hasSelectedCells() const override { return mbCellSelectionMode || mrView.IsTextEdit(); }
 110     /// @see sdr::SelectionController::setCursorLogicPosition().
 111     SVX_DLLPRIVATE virtual bool setCursorLogicPosition(const Point& rPosition, bool bPoint) override;
 112
 113     /// @see sdr::SelectionController::getSelectedCells().
 114     void getSelectedCells( CellPos& rFirstPos, CellPos& rLastPos ) override;
 115     void setSelectedCells( const CellPos& rFirstPos, const CellPos& rLastPos );
 116
 117     virtual bool ChangeFontSize(bool bGrow, const FontList* pFontList) override;
 118
 119     void clearSelection();
 120     void selectAll();
 121
 122     SVX_DLLPRIVATE void onTableModified();
 123
 124     bool selectRow( sal_Int32 row );
 125     bool selectColumn( sal_Int32 column );
 126     bool deselectRow( sal_Int32 row );
 127     bool deselectColumn( sal_Int32 column );
 128     bool isRowSelected( sal_Int32 nRow );
 129     bool isColumnSelected( sal_Int32 nColumn );
 130     bool isRowHeader();
 131     bool isColumnHeader();
 132     sdr::table::SdrTableObj* GetTableObj() { return mxTableObj.get().get(); }
 133 private:
 134     SvxTableController(SvxTableController const &) = delete;
 135     SvxTableController& operator =(SvxTableController const &) = delete;
 136
 137     // internals
 138     enum class TblAction
 139     {
 140         NONE,
 141         GotoFirstCell, GotoFirstColumn, GotoFirstRow,
 142         GotoLeftCell, GotoUpCell, GotoRightCell, GotoDownCell,
 143         GotoLastCell, GotoLastColumn, GotoLastRow,
 144         EditCell, StopTextEdit,
 145         RemoveSelection,
 146         HandledByView, Tab
 147     };
 148     SVX_DLLPRIVATE void ApplyBorderAttr( const SfxItemSet& rAttr );
 149     SVX_DLLPRIVATE void UpdateTableShape();
 150
 151     SVX_DLLPRIVATE void SetTableStyle( const SfxItemSet* pArgs );
 152     SVX_DLLPRIVATE void SetTableStyleSettings( const SfxItemSet* pArgs );
 153
 154     SVX_DLLPRIVATE bool PasteObject( SdrTableObj const * pPasteTableObj );
 155
 156     SVX_DLLPRIVATE bool checkTableObject();
 157     SVX_DLLPRIVATE const CellPos& getSelectionStart();
 158     SVX_DLLPRIVATE void setSelectionStart( const CellPos& rPos );
 159     SVX_DLLPRIVATE const CellPos& getSelectionEnd();
 160     SVX_DLLPRIVATE void checkCell( CellPos& rPos ) const;
 161
 162     SVX_DLLPRIVATE void MergeRange( sal_Int32 nFirstCol, sal_Int32 nFirstRow, sal_Int32 nLastCol, sal_Int32 nLastRow );
 163
 164     SVX_DLLPRIVATE void EditCell(const CellPos& rPos, vcl::Window* pWindow, TblAction nAction);
 165     SVX_DLLPRIVATE void StopTextEdit();
 166
 167     SVX_DLLPRIVATE TblAction getKeyboardAction(const KeyEvent& rKEvt);
 168     SVX_DLLPRIVATE bool executeAction(TblAction nAction, bool bSelect, vcl::Window* pWindow);
 169     SVX_DLLPRIVATE void gotoCell(const CellPos& rCell, bool bSelect, vcl::Window* pWindow, TblAction nAction = TblAction::NONE);
 170
 171     SVX_DLLPRIVATE void StartSelection( const CellPos& rPos );
 172     SVX_DLLPRIVATE void UpdateSelection( const CellPos& rPos );
 173     SVX_DLLPRIVATE void RemoveSelection();
 174     SVX_DLLPRIVATE void updateSelectionOverlay();
 175     SVX_DLLPRIVATE void destroySelectionOverlay();
 176
 177     SVX_DLLPRIVATE void findMergeOrigin( CellPos& rPos );
 178
 179     DECL_DLLPRIVATE_LINK( UpdateHdl, void *, void );
 180
 181     //TableModelRef mxTable;
 182     rtl::Reference< TableModel > mxTable;
 183
 184     CellPos maCursorFirstPos;
 185     CellPos maCursorLastPos;
 186     bool mbCellSelectionMode;
 187     bool mbHasJustMerged;
 188     CellPos maMouseDownPos;
 189     bool mbLeftButtonDown;
 190     std::optional<sdr::overlay::OverlayObjectList>  mpSelectionOverlay;
 191     SdrView& mrView;
 192     unotools::WeakReference<SdrTableObj> mxTableObj;
 193     rtl::Reference< SvxTableControllerModifyListener > mxModifyListener;
 194     ImplSVEvent * mnUpdateEvent;
 195 };
 196
 197 rtl::Reference< sdr::SelectionController > CreateTableController(
 198      SdrView& rView,
 199      const SdrTableObj& rObj,
 200      const rtl::Reference< sdr::SelectionController >& xRefController );
 201
 202 }
 203
 204 #endif // INCLUDED_SVX_SDR_TABLE_TABLECONTROLLER_HXX
 205
 206 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */