sc/source/filter/inc/xepage.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: xepage.hxx,v $
  10  * $Revision: 1.6.90.1 $
  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_XEPAGE_HXX
  32 #define SC_XEPAGE_HXX
  33
  34 #include "xerecord.hxx"
  35 #include "xlpage.hxx"
  36 #include "xeroot.hxx"
  37
  38 // Page settings records ======================================================
  39
  40 // Header/footer --------------------------------------------------------------
  41
  42 /** Represents a HEADER or FOOTER record. */
  43 class XclExpHeaderFooter : public XclExpRecord
  44 {
  45 public:
  46     explicit            XclExpHeaderFooter( sal_uInt16 nRecId, const String& rHdrString );
  47
  48     virtual void        SaveXml( XclExpXmlStream& rStrm );
  49 private:
  50     /** Writes the header or footer string. Writes an empty record, if no header/footer present. */
  51     virtual void        WriteBody( XclExpStream& rStrm );
  52
  53 private:
  54     String              maHdrString;        /// Header or footer contents.
  55 };
  56
  57 // General page settings ------------------------------------------------------
  58
  59 /** Represents a SETUP record that contains common page settings. */
  60 class XclExpSetup : public XclExpRecord
  61 {
  62 public:
  63     explicit            XclExpSetup( const XclPageData& rPageData );
  64
  65     virtual void        SaveXml( XclExpXmlStream& rStrm );
  66 private:
  67     /** Writes the contents of the SETUP record. */
  68     virtual void        WriteBody( XclExpStream& rStrm );
  69
  70 private:
  71     const XclPageData&  mrData;             /// Page settings data of current sheet.
  72 };
  73
  74 // Manual page breaks ---------------------------------------------------------
  75
  76 /** Stores an array of manual page breaks for columns or rows. */
  77 class XclExpPageBreaks : public XclExpRecord
  78 {
  79 public:
  80     explicit            XclExpPageBreaks(
  81                             sal_uInt16 nRecId,
  82                             const ScfUInt16Vec& rPageBreaks,
  83                             sal_uInt16 nMaxPos );
  84
  85     /** Writes the record, if the list is not empty. */
  86     virtual void        Save( XclExpStream& rStrm );
  87     virtual void        SaveXml( XclExpXmlStream& rStrm );
  88
  89 private:
  90     /** Writes the page break list. */
  91     virtual void        WriteBody( XclExpStream& rStrm );
  92
  93 private:
  94     const ScfUInt16Vec& mrPageBreaks;       /// Page settings data of current sheet.
  95     sal_uInt16          mnMaxPos;           /// Maximum row/column for BIFF8 page breaks.
  96 };
  97
  98 // Page settings ==============================================================
  99
 100 /** Contains all page (print) settings records for a single sheet. */
 101 class XclExpPageSettings : public XclExpRecordBase, protected XclExpRoot
 102 {
 103 public:
 104     /** Creates all records containing the current page settings. */
 105     explicit            XclExpPageSettings( const XclExpRoot& rRoot );
 106
 107     /** Returns read-only access to the page data. */
 108     inline const XclPageData& GetPageData() const { return maData; }
 109
 110     /** Writes all page settings records to the stream. */
 111     virtual void        Save( XclExpStream& rStrm );
 112     virtual void        SaveXml( XclExpXmlStream& rStrm );
 113
 114 private:
 115     XclPageData         maData;         /// Page settings data.
 116 };
 117
 118 // ----------------------------------------------------------------------------
 119
 120 /** Contains all page (print) settings records for a chart object. */
 121 class XclExpChartPageSettings : public XclExpRecordBase, protected XclExpRoot
 122 {
 123 public:
 124     /** Creates all records containing the current page settings. */
 125     explicit            XclExpChartPageSettings( const XclExpRoot& rRoot );
 126
 127     /** Returns read-only access to the page data. */
 128     inline const XclPageData& GetPageData() const { return maData; }
 129
 130     /** Writes all page settings records to the stream. */
 131     virtual void        Save( XclExpStream& rStrm );
 132
 133 private:
 134     XclPageData         maData;         /// Page settings data.
 135 };
 136
 137 // ============================================================================
 138
 139 #endif
 140