sc/source/filter/inc/xepage.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef SC_XEPAGE_HXX
  29 #define SC_XEPAGE_HXX
  30
  31 #include "xerecord.hxx"
  32 #include "xlpage.hxx"
  33 #include "xeroot.hxx"
  34
  35 // Page settings records ======================================================
  36
  37 // Header/footer --------------------------------------------------------------
  38
  39 /** Represents a HEADER or FOOTER record. */
  40 class XclExpHeaderFooter : public XclExpRecord
  41 {
  42 public:
  43     explicit            XclExpHeaderFooter( sal_uInt16 nRecId, const String& rHdrString );
  44
  45     virtual void        SaveXml( XclExpXmlStream& rStrm );
  46 private:
  47     /** Writes the header or footer string. Writes an empty record, if no header/footer present. */
  48     virtual void        WriteBody( XclExpStream& rStrm );
  49
  50 private:
  51     String              maHdrString;        /// Header or footer contents.
  52 };
  53
  54 // General page settings ------------------------------------------------------
  55
  56 /** Represents a SETUP record that contains common page settings. */
  57 class XclExpSetup : public XclExpRecord
  58 {
  59 public:
  60     explicit            XclExpSetup( const XclPageData& rPageData );
  61
  62     virtual void        SaveXml( XclExpXmlStream& rStrm );
  63 private:
  64     /** Writes the contents of the SETUP record. */
  65     virtual void        WriteBody( XclExpStream& rStrm );
  66
  67 private:
  68     const XclPageData&  mrData;             /// Page settings data of current sheet.
  69 };
  70
  71 // Manual page breaks ---------------------------------------------------------
  72
  73 /** Stores an array of manual page breaks for columns or rows. */
  74 class XclExpPageBreaks : public XclExpRecord
  75 {
  76 public:
  77     explicit            XclExpPageBreaks(
  78                             sal_uInt16 nRecId,
  79                             const ScfUInt16Vec& rPageBreaks,
  80                             sal_uInt16 nMaxPos );
  81
  82     /** Writes the record, if the list is not empty. */
  83     virtual void        Save( XclExpStream& rStrm );
  84     virtual void        SaveXml( XclExpXmlStream& rStrm );
  85
  86 private:
  87     /** Writes the page break list. */
  88     virtual void        WriteBody( XclExpStream& rStrm );
  89
  90 private:
  91     const ScfUInt16Vec& mrPageBreaks;       /// Page settings data of current sheet.
  92     sal_uInt16          mnMaxPos;           /// Maximum row/column for BIFF8 page breaks.
  93 };
  94
  95 // Page settings ==============================================================
  96
  97 /** Contains all page (print) settings records for a single sheet. */
  98 class XclExpPageSettings : public XclExpRecordBase, protected XclExpRoot
  99 {
 100 public:
 101     /** Creates all records containing the current page settings. */
 102     explicit            XclExpPageSettings( const XclExpRoot& rRoot );
 103
 104     /** Returns read-only access to the page data. */
 105     inline const XclPageData& GetPageData() const { return maData; }
 106
 107     /** Writes all page settings records to the stream. */
 108     virtual void        Save( XclExpStream& rStrm );
 109     virtual void        SaveXml( XclExpXmlStream& rStrm );
 110
 111 private:
 112     XclPageData         maData;         /// Page settings data.
 113 };
 114
 115 // ----------------------------------------------------------------------------
 116
 117 /** Contains all page (print) settings records for a chart object. */
 118 class XclExpChartPageSettings : public XclExpRecordBase, protected XclExpRoot
 119 {
 120 public:
 121     /** Creates all records containing the current page settings. */
 122     explicit            XclExpChartPageSettings( const XclExpRoot& rRoot );
 123
 124     /** Returns read-only access to the page data. */
 125     inline const XclPageData& GetPageData() const { return maData; }
 126
 127     /** Writes all page settings records to the stream. */
 128     virtual void        Save( XclExpStream& rStrm );
 129
 130 private:
 131     XclPageData         maData;         /// Page settings data.
 132 };
 133
 134 // ============================================================================
 135
 136 #endif
 137