lotuswordpro/inc/xfilter/xfpagemaster.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  *  The Contents of this file are made available subject to the terms of
   5  *  either of the following licenses
   6  *
   7  *         - GNU Lesser General Public License Version 2.1
   8  *         - Sun Industry Standards Source License Version 1.1
   9  *
  10  *  Sun Microsystems Inc., October, 2000
  11  *
  12  *  GNU Lesser General Public License Version 2.1
  13  *  =============================================
  14  *  Copyright 2000 by Sun Microsystems, Inc.
  15  *  901 San Antonio Road, Palo Alto, CA 94303, USA
  16  *
  17  *  This library is free software; you can redistribute it and/or
  18  *  modify it under the terms of the GNU Lesser General Public
  19  *  License version 2.1, as published by the Free Software Foundation.
  20  *
  21  *  This library is distributed in the hope that it will be useful,
  22  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  24  *  Lesser General Public License for more details.
  25  *
  26  *  You should have received a copy of the GNU Lesser General Public
  27  *  License along with this library; if not, write to the Free Software
  28  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  29  *  MA  02111-1307  USA
  30  *
  31  *
  32  *  Sun Industry Standards Source License Version 1.1
  33  *  =================================================
  34  *  The contents of this file are subject to the Sun Industry Standards
  35  *  Source License Version 1.1 (the "License"); You may not use this file
  36  *  except in compliance with the License. You may obtain a copy of the
  37  *  License at http://www.openoffice.org/license.html.
  38  *
  39  *  Software provided under this License is provided on an "AS IS" basis,
  40  *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
  41  *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
  42  *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
  43  *  See the License for the specific provisions governing your rights and
  44  *  obligations concerning the Software.
  45  *
  46  *  The Initial Developer of the Original Code is: IBM Corporation
  47  *
  48  *  Copyright: 2008 by IBM Corporation
  49  *
  50  *  All Rights Reserved.
  51  *
  52  *  Contributor(s): _______________________________________
  53  *
  54  *
  55  ************************************************************************/
  56 /*************************************************************************
  57  * @file
  58  * Page master used bye XFMasterPage.
  59  * It is the real object to define header and footer of pages.
  60  ************************************************************************/
  61 #ifndef INCLUDED_LOTUSWORDPRO_INC_XFILTER_XFPAGEMASTER_HXX
  62 #define INCLUDED_LOTUSWORDPRO_INC_XFILTER_XFPAGEMASTER_HXX
  63
  64 #include <xfilter/xfstyle.hxx>
  65 #include <xfilter/xfcolor.hxx>
  66 #include <xfilter/xfmargins.hxx>
  67 #include <memory>
  68
  69 class XFBorders;
  70 class XFShadow;
  71 class XFColumns;
  72 class XFHeaderStyle;
  73 class XFFooterStyle;
  74 class XFBGImage;
  75
  76 class XFPageMaster : public XFStyle
  77 {
  78 public:
  79     XFPageMaster();
  80
  81     virtual ~XFPageMaster() override;
  82
  83 public:
  84     void    SetPageWidth(double width);
  85
  86     void    SetPageHeight(double height);
  87
  88     void    SetMargins(double left, double right, double top, double bottom);
  89
  90     void    SetPageUsage(enumXFPageUsage usage);
  91
  92     void    SetBorders(std::unique_ptr<XFBorders> pBorders);
  93
  94     void    SetShadow(XFShadow *pShadow);
  95
  96     void    SetBackColor(XFColor color);
  97
  98     void    SetBackImage(std::unique_ptr<XFBGImage>& rImage);
  99
 100     void    SetColumns(XFColumns *pColumns);
 101
 102     void    SetHeaderStyle(XFHeaderStyle *pHeaderStyle);
 103
 104     void    SetFooterStyle(XFFooterStyle *pFooterStyle);
 105
 106     void    SetTextDir(enumXFTextDir dir);
 107
 108     void    SetFootNoteSeparator(enumXFAlignType align,
 109                                 double width,
 110                                 sal_Int32 lengthPercent,
 111                                 double spaceAbove,
 112                                 double spaceBelow,
 113                                 XFColor color
 114                                 );
 115
 116     virtual enumXFStyle GetStyleFamily() override;
 117
 118     virtual void    ToXml(IXFStream *pStream) override;
 119
 120 private:
 121     double  m_fPageWidth;
 122     double  m_fPageHeight;
 123
 124     XFMargins   m_aMargin;
 125
 126     enumXFPageUsage m_eUsage;
 127     enumXFTextDir   m_eTextDir;
 128
 129     std::unique_ptr<XFBorders>   m_pBorders;
 130     std::unique_ptr<XFShadow>    m_pShadow;
 131     XFColor     m_aBackColor;
 132     std::unique_ptr<XFColumns>   m_pColumns;
 133     std::unique_ptr<XFBGImage>   m_pBGImage;
 134
 135     std::unique_ptr<XFHeaderStyle> m_pHeaderStyle;
 136     std::unique_ptr<XFFooterStyle> m_pFooterStyle;
 137     //separator:
 138     enumXFAlignType m_eSepAlign;
 139     double  m_fSepWidth;
 140     XFColor m_aSepColor;
 141     double  m_fSepSpaceAbove;
 142     double  m_fSepSpaceBelow;
 143     sal_Int32   m_nSepLengthPercent;
 144
 145 };
 146
 147 inline void XFPageMaster::SetPageUsage(enumXFPageUsage usage)
 148 {
 149     m_eUsage = usage;
 150 }
 151
 152 inline void XFPageMaster::SetTextDir(enumXFTextDir dir)
 153 {
 154     m_eTextDir = dir;
 155 }
 156
 157 #endif
 158
 159 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */