sc/inc/cellvalue.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
  10 #ifndef INCLUDED_SC_INC_CELLVALUE_HXX
  11 #define INCLUDED_SC_INC_CELLVALUE_HXX
  12
  13 #include "global.hxx"
  14
  15 class ScDocument;
  16 class ScFormulaCell;
  17 class EditTextObject;
  18 class ScColumn;
  19 struct ScRefCellValue;
  20
  21 namespace sc {
  22 struct ColumnBlockPosition;
  23 }
  24
  25 namespace svl {
  26
  27 class SharedString;
  28
  29 }
  30
  31 /**
  32  * Store arbitrary cell value of any kind.  It only stores cell value and
  33  * nothing else.  It creates a copy of the original cell value, and manages
  34  * the life cycle of the copied value.
  35  */
  36 struct SC_DLLPUBLIC ScCellValue
  37 {
  38     CellType meType;
  39     union {
  40         double mfValue;
  41         svl::SharedString* mpString;
  42         EditTextObject* mpEditText;
  43         ScFormulaCell* mpFormula;
  44     };
  45
  46     ScCellValue();
  47     ScCellValue( const ScRefCellValue& rCell );
  48     ScCellValue( double fValue );
  49     ScCellValue( const svl::SharedString& rString );
  50     ScCellValue( const ScCellValue& r );
  51     ScCellValue(ScCellValue&& r) noexcept;
  52     ~ScCellValue();
  53
  54     void clear() noexcept;
  55
  56     void set( double fValue );
  57     void set( const svl::SharedString& rStr );
  58     void set( const EditTextObject& rEditText );
  59     void set( EditTextObject* pEditText );
  60     void set( ScFormulaCell* pFormula );
  61
  62     /**
  63      * Take cell value from specified position in specified document.
  64      */
  65     void assign( const ScDocument& rDoc, const ScAddress& rPos );
  66
  67     void assign(const ScCellValue& rOther, ScDocument& rDestDoc, ScCloneFlags nCloneFlags = ScCloneFlags::Default);
  68
  69     /**
  70      * Set cell value at specified position in specified document.
  71      */
  72     void commit( ScDocument& rDoc, const ScAddress& rPos ) const;
  73
  74     void commit( ScColumn& rColumn, SCROW nRow ) const;
  75
  76     /**
  77      * Set cell value at specified position in specified document. But unlike
  78      * commit(), this method sets the original value to the document without
  79      * copying.  After this call, the value gets cleared.
  80      */
  81     void release( ScDocument& rDoc, const ScAddress& rPos );
  82
  83     void release( ScColumn& rColumn, SCROW nRow, sc::StartListeningType eListenType = sc::SingleCellListening );
  84
  85     OUString getString( const ScDocument& rDoc ) const;
  86
  87     bool isEmpty() const;
  88
  89     bool equalsWithoutFormat( const ScCellValue& r ) const;
  90
  91     ScCellValue& operator= ( const ScCellValue& r );
  92     ScCellValue& operator=(ScCellValue&& r) noexcept;
  93     ScCellValue& operator= ( const ScRefCellValue& r );
  94
  95     void swap( ScCellValue& r );
  96 };
  97
  98 /**
  99  * This is very similar to ScCellValue, except that it references the
 100  * original value instead of copying it.  As such, don't hold an instance of
 101  * this class any longer than necessary, and absolutely not after the
 102  * original cell has been destroyed.
 103  */
 104 struct SC_DLLPUBLIC ScRefCellValue
 105 {
 106     CellType meType;
 107     union {
 108         double mfValue;
 109         const svl::SharedString* mpString;
 110         const EditTextObject* mpEditText;
 111         ScFormulaCell* mpFormula;
 112     };
 113
 114     ScRefCellValue();
 115     ScRefCellValue( double fValue );
 116     ScRefCellValue( const svl::SharedString* pString );
 117     ScRefCellValue( const EditTextObject* pEditText );
 118     ScRefCellValue( ScFormulaCell* pFormula );
 119
 120     /**
 121      * Take cell value from specified position in specified document.
 122      */
 123     ScRefCellValue( ScDocument& rDoc, const ScAddress& rPos );
 124     ScRefCellValue( ScDocument& rDoc, const ScAddress& rPos, sc::ColumnBlockPosition& rBlockPos );
 125
 126     void clear();
 127
 128     /**
 129      * Take cell value from specified position in specified document.
 130      */
 131     void assign( ScDocument& rDoc, const ScAddress& rPos );
 132     void assign( ScDocument& rDoc, const ScAddress& rPos, sc::ColumnBlockPosition& rBlockPos );
 133
 134     /**
 135      * Set cell value at specified position in specified document.
 136      */
 137     void commit( ScDocument& rDoc, const ScAddress& rPos ) const;
 138
 139     bool hasString() const;
 140
 141     bool hasNumeric() const;
 142
 143     bool hasError() const;
 144
 145     double getValue();
 146
 147     /**
 148      * Retrieve a numeric value without modifying the states of any objects in
 149      * the referenced document store.
 150      */
 151     double getRawValue() const;
 152
 153     /**
 154      *  Retrieve string value.
 155      *
 156      *  Note that this method is NOT thread-safe.
 157      *
 158      *  @param  pDoc
 159      *          Needed to resolve EditCells' field contents, obtain a
 160      *          ScFieldEditEngine from that document. May be NULL if there is
 161      *          no ScDocument in the calling context but then the document
 162      *          specific fields can not be resolved. See
 163      *          ScEditUtil::GetString().
 164      */
 165     OUString getString( const ScDocument* pDoc ) const;
 166
 167     /**
 168      * Retrieve a string value without modifying the states of any objects in
 169      * the referenced document store.
 170      *
 171      * This method is thread-safe.
 172      */
 173     OUString getRawString( const ScDocument& rDoc ) const;
 174
 175     bool isEmpty() const;
 176
 177     bool hasEmptyValue();
 178
 179     bool equalsWithoutFormat( const ScRefCellValue& r ) const;
 180 };
 181
 182 #endif
 183
 184 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */