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
  34 /// Defines the location of a line break text wrapping restart.
  35 enum class SwLineBreakClear
  36 {
  37     NONE,
  38     LEFT,
  39     RIGHT,
  40     ALL,
  41     LAST = ALL
  42 };
  43
  44 /// SfxPoolItem subclass that wraps an SwLineBreakClear.
  45 class SW_DLLPUBLIC SwFormatLineBreak final : public SfxEnumItem<SwLineBreakClear>,
  46                                              public sw::BroadcastingModify
  47 {
  48     /// The SwTextAttr that knows the position of the line break in the doc model.
  49     SwTextLineBreak* m_pTextAttr;
  50
  51     unotools::WeakReference<SwXLineBreak> m_wXLineBreak;
  52
  53     SwFormatLineBreak& operator=(const SwFormatLineBreak& rLineBreak) = delete;
  54
  55     SwFormatLineBreak(const SwFormatLineBreak&) = delete;
  56
  57 public:
  58     SwFormatLineBreak(SwLineBreakClear eClear);
  59     virtual ~SwFormatLineBreak() override;
  60
  61     /// See SfxPoolItem::operator ==().
  62     bool operator==(const SfxPoolItem&) const override;
  63
  64     /// See SfxPoolItem::Clone().
  65     SwFormatLineBreak* Clone(SfxItemPool* pPool = nullptr) const override;
  66
  67     /// See SwModify::SwClientNotify().
  68     void SwClientNotify(const SwModify&, const SfxHint&) override;
  69
  70     sal_uInt16 GetValueCount() const override;
  71
  72     css::uno::Reference<css::text::XTextRange> GetAnchor() const;
  73
  74     void SetTextLineBreak(SwTextLineBreak* pTextAttr) { m_pTextAttr = pTextAttr; }
  75
  76     unotools::WeakReference<SwXLineBreak> const& GetXTextContent() const { return m_wXLineBreak; }
  77
  78     void SetXLineBreak(rtl::Reference<SwXLineBreak> const& xLineBreak);
  79
  80     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
  81 };
  82
  83 #endif
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */