svx/source/inc/tablemodel.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_SOURCE_INC_TABLEMODEL_HXX
  21 #define INCLUDED_SVX_SOURCE_INC_TABLEMODEL_HXX
  22
  23 #include <sal/types.h>
  24 #include <com/sun/star/util/XBroadcaster.hpp>
  25 #include <com/sun/star/table/XTable.hpp>
  26 #include <basegfx/range/b2irectangle.hxx>
  27 #include <basegfx/tuple/b2ituple.hxx>
  28 #include <cppuhelper/compbase.hxx>
  29 #include <cppuhelper/basemutex.hxx>
  30 #include "celltypes.hxx"
  31
  32 struct _xmlTextWriter;
  33 typedef struct _xmlTextWriter* xmlTextWriterPtr;
  34
  35 namespace sdr { namespace table {
  36
  37 class SdrTableObj;
  38
  39 /** base class for each object implementing an XCellRange */
  40 class ICellRange
  41 {
  42 public:
  43     virtual sal_Int32 getLeft() = 0;
  44     virtual sal_Int32 getTop() = 0;
  45     virtual sal_Int32 getRight() = 0;
  46     virtual sal_Int32 getBottom() = 0;
  47     virtual css::uno::Reference< css::table::XTable > getTable() = 0;
  48
  49 protected:
  50     ~ICellRange() {}
  51 };
  52
  53 typedef ::cppu::WeakComponentImplHelper< css::table::XTable, css::util::XBroadcaster > TableModelBase;
  54
  55 class TableModel : public ::cppu::BaseMutex,
  56                    public TableModelBase,
  57                    public ICellRange
  58 {
  59     friend class InsertRowUndo;
  60     friend class RemoveRowUndo;
  61     friend class InsertColUndo;
  62     friend class RemoveColUndo;
  63     friend class TableColumnUndo;
  64     friend class TableRowUndo;
  65     friend class TableColumn;
  66     friend class TableRow;
  67     friend class TableRows;
  68     friend class TableColumns;
  69     friend class TableModelNotifyGuard;
  70
  71 public:
  72     explicit TableModel( SdrTableObj* pTableObj );
  73     TableModel( SdrTableObj* pTableObj, const TableModelRef& xSourceTable );
  74     virtual ~TableModel() override;
  75
  76     void init( sal_Int32 nColumns, sal_Int32 nRows );
  77
  78     SdrTableObj* getSdrTableObj() const { return mpTableObj; }
  79
  80     /** deletes rows and columns that are completely merged. Must be called between BegUndo/EndUndo! */
  81     void optimize();
  82
  83     /// merges the cell at the given position with the given span
  84     void merge( sal_Int32 nCol, sal_Int32 nRow, sal_Int32 nColSpan, sal_Int32 nRowSpan );
  85     /// Get the width of all columns in this table.
  86     std::vector<sal_Int32> getColumnWidths();
  87
  88     void dumpAsXml(xmlTextWriterPtr pWriter) const;
  89
  90     // ICellRange
  91     virtual sal_Int32 getLeft() override;
  92     virtual sal_Int32 getTop() override;
  93     virtual sal_Int32 getRight() override;
  94     virtual sal_Int32 getBottom() override;
  95     virtual css::uno::Reference< css::table::XTable > getTable() override;
  96
  97     // XTable
  98     virtual css::uno::Reference< css::table::XCellCursor > SAL_CALL createCursor(  ) override;
  99     virtual css::uno::Reference< css::table::XCellCursor > SAL_CALL createCursorByRange( const css::uno::Reference< css::table::XCellRange >& rRange ) override;
 100     virtual ::sal_Int32 SAL_CALL getRowCount() override;
 101     virtual ::sal_Int32 SAL_CALL getColumnCount() override;
 102
 103     // XComponent
 104     virtual void SAL_CALL dispose(  ) override;
 105
 106     // XModifiable
 107     virtual sal_Bool SAL_CALL isModified(  ) override;
 108     virtual void SAL_CALL setModified( sal_Bool bModified ) override;
 109
 110     // XModifyBroadcaster
 111     virtual void SAL_CALL addModifyListener( const css::uno::Reference< css::util::XModifyListener >& aListener ) override;
 112     virtual void SAL_CALL removeModifyListener( const css::uno::Reference< css::util::XModifyListener >& aListener ) override;
 113
 114     // XColumnRowRange
 115     virtual css::uno::Reference< css::table::XTableColumns > SAL_CALL getColumns() override;
 116     virtual css::uno::Reference< css::table::XTableRows > SAL_CALL getRows() override;
 117
 118     // XCellRange
 119     virtual css::uno::Reference< css::table::XCell > SAL_CALL getCellByPosition( ::sal_Int32 nColumn, ::sal_Int32 nRow ) override;
 120     virtual css::uno::Reference< css::table::XCellRange > SAL_CALL getCellRangeByPosition( ::sal_Int32 nLeft, ::sal_Int32 nTop, ::sal_Int32 nRight, ::sal_Int32 nBottom ) override;
 121     virtual css::uno::Reference< css::table::XCellRange > SAL_CALL getCellRangeByName( const OUString& aRange ) override;
 122
 123     // XPropertySet
 124     virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo(  ) override;
 125     virtual void SAL_CALL setPropertyValue( const OUString& aPropertyName, const css::uno::Any& aValue ) override;
 126     virtual css::uno::Any SAL_CALL getPropertyValue( const OUString& PropertyName ) override;
 127     virtual void SAL_CALL addPropertyChangeListener( const OUString& aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener ) override;
 128     virtual void SAL_CALL removePropertyChangeListener( const OUString& aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener >& aListener ) override;
 129     virtual void SAL_CALL addVetoableChangeListener( const OUString& PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;
 130     virtual void SAL_CALL removeVetoableChangeListener( const OUString& PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;
 131
 132     // XFastPropertySet
 133     virtual void SAL_CALL setFastPropertyValue( ::sal_Int32 nHandle, const css::uno::Any& aValue ) override;
 134     virtual css::uno::Any SAL_CALL getFastPropertyValue( ::sal_Int32 nHandle ) override;
 135
 136     // XBroadcaster
 137     virtual void SAL_CALL lockBroadcasts() override;
 138     virtual void SAL_CALL unlockBroadcasts() override;
 139
 140 protected:
 141     void notifyModification();
 142
 143     void insertColumns( sal_Int32 nIndex, sal_Int32 nCount );
 144     void removeColumns( sal_Int32 nIndex, sal_Int32 nCount );
 145     void insertRows( sal_Int32 nIndex, sal_Int32 nCount );
 146     void removeRows( sal_Int32 nIndex, sal_Int32 nCount );
 147
 148     sal_Int32 getRowCountImpl() const;
 149     sal_Int32 getColumnCountImpl() const;
 150
 151     CellRef createCell();
 152     CellRef getCell( ::sal_Int32 nCol, ::sal_Int32 nRow ) const;
 153
 154     void UndoInsertRows( sal_Int32 nIndex, sal_Int32 nCount );
 155     void UndoRemoveRows( sal_Int32 nIndex, RowVector& aNewRows );
 156
 157     void UndoInsertColumns( sal_Int32 nIndex, sal_Int32 nCount );
 158     void UndoRemoveColumns( sal_Int32 nIndex, ColumnVector& aNewCols, CellVector& aCells );
 159
 160 private:
 161     /** this function is called upon disposing the component
 162     */
 163     virtual void SAL_CALL disposing() override;
 164
 165     /// @throws css::lang::IndexOutOfBoundsException
 166     TableRowRef const & getRow( sal_Int32 nRow ) const;
 167     /// @throws css::lang::IndexOutOfBoundsException
 168     TableColumnRef const & getColumn( sal_Int32 nColumn ) const;
 169
 170     void updateRows();
 171     void updateColumns();
 172
 173     RowVector       maRows;
 174     ColumnVector    maColumns;
 175
 176     rtl::Reference< TableColumns > mxTableColumns;
 177     rtl::Reference< TableRows >    mxTableRows;
 178
 179     SdrTableObj* mpTableObj; // TTTT should be reference
 180
 181     bool mbModified;
 182     bool mbNotifyPending;
 183
 184     sal_Int32 mnNotifyLock;
 185 };
 186
 187 class TableModelNotifyGuard
 188 {
 189 public:
 190     explicit TableModelNotifyGuard( TableModel* pModel )
 191     : mxBroadcaster( static_cast< css::util::XBroadcaster* >( pModel ) )
 192     {
 193         if( mxBroadcaster.is() )
 194             mxBroadcaster->lockBroadcasts();
 195     }
 196
 197     ~TableModelNotifyGuard()
 198     {
 199         if( mxBroadcaster.is() )
 200             mxBroadcaster->unlockBroadcasts();
 201     }
 202
 203 private:
 204     css::uno::Reference< css::util::XBroadcaster > mxBroadcaster;
 205 };
 206
 207 } }
 208
 209 #endif
 210
 211 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */