sw/inc/fmtwrapinfluenceonobjpos.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_FMTWRAPINFLUENCEONOBJPOS_HXX
  20 #define INCLUDED_SW_INC_FMTWRAPINFLUENCEONOBJPOS_HXX
  21
  22 #include "hintids.hxx"
  23 #include "format.hxx"
  24 #include "swtypes.hxx"
  25 #include <svl/poolitem.hxx>
  26 #include <com/sun/star/text/WrapInfluenceOnPosition.hpp>
  27
  28 /**
  29  * Allows positioning of floating screen objects without considering their own wrapping type and the
  30  * wrapping types of the other floating screen objects.
  31  *
  32  * See <http://www.openoffice.org/specs/writer/compatibility/obj-pos-without-wrapping.sxw> for
  33  * details.
  34  */
  35 class SW_DLLPUBLIC SwFormatWrapInfluenceOnObjPos final : public SfxPoolItem
  36 {
  37 private:
  38     sal_Int16 mnWrapInfluenceOnPosition;
  39     /// Allow objects to overlap, permitted by default.
  40     bool mbAllowOverlap = true;
  41     /// Vertical offset added during positioning to avoid an overlap.
  42     SwTwips mnOverlapVertOffset = 0;
  43
  44 public:
  45
  46     // #i35017# - constant name has changed
  47     SwFormatWrapInfluenceOnObjPos(
  48             sal_Int16 _nWrapInfluenceOnPosition = css::text::WrapInfluenceOnPosition::ONCE_CONCURRENT );
  49     virtual ~SwFormatWrapInfluenceOnObjPos() override;
  50
  51     SwFormatWrapInfluenceOnObjPos(SwFormatWrapInfluenceOnObjPos const &) = default;
  52     SwFormatWrapInfluenceOnObjPos(SwFormatWrapInfluenceOnObjPos &&) = default;
  53     SwFormatWrapInfluenceOnObjPos & operator =(SwFormatWrapInfluenceOnObjPos const &) = delete; // due to SfxPoolItem
  54     SwFormatWrapInfluenceOnObjPos & operator =(SwFormatWrapInfluenceOnObjPos &&) = delete; // due to SfxPoolItem
  55
  56     /// pure virtual methods of class <SfxPoolItem>
  57     virtual bool operator==( const SfxPoolItem& _rAttr ) const override;
  58     virtual SwFormatWrapInfluenceOnObjPos* Clone( SfxItemPool* pPool = nullptr ) const override;
  59
  60     virtual bool QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
  61     virtual bool PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
  62
  63     /// direct accessors to data
  64     void SetWrapInfluenceOnObjPos( sal_Int16 _nWrapInfluenceOnPosition );
  65     // #i35017# - add parameter <_bIterativeAsOnceConcurrent>
  66     /// to control, if value <ITERATIVE> has to be treated as <ONCE_CONCURRENT>
  67     sal_Int16 GetWrapInfluenceOnObjPos(
  68                         const bool _bIterativeAsOnceConcurrent = false ) const;
  69
  70     void SetAllowOverlap(bool bAllowOverlap);
  71     bool GetAllowOverlap() const;
  72     void SetOverlapVertOffset(SwTwips nOverlapVertOffset);
  73     SwTwips GetOverlapVertOffset() const;
  74
  75     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
  76 };
  77
  78 inline const SwFormatWrapInfluenceOnObjPos& SwAttrSet::GetWrapInfluenceOnObjPos(bool bInP) const
  79     { return Get( RES_WRAP_INFLUENCE_ON_OBJPOS,bInP); }
  80
  81  inline const SwFormatWrapInfluenceOnObjPos& SwFormat::GetWrapInfluenceOnObjPos(bool bInP) const
  82     { return m_aSet.GetWrapInfluenceOnObjPos(bInP); }
  83
  84 #endif
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */