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 class SW_DLLPUBLIC SwFormatWrapInfluenceOnObjPos: public SfxPoolItem
  29 {
  30 private:
  31     sal_Int16 mnWrapInfluenceOnPosition;
  32     /// Allow objects to overlap, permitted by default.
  33     bool mbAllowOverlap = true;
  34     /// Vertical offset added during positioning to avoid an overlap.
  35     SwTwips mnOverlapVertOffset = 0;
  36
  37 public:
  38
  39     // #i35017# - constant name has changed
  40     SwFormatWrapInfluenceOnObjPos(
  41             sal_Int16 _nWrapInfluenceOnPosition = css::text::WrapInfluenceOnPosition::ONCE_CONCURRENT );
  42     virtual ~SwFormatWrapInfluenceOnObjPos() override;
  43
  44     SwFormatWrapInfluenceOnObjPos(SwFormatWrapInfluenceOnObjPos const &) = default;
  45     SwFormatWrapInfluenceOnObjPos(SwFormatWrapInfluenceOnObjPos &&) = default;
  46     SwFormatWrapInfluenceOnObjPos & operator =(SwFormatWrapInfluenceOnObjPos const &) = delete; // due to SfxPoolItem
  47     SwFormatWrapInfluenceOnObjPos & operator =(SwFormatWrapInfluenceOnObjPos &&) = delete; // due to SfxPoolItem
  48
  49     /// pure virtual methods of class <SfxPoolItem>
  50     virtual bool operator==( const SfxPoolItem& _rAttr ) const override;
  51     virtual SfxPoolItem* Clone( SfxItemPool* pPool = nullptr ) const override;
  52
  53     virtual bool QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
  54     virtual bool PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
  55
  56     /// direct accessors to data
  57     void SetWrapInfluenceOnObjPos( sal_Int16 _nWrapInfluenceOnPosition );
  58     // #i35017# - add parameter <_bIterativeAsOnceConcurrent>
  59     /// to control, if value <ITERATIVE> has to be treated as <ONCE_CONCURRENT>
  60     sal_Int16 GetWrapInfluenceOnObjPos(
  61                         const bool _bIterativeAsOnceConcurrent = false ) const;
  62
  63     void SetAllowOverlap(bool bAllowOverlap);
  64     bool GetAllowOverlap() const;
  65     void SetOverlapVertOffset(SwTwips nOverlapVertOffset);
  66     SwTwips GetOverlapVertOffset() const;
  67
  68     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
  69 };
  70
  71 inline const SwFormatWrapInfluenceOnObjPos& SwAttrSet::GetWrapInfluenceOnObjPos(bool bInP) const
  72     { return Get( RES_WRAP_INFLUENCE_ON_OBJPOS,bInP); }
  73
  74  inline const SwFormatWrapInfluenceOnObjPos& SwFormat::GetWrapInfluenceOnObjPos(bool bInP) const
  75     { return m_aSet.GetWrapInfluenceOnObjPos(bInP); }
  76
  77 #endif
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */