sw/inc/fmtrfmrk.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_FMTRFMRK_HXX
  20 #define INCLUDED_SW_INC_FMTRFMRK_HXX
  21
  22 #include <rtl/ustring.hxx>
  23 #include <cppuhelper/weakref.hxx>
  24 #include <svl/poolitem.hxx>
  25 #include <unotools/weakref.hxx>
  26 #include <com/sun/star/text/XTextContent.hpp>
  27
  28 #include "calbck.hxx"
  29
  30 class SwTextRefMark;
  31 class SwXReferenceMark;
  32
  33 /// SfxPoolItem subclass that represents a reference mark (a position in the document with a name,
  34 /// which has a start and may or may not have an end).
  35 ///
  36 /// This can be used as a character format in the hints array of a text node, it's owned by an
  37 /// SwTextRefMark.
  38 ///
  39 /// It's Insert -> Cross-reference -> Cross-references -> set reference on the UI.
  40 class SAL_DLLPUBLIC_RTTI SwFormatRefMark final
  41     : public SfxPoolItem
  42     , public sw::BroadcastingModify
  43 {
  44     friend class SwTextRefMark;
  45     SwTextRefMark* m_pTextAttr;
  46
  47     SwFormatRefMark& operator=(const SwFormatRefMark& rRefMark) = delete;
  48     OUString m_aRefName;
  49
  50     unotools::WeakReference<SwXReferenceMark> m_wXReferenceMark;
  51
  52 public:
  53     SwFormatRefMark( OUString aText );
  54     SwFormatRefMark( const SwFormatRefMark& rRefMark );
  55     virtual ~SwFormatRefMark( ) override;
  56
  57     /// "Pure virtual methods" of SfxPoolItem.
  58     virtual bool            operator==( const SfxPoolItem& ) const override;
  59     virtual SwFormatRefMark* Clone( SfxItemPool* pPool = nullptr ) const override;
  60
  61     // SwClient
  62     virtual void SwClientNotify(const SwModify&, const SfxHint&) override;
  63
  64     void InvalidateRefMark();
  65
  66     const SwTextRefMark *GetTextRefMark() const   { return m_pTextAttr; }
  67
  68     OUString &GetRefName()       { return m_aRefName; }
  69     const OUString &GetRefName() const { return m_aRefName; }
  70
  71     unotools::WeakReference<SwXReferenceMark> const& GetXRefMark() const
  72         { return m_wXReferenceMark; }
  73     void SetXRefMark(rtl::Reference<SwXReferenceMark> const& xMark);
  74     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
  75 };
  76
  77 #endif
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */