sw/inc/txtfld.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: txtfld.hxx,v $
  10  * $Revision: 1.7 $
  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 _TXTFLD_HXX
  31 #define _TXTFLD_HXX
  32
  33 #include <txatbase.hxx>
  34 #include <tools/string.hxx>
  35 #include <pam.hxx>
  36
  37 class SwTxtNode;
  38
  39 // ATT_FLD ***********************************
  40
  41 class SwTxtFld : public SwTxtAttr
  42 {
  43     mutable   String m_aExpand;
  44     SwTxtNode * m_pTxtNode;
  45
  46 public:
  47     SwTxtFld( SwFmtFld& rAttr, xub_StrLen nStart );
  48     virtual ~SwTxtFld();
  49
  50     void CopyFld( SwTxtFld *pDest ) const;
  51     void Expand() const;
  52     inline void ExpandAlways();
  53
  54     // get and set TxtNode pointer
  55     SwTxtNode* GetpTxtNode() const { return m_pTxtNode; }
  56     inline SwTxtNode& GetTxtNode() const;
  57     void ChgTxtNode( SwTxtNode* pNew ) { m_pTxtNode = pNew; }
  58     // enable notification that field content has changed and needs reformatting
  59     void NotifyContentChange(SwFmtFld& rFmtFld);
  60
  61     // #111840#
  62     /**
  63        Returns position of this field.
  64
  65        @return position of this field. Has to be deleted explicitly.
  66     */
  67 //    SwPosition * GetPosition() const;
  68 };
  69
  70 inline SwTxtNode& SwTxtFld::GetTxtNode() const
  71 {
  72     ASSERT( m_pTxtNode, "SwTxtFld:: where is my TxtNode?" );
  73     return *m_pTxtNode;
  74 }
  75
  76 inline void SwTxtFld::ExpandAlways()
  77 {
  78     m_aExpand += ' ';
  79     Expand();
  80 }
  81
  82 #endif
  83