sw/inc/fmtftn.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: fmtftn.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 _FMTFTN_HXX
  31 #define _FMTFTN_HXX
  32
  33 #include <tools/string.hxx>
  34 #include <svtools/poolitem.hxx>
  35 #include "swdllapi.h"
  36
  37 class SwDoc;
  38 class SwTxtFtn;
  39
  40 // ATT_FTN **********************************************************
  41
  42 class SW_DLLPUBLIC SwFmtFtn: public SfxPoolItem
  43 {
  44     friend class SwTxtFtn;
  45     SwTxtFtn* pTxtAttr;         //mein TextAttribut
  46     String  aNumber;            //Benutzerdefinierte 'Nummer'
  47     USHORT  nNumber;            //Automatische Nummerierung
  48     bool    m_bEndNote;     // is it an End note?
  49
  50     // geschuetzter CopyCtor
  51     SwFmtFtn& operator=(const SwFmtFtn& rFtn);
  52     SwFmtFtn( const SwFmtFtn& );
  53
  54 public:
  55     SwFmtFtn( bool bEndNote = false );
  56     virtual ~SwFmtFtn();
  57
  58     // "pure virtual Methoden" vom SfxPoolItem
  59     virtual int             operator==( const SfxPoolItem& ) const;
  60     virtual SfxPoolItem*        Clone( SfxItemPool* pPool = 0 ) const;
  61
  62     const String &GetNumStr() const { return aNumber; }
  63     const USHORT &GetNumber() const { return nNumber; }
  64           bool    IsEndNote() const { return m_bEndNote;}
  65
  66     void SetNumStr( const String& rStr )        { aNumber = rStr; }
  67     void SetNumber( USHORT nNo )                        { nNumber = nNo; }
  68     void SetEndNote( bool b );
  69
  70     void SetNumber( const SwFmtFtn& rFtn )
  71         { nNumber = rFtn.nNumber; aNumber = rFtn.aNumber; }
  72
  73     const SwTxtFtn *GetTxtFtn() const   { return pTxtAttr; }
  74           SwTxtFtn *GetTxtFtn()                 { return pTxtAttr; }
  75
  76     void GetFtnText( String& rStr ) const;
  77
  78     // returnt den anzuzeigenden String der Fuss-/Endnote
  79     String GetViewNumStr( const SwDoc& rDoc, BOOL bInclStrs = FALSE ) const;
  80 };
  81
  82
  83 #endif
  84