sw/inc/formatlinebreak.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_FORMATLINEBREAK_HXX
  20 #define INCLUDED_SW_INC_FORMATLINEBREAK_HXX
  21
  22 #include "swdllapi.h"
  23 #include <svl/eitem.hxx>
  24 #include "calbck.hxx"
  25
  26 #include <cppuhelper/weakref.hxx>
  27 #include <unotools/weakref.hxx>
  28 #include <com/sun/star/text/XTextContent.hpp>
  29
  30 class SwDoc;
  31 class SwTextLineBreak;
  32 class SwXLineBreak;
  33 class SwXTextRange;
  34
  35 /// Defines the location of a line break text wrapping restart.
  36 enum class SwLineBreakClear
  37 {
  38     NONE,
  39     LEFT,
  40     RIGHT,
  41     ALL,
  42     LAST = ALL
  43 };
  44
  45 /// SfxPoolItem subclass that wraps an SwLineBreakClear.
  46 class SW_DLLPUBLIC SwFormatLineBreak final : public SfxEnumItem<SwLineBreakClear>,
  47                                              public SvtBroadcaster
  48 {
  49     /// The SwTextAttr that knows the position of the line break in the doc model.
  50     SwTextLineBreak* m_pTextAttr;
  51
  52     unotools::WeakReference<SwXLineBreak> m_wXLineBreak;
  53
  54     SwFormatLineBreak& operator=(const SwFormatLineBreak& rLineBreak) = delete;
  55
  56     SwFormatLineBreak(const SwFormatLineBreak&) = delete;
  57
  58 public:
  59     DECLARE_ITEM_TYPE_FUNCTION(SwFormatLineBreak)
  60     SwFormatLineBreak(SwLineBreakClear eClear);
  61     virtual ~SwFormatLineBreak() override;
  62
  63     /// See SfxPoolItem::operator ==().
  64     bool operator==(const SfxPoolItem&) const override;
  65
  66     /// See SfxPoolItem::Clone().
  67     SwFormatLineBreak* Clone(SfxItemPool* pPool = nullptr) const override;
  68
  69     sal_uInt16 GetValueCount() const override;
  70
  71     rtl::Reference<SwXTextRange> GetAnchor() const;
  72
  73     void SetTextLineBreak(SwTextLineBreak* pTextAttr) { m_pTextAttr = pTextAttr; }
  74
  75     unotools::WeakReference<SwXLineBreak> const& GetXTextContent() const { return m_wXLineBreak; }
  76
  77     void SetXLineBreak(rtl::Reference<SwXLineBreak> const& xLineBreak);
  78
  79     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
  80 };
  81
  82 #endif
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */