sw/inc/fmtfld.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: fmtfld.hxx,v $
  10  * $Revision: 1.9.118.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 #ifndef _FMTFLD_HXX
  31 #define _FMTFLD_HXX
  32
  33 #include <svtools/poolitem.hxx>
  34 #include <svtools/brdcst.hxx>
  35 #include <svtools/smplhint.hxx>
  36
  37 #include "swdllapi.h"
  38 #include <calbck.hxx>
  39
  40 class SwField;
  41 class SwTxtFld;
  42 class SwView;
  43
  44 // ATT_FLD ***********************************
  45 class SW_DLLPUBLIC SwFmtFld : public SfxPoolItem, public SwClient, public SfxBroadcaster
  46 {
  47     friend class SwTxtFld;
  48     friend void _InitCore();
  49
  50     SwField *pField;
  51     SwTxtFld* pTxtAttr;         // mein TextAttribut
  52
  53     SwFmtFld();                         // das default-Attibut
  54
  55     // geschuetzter CopyCtor
  56     // @@@ copy construction allowed, but copy assignment is not? @@@
  57     SwFmtFld& operator=(const SwFmtFld& rFld);
  58
  59 public:
  60     TYPEINFO();
  61
  62     // single argument constructors shall be explicit.
  63     explicit SwFmtFld( const SwField &rFld );
  64
  65     // @@@ copy construction allowed, but copy assignment is not? @@@
  66     SwFmtFld( const SwFmtFld& rAttr );
  67
  68     virtual ~SwFmtFld();
  69
  70     // "pure virtual Methoden" vom SfxPoolItem
  71     virtual int             operator==( const SfxPoolItem& ) const;
  72     virtual SfxPoolItem*        Clone( SfxItemPool* pPool = 0 ) const;
  73
  74     virtual void Modify( SfxPoolItem* pOld, SfxPoolItem* pNew );
  75     virtual BOOL GetInfo( SfxPoolItem& rInfo ) const;
  76
  77     const SwField *GetFld() const       { return pField; }
  78     SwField *GetFld()                           { return pField; }
  79
  80     // #111840#
  81     /**
  82        Sets current field.
  83
  84        @param pField          new field
  85
  86        @attention The current field will be destroyed before setting the new field.
  87      */
  88     void SetFld(SwField * pField);
  89
  90     const SwTxtFld *GetTxtFld() const   { return pTxtAttr; }
  91     SwTxtFld *GetTxtFld()                               { return pTxtAttr; }
  92
  93     BOOL IsFldInDoc() const;
  94     BOOL IsProtect() const;
  95 };
  96
  97 class SW_DLLPUBLIC SwFmtFldHint : public SfxHint
  98 {
  99 #define SWFMTFLD_INSERTED       1
 100 #define SWFMTFLD_REMOVED        2
 101 #define SWFMTFLD_FOCUS          3
 102 #define SWFMTFLD_CHANGED        4
 103 #define SWFMTFLD_LANGUAGE       5
 104
 105     const SwFmtFld* pFld;
 106     sal_Int16 nWhich;
 107     const SwView* pView;
 108
 109 public:
 110     SwFmtFldHint( const SwFmtFld* p, sal_Int16 n, const SwView* pV = 0)
 111         : pFld(p)
 112         , nWhich(n)
 113         , pView(pV)
 114     {}
 115
 116     TYPEINFO();
 117     const SwFmtFld* GetField() const { return pFld; }
 118     sal_Int16 Which() const { return nWhich; }
 119     const SwView* GetView() const { return pView; }
 120 };
 121
 122 #endif