include/svx/svdotable.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 #pragma once
  21
  22 #include <com/sun/star/text/WritingMode.hpp>
  23 #include <com/sun/star/container/XIndexAccess.hpp>
  24 #include <com/sun/star/table/XTable.hpp>
  25 #include <rtl/ref.hxx>
  26 #include <svx/svdotext.hxx>
  27 #include <svx/svxdllapi.h>
  28 #include <boost/property_tree/ptree_fwd.hpp>
  29
  30 class SvStream;
  31 class SfxStyleSheet;
  32 class SdrUndoAction;
  33
  34 namespace sdr::contact {
  35     class ViewContactOfTableObj;
  36 }
  37
  38 namespace sdr::table {
  39
  40 class TableLayouter;
  41 struct ImplTableShadowPaintInfo;
  42
  43 #ifndef CellRef
  44     class Cell;
  45     typedef rtl::Reference< Cell > CellRef;
  46 #endif
  47
  48
  49 /// SdrTableHitKind
  50 enum class TableHitKind
  51 {
  52     NONE,
  53     Cell,
  54     CellTextArea,
  55     HorizontalBorder,
  56     VerticallBorder
  57 };
  58
  59
  60 struct CellPos
  61 {
  62     sal_Int32 mnCol;
  63     sal_Int32 mnRow;
  64
  65     CellPos() : mnCol( 0 ), mnRow( 0 ) {}
  66     CellPos( sal_Int32 nCol, sal_Int32 nRow ) { mnCol = nCol; mnRow = nRow; }
  67
  68     bool operator==( const CellPos& r ) const { return (r.mnCol == mnCol) && (r.mnRow == mnRow); }
  69     bool operator!=( const CellPos& r ) const { return (r.mnCol != mnCol) || (r.mnRow != mnRow); }
  70 };
  71
  72
  73 /// TableStyleSettings
  74 struct TableStyleSettings
  75 {
  76     bool mbUseFirstRow;
  77     bool mbUseLastRow;
  78     bool mbUseFirstColumn;
  79     bool mbUseLastColumn;
  80     bool mbUseRowBanding;
  81     bool mbUseColumnBanding;
  82
  83     TableStyleSettings();
  84     TableStyleSettings( const TableStyleSettings& rStyle );
  85     TableStyleSettings& operator=(const TableStyleSettings& rStyle);
  86
  87     bool operator==( const TableStyleSettings& r ) const;
  88 };
  89
  90 /// SdrTableObj
  91 class SdrTableObjImpl;
  92
  93 class SVXCORE_DLLPUBLIC SdrTableObj final : public ::SdrTextObj
  94 {
  95     friend class Cell;
  96     friend class SdrTableObjImpl;
  97
  98     // protected destructor
  99     virtual ~SdrTableObj() override;
 100
 101 public:
 102     SdrTableObj(SdrModel& rSdrModel);
 103     // Copy constructor
 104     SdrTableObj(SdrModel& rSdrModel, SdrTableObj const & rSource);
 105     SdrTableObj(
 106         SdrModel& rSdrModel,
 107         const ::tools::Rectangle& rNewRect,
 108         sal_Int32 nColumns,
 109         sal_Int32 nRows);
 110
 111     // helper to limit existing TableModel to a given selection
 112     void CropTableModelToSelection(const CellPos& rStart, const CellPos& rEnd);
 113
 114     // Table stuff
 115     void DistributeColumns( sal_Int32 nFirstColumn, sal_Int32 nLastColumn, const bool bOptimize, const bool bMinimize );
 116     void DistributeRows( sal_Int32 nFirstRow, sal_Int32 nLastRow, const bool bOptimize, const bool bMinimize );
 117
 118     css::uno::Reference< css::table::XTable > getTable() const;
 119
 120     bool isValid( const sdr::table::CellPos& rPos ) const;
 121     static CellPos getFirstCell();
 122     CellPos getLastCell() const;
 123     CellPos getLeftCell( const CellPos& rPos, bool bEdgeTravel ) const;
 124     CellPos getRightCell( const CellPos& rPos, bool bEdgeTravel  ) const;
 125     CellPos getUpCell( const CellPos& rPos, bool bEdgeTravel ) const;
 126     CellPos getDownCell( const CellPos& rPos, bool bEdgeTravel ) const;
 127     CellPos getPreviousCell( const CellPos& rPos, bool bEdgeTravel ) const;
 128     CellPos getNextCell( const CellPos& rPos, bool bEdgeTravel ) const;
 129     CellPos getPreviousRow( const CellPos& rPos, bool bEdgeTravel ) const;
 130     CellPos getNextRow( const CellPos& rPos, bool bEdgeTravel ) const;
 131
 132     void createCell( sdr::table::CellRef& xCell );
 133
 134     const sdr::table::TableStyleSettings& getTableStyleSettings() const;
 135     void setTableStyleSettings( const sdr::table::TableStyleSettings& rStyle );
 136
 137     TableHitKind CheckTableHit( const Point& rPos, sal_Int32& rnX, sal_Int32& rnY, const sal_uInt16 aTol = 0 ) const;
 138
 139     void uno_lock();
 140     void uno_unlock();
 141
 142     /** The active table has the focus or is currently edited */
 143     const sdr::table::CellRef& getActiveCell() const;
 144
 145     void setActiveCell( const sdr::table::CellPos& rPos );
 146     void getActiveCellPos( sdr::table::CellPos& rPos ) const;
 147     sal_Int32 getColumnCount() const;
 148     sal_Int32 getRowCount() const;
 149
 150     bool createTableEdgesJson(boost::property_tree::ptree & rJsonRoot);
 151     void changeEdge(bool bHorizontal, int nEdge, sal_Int32 nOffset);
 152
 153     void getCellBounds( const sdr::table::CellPos& rPos, ::tools::Rectangle& rCellRect );
 154
 155     const SfxItemSet& GetActiveCellItemSet() const;
 156
 157      void setTableStyle( const css::uno::Reference< css::container::XIndexAccess >& xAutoFormatStyle );
 158      const css::uno::Reference< css::container::XIndexAccess >& getTableStyle() const;
 159
 160     // Text stuff
 161
 162     /** Returns the currently active text */
 163     virtual SdrText* getActiveText() const override;
 164
 165     /** Returns the nth available text */
 166     virtual SdrText* getText( sal_Int32 nIndex ) const override;
 167
 168     /** Returns the number of texts available for this object */
 169     virtual sal_Int32 getTextCount() const override;
 170
 171     /** Changes the current active text */
 172     virtual void setActiveText( sal_Int32 nIndex ) override;
 173
 174     /** Returns the index of the text that contains the given point or -1 */
 175     virtual sal_Int32 CheckTextHit(const Point& rPnt) const override;
 176
 177     // #i121917#
 178     virtual bool HasText() const override;
 179
 180     bool IsTextEditActive() const { return mpEditingOutliner != nullptr; }
 181     bool IsTextEditActive( const sdr::table::CellPos& rPos );
 182
 183     /** Returns true only if we are in edit mode and the user actually changed anything */
 184     virtual bool IsReallyEdited() const override;
 185
 186     /** At the same time, we set the text in the outliner (if applicable the EditOutliners')
 187      * as well as the PaperSize
 188      */
 189     void TakeTextRect( const sdr::table::CellPos& rPos, SdrOutliner& rOutliner, ::tools::Rectangle& rTextRect, bool bNoEditText, ::tools::Rectangle* pAnchorRect ) const;
 190     virtual void TakeTextRect( SdrOutliner& rOutliner, tools::Rectangle& rTextRect, bool bNoEditText, tools::Rectangle* pAnchorRect, bool bLineWidth = true ) const override;
 191     void TakeTextAnchorRect(const sdr::table::CellPos& rPos, ::tools::Rectangle& rAnchorRect ) const;
 192     virtual void TakeTextAnchorRect(::tools::Rectangle& rAnchorRect) const override;
 193
 194     virtual bool IsAutoGrowHeight() const override;
 195     virtual bool IsAutoGrowWidth() const override;
 196
 197     virtual bool IsFontwork() const override;
 198
 199     virtual void TakeObjInfo(SdrObjTransformInfoRec& rInfo) const override;
 200     virtual SdrObjKind GetObjIdentifier() const override;
 201     virtual void SetChanged() override;
 202
 203     virtual bool AdjustTextFrameWidthAndHeight(tools::Rectangle& rR, bool bHgt = true, bool bWdt = true) const override;
 204     virtual bool AdjustTextFrameWidthAndHeight() override;
 205     virtual OUString TakeObjNameSingul() const override;
 206     virtual OUString TakeObjNamePlural() const override;
 207     virtual rtl::Reference<SdrObject> CloneSdrObject(SdrModel& rTargetModel) const override;
 208     virtual void RecalcSnapRect() override;
 209     virtual const tools::Rectangle& GetSnapRect() const override;
 210     virtual void NbcSetSnapRect(const tools::Rectangle& rRect) override;
 211
 212     virtual const tools::Rectangle& GetLogicRect() const override;
 213     virtual void NbcSetLogicRect(const tools::Rectangle& rRect) override;
 214     virtual void AdjustToMaxRect( const tools::Rectangle& rMaxRect, bool bShrinkOnly = false ) override;
 215
 216     virtual sal_uInt32 GetHdlCount() const override;
 217     virtual void AddToHdlList(SdrHdlList& rHdlList) const override;
 218
 219     // Special drag methods
 220     virtual bool hasSpecialDrag() const override;
 221     virtual bool beginSpecialDrag(SdrDragStat& rDrag) const override;
 222     virtual bool applySpecialDrag(SdrDragStat& rDrag) override;
 223     virtual basegfx::B2DPolyPolygon getSpecialDragPoly(const SdrDragStat& rDrag) const override;
 224
 225     virtual bool BegCreate(SdrDragStat& rStat) override;
 226     virtual bool MovCreate(SdrDragStat& rStat) override;
 227     virtual bool EndCreate(SdrDragStat& rStat, SdrCreateCmd eCmd) override;
 228     virtual bool BckCreate(SdrDragStat& rStat) override;
 229     virtual void BrkCreate(SdrDragStat& rStat) override;
 230     virtual basegfx::B2DPolyPolygon TakeCreatePoly(const SdrDragStat& rDrag) const override;
 231     virtual PointerStyle GetCreatePointer() const override;
 232
 233     virtual void NbcMove(const Size& rSiz) override;
 234     virtual void NbcResize(const Point& rRef, const Fraction& xFact, const Fraction& yFact) override;
 235
 236     virtual bool BegTextEdit(SdrOutliner& rOutl) override;
 237     virtual void EndTextEdit(SdrOutliner& rOutl) override;
 238     virtual void TakeTextEditArea(Size* pPaperMin, Size* pPaperMax, tools::Rectangle* pViewInit, tools::Rectangle* pViewMin) const override;
 239     void TakeTextEditArea(const sdr::table::CellPos& rPos, Size* pPaperMin, Size* pPaperMax, tools::Rectangle* pViewInit, tools::Rectangle* pViewMin) const;
 240     virtual EEAnchorMode GetOutlinerViewAnchorMode() const override;
 241
 242     virtual void NbcSetOutlinerParaObject(std::optional<OutlinerParaObject> pTextObject) override;
 243
 244     virtual OutlinerParaObject* GetOutlinerParaObject() const override;
 245
 246     virtual void NbcReformatText() override;
 247
 248     virtual bool IsVerticalWriting() const override;
 249     virtual void SetVerticalWriting(bool bVertical) override;
 250
 251     css::text::WritingMode GetWritingMode() const;
 252
 253     /// Add an undo action that should be on the undo stack after ending text edit.
 254     void AddUndo(SdrUndoAction* pUndo);
 255
 256     /// Next time layouting would be done, skip it (to layout at the end of multiple actions).
 257     void SetSkipChangeLayout(bool bSkipChangeLayout);
 258
 259     void LayoutTableHeight(tools::Rectangle& rArea, bool bFit);
 260
 261     virtual void onEditOutlinerStatusEvent( EditStatus* pEditStatus ) override;
 262
 263     virtual void dumpAsXml(xmlTextWriterPtr pWriter) const override;
 264
 265     const TableLayouter& getTableLayouter() const;
 266
 267 private:
 268     void init( sal_Int32 nColumns, sal_Int32 nRows );
 269
 270     virtual std::unique_ptr<sdr::properties::BaseProperties> CreateObjectSpecificProperties() override;
 271     virtual std::unique_ptr<sdr::contact::ViewContact> CreateObjectSpecificViewContact() override;
 272
 273     virtual std::unique_ptr<SdrObjGeoData> NewGeoData() const override;
 274     virtual void SaveGeoData(SdrObjGeoData& rGeo) const override;
 275     virtual void RestoreGeoData(const SdrObjGeoData& rGeo) override;
 276
 277     SdrOutliner* GetCellTextEditOutliner( const sdr::table::Cell& rCell ) const;
 278
 279     tools::Rectangle   maLogicRect;
 280     rtl::Reference<SdrTableObjImpl> mpImpl;
 281 };
 282
 283 /** Hack for clipboard with calc and writer, export and import table content as rtf table */
 284 SVX_DLLPUBLIC void ExportAsRTF( SvStream& rStrm, SdrTableObj& rObj );
 285 SVX_DLLPUBLIC void ImportAsRTF( SvStream& rStrm, SdrTableObj& rObj );
 286
 287 }
 288
 289 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */