sw/inc/ddefld.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_SW_INC_DDEFLD_HXX
  20 #define INCLUDED_SW_INC_DDEFLD_HXX
  21
  22 #include <sfx2/lnkbase.hxx>
  23 #include <svl/hint.hxx>
  24 #include "swdllapi.h"
  25 #include "fldbas.hxx"
  26
  27 class SwDoc;
  28 class SwNode;
  29 class SwNodes;
  30
  31 namespace sw
  32 {
  33     struct LinkAnchorSearchHint final : public SfxHint
  34     {
  35         SwNodes& m_rNodes;
  36         const SwNode*& m_rpFoundNode;
  37         LinkAnchorSearchHint(SwNodes& rNodes, const SwNode*& rpFoundNode) : m_rNodes(rNodes), m_rpFoundNode(rpFoundNode) {};
  38         virtual ~LinkAnchorSearchHint() override;
  39     };
  40     struct InRangeSearchHint final : public SfxHint
  41     {
  42         const SwNodeOffset m_nSttNd, m_nEndNd;
  43         bool& m_rIsInRange;
  44         InRangeSearchHint(const SwNodeOffset nSttNd, const SwNodeOffset nEndNd, bool& rIsInRange)
  45             : m_nSttNd(nSttNd), m_nEndNd(nEndNd), m_rIsInRange(rIsInRange) {}
  46     };
  47 }
  48
  49 // FieldType for DDE
  50 class SW_DLLPUBLIC SwDDEFieldType final : public SwFieldType
  51 {
  52     OUString m_aName;
  53     OUString m_aExpansion;
  54
  55     tools::SvRef<sfx2::SvBaseLink> m_RefLink;
  56     SwDoc* m_pDoc;
  57
  58     sal_uInt16 m_nRefCount;
  59     bool m_bCRLFFlag : 1;
  60     bool m_bDeleted : 1;
  61
  62     SAL_DLLPRIVATE void RefCntChgd();
  63
  64 public:
  65     SwDDEFieldType( OUString aName, const OUString& rCmd,
  66                     SfxLinkUpdateMode );
  67     virtual ~SwDDEFieldType() override;
  68
  69     const OUString& GetExpansion() const               { return m_aExpansion; }
  70     void SetExpansion( const OUString& rStr )   { m_aExpansion = rStr;
  71                                                   m_bCRLFFlag = false; }
  72
  73     virtual std::unique_ptr<SwFieldType> Copy() const override;
  74     virtual OUString GetName() const override;
  75
  76     virtual void QueryValue( css::uno::Any& rVal, sal_uInt16 nWhich ) const override;
  77     virtual void PutValue( const css::uno::Any& rVal, sal_uInt16 nWhich ) override;
  78
  79     OUString const & GetCmd() const;
  80     void SetCmd( const OUString& aStr );
  81
  82     SfxLinkUpdateMode GetType() const          { return m_RefLink->GetUpdateMode();  }
  83     void SetType( SfxLinkUpdateMode nType )    { m_RefLink->SetUpdateMode( nType );  }
  84
  85     bool IsDeleted() const          { return m_bDeleted; }
  86     void SetDeleted( bool b )       { m_bDeleted = b; }
  87
  88     void Disconnect()               { m_RefLink->Disconnect(); }
  89
  90     const ::sfx2::SvBaseLink& GetBaseLink() const    { return *m_RefLink; }
  91           ::sfx2::SvBaseLink& GetBaseLink()          { return *m_RefLink; }
  92
  93     const SwDoc* GetDoc() const     { return m_pDoc; }
  94           SwDoc* GetDoc()           { return m_pDoc; }
  95     void SetDoc( SwDoc* pDoc );
  96
  97     void IncRefCnt() {  if( !m_nRefCount++ && m_pDoc ) RefCntChgd(); }
  98     void DecRefCnt() {  if( !--m_nRefCount && m_pDoc ) RefCntChgd(); }
  99
 100     void SetCRLFDelFlag( bool bFlag )    { m_bCRLFFlag = bFlag; }
 101     virtual void UpdateFields() override
 102             { UpdateDDE(false); };
 103     void UpdateDDE(const bool bNotifyShells = true);
 104 };
 105
 106 // DDE-field
 107 class SwDDEField final : public SwField
 108 {
 109 private:
 110     virtual OUString ExpandImpl(SwRootFrame const* pLayout) const override;
 111     virtual std::unique_ptr<SwField> Copy() const override;
 112
 113 public:
 114     SwDDEField(SwDDEFieldType*);
 115     virtual ~SwDDEField() override;
 116
 117     /** Get parameter via types.
 118      Name cannot be changed. */
 119     virtual OUString GetPar1() const override;
 120
 121     // Command
 122     virtual OUString GetPar2() const override;
 123     virtual void SetPar2(const OUString& rStr) override;
 124 };
 125
 126 #endif // INCLUDED_SW_INC_DDEFLD_HXX
 127
 128 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */