sc/source/filter/inc/xecontent.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: xecontent.hxx,v $
  10  * $Revision: 1.14 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SC_XECONTENT_HXX
  32 #define SC_XECONTENT_HXX
  33
  34 #include "rangelst.hxx"
  35 #include "xlcontent.hxx"
  36 #include "xladdress.hxx"
  37 #include "xerecord.hxx"
  38 #include "xeroot.hxx"
  39 #include "xestring.hxx"
  40 #include "xeformula.hxx"
  41
  42 /* ============================================================================
  43 Classes to export the big Excel document contents (related to several cells or
  44 globals for the sheet or document).
  45 - Shared string table
  46 - Merged cells
  47 - Hyperlinks
  48 - Label ranges
  49 - Conditional formatting
  50 - Data validation
  51 - Web Queries
  52 ============================================================================ */
  53
  54 // Shared string table ========================================================
  55
  56 class XclExpSstImpl;
  57
  58 /** Provides export of the SST (shared string table) record.
  59     @descr  Contains all strings in the document and writes the SST. */
  60 class XclExpSst : public XclExpRecordBase
  61 {
  62 public:
  63     explicit            XclExpSst();
  64     virtual             ~XclExpSst();
  65
  66     /** Inserts a new string into the table.
  67         @return  The index of the string in the SST, used in other records. */
  68     sal_uInt32          Insert( XclExpStringRef xString );
  69
  70     /** Writes the complete SST and EXTSST records. */
  71     virtual void        Save( XclExpStream& rStrm );
  72     virtual void        SaveXml( XclExpXmlStream& rStrm );
  73
  74 private:
  75     typedef ::std::auto_ptr< XclExpSstImpl > XclExpSstImplPtr;
  76     XclExpSstImplPtr    mxImpl;
  77 };
  78
  79 // Merged cells ===============================================================
  80
  81 /** Represents a MERGEDCELLS record containing all merged cell ranges in a sheet. */
  82 class XclExpMergedcells : public XclExpRecordBase, protected XclExpRoot
  83 {
  84 public:
  85     explicit            XclExpMergedcells( const XclExpRoot& rRoot );
  86
  87     /** Appends a new range to the list of merged cell ranges. */
  88     void                AppendRange( const ScRange& rRange, sal_uInt32 nBaseXFId );
  89     /** Returns the XF identifier of the top-left cell in a merged range. */
  90     sal_uInt32          GetBaseXFId( const ScAddress& rPos ) const;
  91
  92     /** Writes the record, if it contains at least one merged cell range. */
  93     virtual void        Save( XclExpStream& rStrm );
  94     virtual void        SaveXml( XclExpXmlStream& rStrm );
  95
  96 private:
  97     ScRangeList         maMergedRanges;     /// All merged cell ranges of the sheet.
  98     ScfUInt32Vec        maBaseXFIds;        /// The XF identifiers of the top-left cells.
  99 };
 100
 101 // Hyperlinks =================================================================
 102
 103 class SvxURLField;
 104 class INetURLObject;
 105
 106 /** Provides export of hyperlink data. */
 107 class XclExpHyperlink : public XclExpRecord
 108 {
 109 public:
 110     /** Constructs the HLINK record from an URL text field. */
 111     explicit            XclExpHyperlink( const XclExpRoot& rRoot,
 112                             const SvxURLField& rUrlField, const ScAddress& rScPos );
 113     virtual             ~XclExpHyperlink();
 114
 115     /** Returns the cell representation text or 0, if not available. */
 116     inline const String* GetRepr() const { return mxRepr.get(); }
 117
 118     virtual void        SaveXml( XclExpXmlStream& rStrm );
 119
 120     virtual void        WriteEmbeddedData( XclExpStream& rStrm );
 121 private:
 122     /** Builds file name from the passed file URL. Tries to convert to relative file name.
 123         @param rnLevel  (out-param) The parent directory level.
 124         @param rbRel  (out-param) true = path is relative. */
 125     String              BuildFileName(
 126                             sal_uInt16& rnLevel, bool& rbRel,
 127                             const String& rUrl, const XclExpRoot& rRoot ) const;
 128
 129     /** Writes the body of the HLINK record. */
 130     virtual void        WriteBody( XclExpStream& rStrm );
 131
 132 private:
 133     typedef ::std::auto_ptr< String >   StringPtr;
 134     typedef ::std::auto_ptr< SvStream > SvStreamPtr;
 135
 136     ScAddress           maScPos;            /// Position of the hyperlink.
 137     StringPtr           mxRepr;             /// Cell representation text.
 138     SvStreamPtr         mxVarData;          /// Buffer stream with variable data.
 139     sal_uInt32          mnFlags;            /// Option flags.
 140     XclExpStringRef     mxTextMark;         /// Location within mxRepr
 141     ::rtl::OUString     msTarget;           /// Target URL
 142 };
 143
 144 typedef XclExpRecordList< XclExpHyperlink > XclExpHyperlinkList;
 145
 146 // Label ranges ===============================================================
 147
 148 /** Provides export of the row/column label range list of a sheet. */
 149 class XclExpLabelranges : public XclExpRecordBase, protected XclExpRoot
 150 {
 151 public:
 152     /** Fills the cell range lists with all ranges of the current sheet. */
 153     explicit            XclExpLabelranges( const XclExpRoot& rRoot );
 154
 155     /** Writes the LABELRANGES record if it contains at least one range. */
 156     virtual void        Save( XclExpStream& rStrm );
 157
 158 private:
 159     /** Fills the specified range list with all label headers of the current sheet.
 160         @param rRanges  The cell range list to fill.
 161         @param xLabelRangesRef  The core range list with all ranges.
 162         @param nScTab  The current Calc sheet index. */
 163     void                FillRangeList( ScRangeList& rScRanges,
 164                             ScRangePairListRef xLabelRangesRef, SCTAB nScTab );
 165
 166 private:
 167     ScRangeList         maRowRanges;    /// Cell range list for row labels.
 168     ScRangeList         maColRanges;    /// Cell range list for column labels.
 169 };
 170
 171 // Conditional formatting =====================================================
 172
 173 class ScCondFormatEntry;
 174 class XclExpCFImpl;
 175
 176 /** Represents a CF record that contains one condition of a conditional format. */
 177 class XclExpCF : public XclExpRecord, protected XclExpRoot
 178 {
 179 public:
 180     explicit            XclExpCF( const XclExpRoot& rRoot, const ScCondFormatEntry& rFormatEntry );
 181     virtual             ~XclExpCF();
 182
 183 private:
 184     /** Writes the body of the CF record. */
 185     virtual void        WriteBody( XclExpStream& rStrm );
 186
 187 private:
 188     typedef ::std::auto_ptr< XclExpCFImpl > XclExpCFImplPtr;
 189     XclExpCFImplPtr     mxImpl;
 190 };
 191
 192 // ----------------------------------------------------------------------------
 193
 194 class ScConditionalFormat;
 195
 196 /** Represents a CONDFMT record that contains all conditions of a conditional format.
 197     @descr  Contains the conditions which are stored in CF records. */
 198 class XclExpCondfmt : public XclExpRecord, protected XclExpRoot
 199 {
 200 public:
 201     explicit            XclExpCondfmt( const XclExpRoot& rRoot, const ScConditionalFormat& rCondFormat );
 202     virtual             ~XclExpCondfmt();
 203
 204     /** Returns true, if this conditional format contains at least one cell range and CF record. */
 205     bool                IsValid() const;
 206
 207     /** Writes the CONDFMT record with following CF records, if there is valid data. */
 208     virtual void        Save( XclExpStream& rStrm );
 209     virtual void        SaveXml( XclExpXmlStream& rStrm );
 210
 211 private:
 212     /** Writes the body of the CONDFMT record. */
 213     virtual void        WriteBody( XclExpStream& rStrm );
 214
 215 private:
 216     typedef XclExpRecordList< XclExpCF > XclExpCFList;
 217
 218     XclExpCFList        maCFList;       /// List of CF records.
 219     XclRangeList        maXclRanges;    /// Cell ranges for this conditional format.
 220     String              msSeqRef;       /// OOXML Sequence of References
 221 };
 222
 223 // ----------------------------------------------------------------------------
 224
 225 /** Contains all conditional formats of a specific sheet. */
 226 class XclExpCondFormatBuffer : public XclExpRecordBase, protected XclExpRoot
 227 {
 228 public:
 229     /** Constructs CONDFMT and CF records containing the conditional formats of the current sheet. */
 230     explicit            XclExpCondFormatBuffer( const XclExpRoot& rRoot );
 231
 232     /** Writes all contained CONDFMT records with their CF records. */
 233     virtual void        Save( XclExpStream& rStrm );
 234     virtual void        SaveXml( XclExpXmlStream& rStrm );
 235
 236 private:
 237     typedef XclExpRecordList< XclExpCondfmt > XclExpCondfmtList;
 238     XclExpCondfmtList   maCondfmtList;  /// List of CONDFMT records.
 239 };
 240
 241 // Data Validation ============================================================
 242
 243 class ScValidationData;
 244
 245 /** Provides export of the data of a DV record.
 246     @descr  This record contains the settings for a data validation. In detail
 247     this is a pointer to the core validation data and a cell range list with all
 248     affected cells. The handle index is used to optimize list search algorithm. */
 249 class XclExpDV : public XclExpRecord, protected XclExpRoot
 250 {
 251 public:
 252     explicit            XclExpDV( const XclExpRoot& rRoot, ULONG nScHandle );
 253     virtual             ~XclExpDV();
 254
 255     /** Returns the core handle of the validation data. */
 256     inline ULONG        GetScHandle() const { return mnScHandle; }
 257
 258     /** Inserts a new cell range into the cell range list. */
 259     void                InsertCellRange( const ScRange& rPos );
 260     /** Converts the Calc range list to the Excel range list.
 261         @return  false = Resulting range list empty - do not write this record. */
 262     bool                Finalize();
 263
 264     virtual void        SaveXml( XclExpXmlStream& rStrm );
 265
 266 private:
 267     /** Writes the body of the DV record. */
 268     virtual void        WriteBody( XclExpStream& rStrm );
 269
 270 private:
 271     ScRangeList         maScRanges;     /// Calc range list with all affected cells.
 272     XclRangeList        maXclRanges;    /// Excel range list with all affected cells.
 273     XclExpString        maPromptTitle;  /// The prompt title.
 274     XclExpString        maPromptText;   /// The prompt text.
 275     XclExpString        maErrorTitle;   /// The error title.
 276     XclExpString        maErrorText;    /// The error text.
 277     XclExpStringRef     mxString1;      /// String for first condition formula.
 278     XclTokenArrayRef    mxTokArr1;      /// Formula for first condition.
 279     ::rtl::OUString     msFormula1;     /// OOXML Formula for first condition.
 280     XclTokenArrayRef    mxTokArr2;      /// Formula for second condition.
 281     ::rtl::OUString     msFormula2;     /// OOXML Formula for second condition.
 282     sal_uInt32          mnFlags;        /// Miscellaneous flags.
 283     ULONG               mnScHandle;     /// The core handle for quick list search.
 284 };
 285
 286 // ----------------------------------------------------------------------------
 287
 288 /** This class contains the DV record list following the DVAL record. */
 289 class XclExpDval : public XclExpRecord, protected XclExpRoot
 290 {
 291 public:
 292     explicit            XclExpDval( const XclExpRoot& rRoot );
 293     virtual             ~XclExpDval();
 294
 295     /** Inserts the cell range into the range list of the DV record with the specified handle. */
 296     void                InsertCellRange( const ScRange& rRange, ULONG nScHandle );
 297
 298     /** Writes the DVAL record and the DV record list. */
 299     virtual void        Save( XclExpStream& rStrm );
 300     virtual void        SaveXml( XclExpXmlStream& rStrm );
 301
 302 private:
 303     /** Searches for or creates a XclExpDV record object with the specified handle. */
 304     XclExpDV&           SearchOrCreateDv( ULONG nScHandle );
 305
 306     /** Writes the body of the DVAL record. */
 307     virtual void        WriteBody( XclExpStream& rStrm );
 308
 309 private:
 310     typedef XclExpRecordList< XclExpDV >    XclExpDVList;
 311     typedef XclExpDVList::RecordRefType     XclExpDVRef;
 312
 313     XclExpDVList        maDVList;       /// List of DV records
 314     XclExpDVRef         mxLastFoundDV;  /// For search optimization.
 315 };
 316
 317 // Web Queries ================================================================
 318
 319 /** Contains all records for a web query (linked tables in an HTML document).
 320     @descr  mode 1 (entire document): mpQryTables==0, mbEntireDoc==true;
 321     mode 2 (all tables): mpQryTables==0, mbEntireDoc==false;
 322     mode 3 (custom range list): mpQryTables!=0, mbEntireDoc==false. */
 323 class XclExpWebQuery : public XclExpRecordBase
 324 {
 325 public:
 326     /** Constructs a web query record container with settings from Calc. */
 327     explicit            XclExpWebQuery(
 328                             const String& rRangeName,
 329                             const String& rUrl,
 330                             const String& rSource,
 331                             sal_Int32 nRefrSecs );
 332     virtual             ~XclExpWebQuery();
 333
 334     /** Writes all needed records for this web query. */
 335     virtual void        Save( XclExpStream& rStrm );
 336
 337 private:
 338     XclExpString        maDestRange;    /// Destination range.
 339     XclExpString        maUrl;          /// Source document URL.
 340     XclExpStringRef     mxQryTables;    /// List of source range names.
 341     sal_Int16           mnRefresh;      /// Refresh time in minutes.
 342     bool                mbEntireDoc;    /// true = entire document.
 343 };
 344
 345 // ----------------------------------------------------------------------------
 346
 347 /** Contains all web query records for this document. */
 348 class XclExpWebQueryBuffer : public XclExpRecordList< XclExpWebQuery >
 349 {
 350 public:
 351     explicit            XclExpWebQueryBuffer( const XclExpRoot& rRoot );
 352 };
 353
 354 // ============================================================================
 355
 356 #endif
 357