binfilter/inc/bf_sw/pagedesc.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: pagedesc.hxx,v $
  10  * $Revision: 1.6 $
  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 #ifndef _PAGEDESC_HXX
  31 #define _PAGEDESC_HXX
  32
  33 #ifndef _FRACT_HXX
  34 #include <tools/fract.hxx>
  35 #endif
  36
  37 #ifndef _TOOLS_COLOR_HXX
  38 #include <tools/color.hxx>
  39 #endif
  40 #ifndef _STRING_HXX //autogen
  41 #include <tools/string.hxx>
  42 #endif
  43 #ifndef _SWTYPES_HXX
  44 #include <swtypes.hxx>  //fuer SwTwips
  45 #endif
  46 #ifndef _FRMFMT_HXX
  47 #include <frmfmt.hxx>
  48 #endif
  49 #ifndef _NUMRULE_HXX
  50 #include <numrule.hxx>
  51 #endif
  52 namespace binfilter {
  53
  54 class SfxPoolItem;
  55 class SwTxtFmtColl;
  56 class SwNode;
  57
  58 //Separator line adjustment
  59 enum SwFtnAdj
  60 {
  61     FTNADJ_LEFT,
  62     FTNADJ_CENTER,
  63     FTNADJ_RIGHT
  64 };
  65
  66 //footnote information
  67 class SwPageFtnInfo
  68 {
  69     SwTwips     nMaxHeight;             //maximum height of the footnote area.
  70     ULONG               nLineWidth;             //width of separator line
  71     Color               aLineColor;             //color of the separator line
  72     Fraction    aWidth;                 //percentage width of the separator line.
  73     SwFtnAdj    eAdj;                   //line adjustment.
  74     SwTwips             nTopDist;               //distance between body and separator.
  75     SwTwips             nBottomDist;    //distance between separator and first footnote
  76 public:
  77     SwTwips     GetHeight() const               { return nMaxHeight; }
  78     ULONG                       GetLineWidth() const { return nLineWidth; }
  79     const Color&        GetLineColor() const { return aLineColor;}
  80     const Fraction&     GetWidth() const        { return aWidth; }
  81     SwFtnAdj    GetAdj()        const           { return eAdj; }
  82     SwTwips             GetTopDist()const               { return nTopDist; }
  83     SwTwips             GetBottomDist() const   { return nBottomDist; }
  84
  85     void SetHeight( SwTwips  nNew )     { nMaxHeight = nNew; }
  86     void SetLineWidth(ULONG nSet  )     { nLineWidth = nSet; }
  87     void SetLineColor(const Color& rCol )  { aLineColor = rCol;}
  88     void SetWidth( const Fraction &rNew){ aWidth = rNew; }
  89     void SetAdj   ( SwFtnAdj eNew )     { eAdj = eNew; }
  90     void SetTopDist   ( SwTwips nNew )  { nTopDist = nNew; }
  91     void SetBottomDist( SwTwips nNew )  { nBottomDist = nNew; }
  92
  93     SwPageFtnInfo();
  94     SwPageFtnInfo( const SwPageFtnInfo& );
  95     SwPageFtnInfo& operator=( const SwPageFtnInfo& );
  96
  97     BOOL operator ==( const SwPageFtnInfo& ) const;
  98 };
  99
 100 /*
 101  * Verwendung des UseOnPage (eUse) und der FrmFmt'e
 102  *
 103  *      RIGHT   - aMaster nur fuer rechte Seiten, linke  Seiten immer leer.
 104  *      LEFT    - aLeft fuer linke  Seiten, rechte Seiten immer leer.
 105  *                        aLeft ist eine Kopie des Master.
 106  *  ALL         - aMaster fuer rechte Seiten, aLeft fuer Linke Seiten.
 107  *                        aLeft ist eine Kopie des Master.
 108  *      MIRROR  - aMaster fuer rechte Seiten, aLeft fuer linke Seiten.
 109  *                        aLeft ist eine Kopie des Master, Raender sind gespiegelt.
 110  *
 111  * UI dreht auschliesslich am Master! aLeft wird beim Chg am Dokument
 112  * enstprechend dem eUse eingestellt.
 113  *
 114  * Damit es die Filter etwas einfacher haben werden weitere Werte im
 115  * eUse untergebracht:
 116  *
 117  * HEADERSHARE - Headerinhalt auf beiden Seiten gleich
 118  * FOOTERSHARE - Footerinhalt auf beiden Seiten gleich
 119  *
 120  * Die Werte werden bei den entsprechenden Get-/Set-Methden ausmaskiert.
 121  * Zugriff auf das volle eUse inclusive der Header-Footer information
 122  * per ReadUseOn(), WriteUseOn() (fuer Filter und CopyCTor)!
 123  *
 124  * Die FrmFormate fuer Header/Footer werden anhand der Attribute fuer
 125  * Header/Footer vom UI am Master eingestellt (Hoehe, Raender, Hintergrund...);
 126  * Header/Footer fuer die Linke Seite werden entsprechen kopiert bzw.
 127  * gespielt (Chg am Dokument).
 128  * Das jew. Attribut fuer den Inhalt wird automatisch beim Chg am
 129  * Dokument versorgt (entsprechen den SHARE-informationen werden Inhalte
 130  * erzeugt bzw. entfernt).
 131  *
 132  */
 133
 134 enum UseOnPage
 135 {       PD_NONE                   = 0x0000,     //for internal use only.
 136     PD_LEFT                       = 0x0001,
 137     PD_RIGHT              = 0x0002,
 138     PD_ALL                        = 0x0003,
 139     PD_MIRROR             = 0x0007,
 140     PD_HEADERSHARE    = 0x0040,
 141     PD_FOOTERSHARE    = 0x0080,
 142     PD_NOHEADERSHARE  = 0x00BF, //for internal use only
 143     PD_NOFOOTERSHARE  = 0x007F  //for internal use only
 144 };
 145
 146 class SwPageDesc : public SwModify
 147 {
 148     friend class SwDoc;
 149
 150     //nicht (mehr) implementiert.
 151     SwPageDesc& operator=( const SwPageDesc& );
 152
 153     String              aDescName;
 154     SvxNumberType       aNumType;
 155     SwFrmFmt    aMaster;
 156     SwFrmFmt    aLeft;
 157     SwDepend    aDepend;        // wg. Registerhaltigkeit
 158     SwPageDesc *pFollow;
 159     USHORT              nRegHeight;     // Zeilenabstand und Fontascent der Vorlage
 160     USHORT              nRegAscent; // fuer die Registerhaltigkeit
 161     UseOnPage   eUse;
 162     BOOL                bLandscape;
 163
 164     //Fussnoteninformationen
 165     SwPageFtnInfo aFtnInfo;
 166
 167     //Wird zum Spiegeln vom Chg (Doc) gerufen.
 168     //Kein Abgleich an anderer Stelle.
 169     void Mirror();
 170
 171     void ResetAllAttr( sal_Bool bLeft );
 172
 173     SwPageDesc(const String&, SwFrmFmt*, SwDoc *pDc );
 174 public:
 175     const String &GetName() const { return aDescName; }
 176           void    SetName( const String& rNewName ) { aDescName = rNewName; }
 177
 178     BOOL GetLandscape() const { return bLandscape; }
 179     void SetLandscape( BOOL bNew ) { bLandscape = bNew; }
 180
 181     const SvxNumberType &GetNumType() const { return aNumType; }
 182           void                  SetNumType( const SvxNumberType& rNew ) { aNumType = rNew; }
 183
 184     const SwPageFtnInfo &GetFtnInfo() const { return aFtnInfo; }
 185           SwPageFtnInfo &GetFtnInfo()           { return aFtnInfo; }
 186     void  SetFtnInfo( const SwPageFtnInfo &rNew ) { aFtnInfo = rNew; }
 187
 188     inline BOOL IsHeaderShared() const;
 189     inline BOOL IsFooterShared() const;
 190     inline void ChgHeaderShare( BOOL bNew );
 191     inline void ChgFooterShare( BOOL bNew );
 192
 193     inline void          SetUseOn( UseOnPage eNew );
 194     inline UseOnPage GetUseOn() const;
 195
 196     void          WriteUseOn( UseOnPage eNew ) { eUse = eNew; }
 197     UseOnPage ReadUseOn () const { return eUse; }
 198
 199           SwFrmFmt &GetMaster() { return aMaster; }
 200           SwFrmFmt &GetLeft()   { return aLeft; }
 201     const SwFrmFmt &GetMaster() const { return aMaster; }
 202     const SwFrmFmt &GetLeft()   const { return aLeft; }
 203
 204     // Reset all attrs of the format but keep the ones a pagedesc
 205     // cannot live without.
 206     inline void ResetAllMasterAttr();
 207     inline void ResetAllLeftAttr();
 208
 209     //Mit den folgenden Methoden besorgt sich das Layout ein Format
 210     //um eine Seite erzeugen zu koennen
 211     inline SwFrmFmt *GetRightFmt();
 212     inline const SwFrmFmt *GetRightFmt() const;
 213     inline SwFrmFmt *GetLeftFmt();
 214     inline const SwFrmFmt *GetLeftFmt() const;
 215
 216     USHORT GetRegHeight() const { return nRegHeight; }
 217     USHORT GetRegAscent() const { return nRegAscent; }
 218     void SetRegHeight( USHORT nNew ){ nRegHeight = nNew; }
 219     void SetRegAscent( USHORT nNew ){ nRegAscent = nNew; }
 220
 221     inline void SetFollow( const SwPageDesc* pNew );
 222     const SwPageDesc* GetFollow() const { return pFollow; }
 223           SwPageDesc* GetFollow() { return pFollow; }
 224
 225     void SetRegisterFmtColl( const SwTxtFmtColl* rFmt );
 226     const SwTxtFmtColl* GetRegisterFmtColl() const;
 227     virtual void Modify( SfxPoolItem *pOldValue, SfxPoolItem *pNewValue );
 228     void RegisterChange();
 229
 230     // erfragen und setzen der PoolFormat-Id
 231     USHORT GetPoolFmtId() const                 { return aMaster.GetPoolFmtId(); }
 232     void SetPoolFmtId( USHORT nId )     { aMaster.SetPoolFmtId( nId ); }
 233     USHORT GetPoolHelpId() const                { return aMaster.GetPoolHelpId(); }
 234     void SetPoolHelpId( USHORT nId )    { aMaster.SetPoolHelpId( nId ); }
 235     BYTE GetPoolHlpFileId() const               { return aMaster.GetPoolHlpFileId(); }
 236     void SetPoolHlpFileId( BYTE nId )   { aMaster.SetPoolHlpFileId( nId ); }
 237     // erfrage die Attribut-Beschreibung, returnt den reingereichten String
 238     void GetPresentation( SfxItemPresentation ePres,
 239         SfxMapUnit eCoreMetric, SfxMapUnit ePresMetric, String &rText ) const;
 240
 241         // erfrage vom Client Informationen
 242
 243
 244     //Given a SwNode return the pagedesc in use at that location.
 245     static const SwPageDesc* GetPageDescOfNode(const SwNode& rNd);
 246
 247     SwPageDesc( const SwPageDesc& );
 248     ~SwPageDesc();
 249 };
 250
 251 inline void SwPageDesc::SetFollow( const SwPageDesc* pNew )
 252 {
 253     pFollow = pNew ? (SwPageDesc*)pNew : this;
 254 }
 255
 256 inline BOOL SwPageDesc::IsHeaderShared() const
 257 {
 258     return eUse & PD_HEADERSHARE ? TRUE : FALSE;
 259 }
 260 inline BOOL SwPageDesc::IsFooterShared() const
 261 {
 262     return eUse & PD_FOOTERSHARE ? TRUE : FALSE;
 263 }
 264 inline void SwPageDesc::ChgHeaderShare( BOOL bNew )
 265 {
 266     if ( bNew )
 267         eUse = (UseOnPage) (eUse | PD_HEADERSHARE);
 268         // (USHORT&)eUse |= (USHORT)PD_HEADERSHARE;
 269     else
 270         eUse = (UseOnPage) (eUse & PD_NOHEADERSHARE);
 271         // (USHORT&)eUse &= (USHORT)PD_NOHEADERSHARE;
 272 }
 273 inline void SwPageDesc::ChgFooterShare( BOOL bNew )
 274 {
 275     if ( bNew )
 276         eUse = (UseOnPage) (eUse | PD_FOOTERSHARE);
 277         // (USHORT&)eUse |= (USHORT)PD_FOOTERSHARE;
 278     else
 279         eUse = (UseOnPage) (eUse & PD_NOFOOTERSHARE);
 280         // (USHORT&)eUse &= (USHORT)PD_NOFOOTERSHARE;
 281 }
 282 inline void     SwPageDesc::SetUseOn( UseOnPage eNew )
 283 {
 284     UseOnPage eTmp = PD_NONE;
 285     if ( eUse & PD_HEADERSHARE )
 286         eTmp = PD_HEADERSHARE;
 287         // (USHORT&)eTmp |= (USHORT)PD_HEADERSHARE;
 288     if ( eUse & PD_FOOTERSHARE )
 289         eTmp = (UseOnPage) (eTmp | PD_FOOTERSHARE);
 290         // (USHORT&)eTmp |= (USHORT)PD_FOOTERSHARE;
 291     eUse = (UseOnPage) (eTmp | eNew);
 292     // (USHORT&)eUse = eTmp | eNew;
 293 }
 294 inline UseOnPage SwPageDesc::GetUseOn() const
 295 {
 296     UseOnPage eRet = eUse;
 297     eRet = (UseOnPage) (eRet & PD_NOHEADERSHARE);
 298     // (USHORT&)eRet &= (USHORT)PD_NOHEADERSHARE;
 299     eRet = (UseOnPage) (eRet & PD_NOFOOTERSHARE);
 300     // (USHORT&)eRet &= (USHORT)PD_NOFOOTERSHARE;
 301     return eRet;
 302 }
 303
 304 inline void SwPageDesc::ResetAllMasterAttr()
 305 {
 306     ResetAllAttr( sal_False );
 307 }
 308
 309 inline void SwPageDesc::ResetAllLeftAttr()
 310 {
 311     ResetAllAttr( sal_True );
 312 }
 313
 314 inline SwFrmFmt *SwPageDesc::GetRightFmt()
 315 {
 316     return PD_RIGHT & eUse ? &aMaster : 0;
 317 }
 318 inline const SwFrmFmt *SwPageDesc::GetRightFmt() const
 319 {
 320     return PD_RIGHT & eUse ? &aMaster : 0;
 321 }
 322 inline SwFrmFmt *SwPageDesc::GetLeftFmt()
 323 {
 324     return PD_LEFT & eUse ? &aLeft : 0;
 325 }
 326 inline const SwFrmFmt *SwPageDesc::GetLeftFmt() const
 327 {
 328     return PD_LEFT & eUse ? &aLeft : 0;
 329 }
 330
 331 } //namespace binfilter
 332 #endif  //_PAGEDESC_HXX