LibreOffice Module sw (master) 1
Public Member Functions | Private Attributes | List of all members
SwFormatWrapInfluenceOnObjPos Class Referencefinal

Allows positioning of floating screen objects without considering their own wrapping type and the wrapping types of the other floating screen objects. More...

#include <fmtwrapinfluenceonobjpos.hxx>

Inheritance diagram for SwFormatWrapInfluenceOnObjPos:
[legend]
Collaboration diagram for SwFormatWrapInfluenceOnObjPos:
[legend]

Public Member Functions

 SwFormatWrapInfluenceOnObjPos (sal_Int16 _nWrapInfluenceOnPosition=css::text::WrapInfluenceOnPosition::ONCE_CONCURRENT)
 
virtual ~SwFormatWrapInfluenceOnObjPos () override
 
 SwFormatWrapInfluenceOnObjPos (SwFormatWrapInfluenceOnObjPos const &)=default
 
 SwFormatWrapInfluenceOnObjPos (SwFormatWrapInfluenceOnObjPos &&)=default
 
SwFormatWrapInfluenceOnObjPosoperator= (SwFormatWrapInfluenceOnObjPos const &)=delete
 
SwFormatWrapInfluenceOnObjPosoperator= (SwFormatWrapInfluenceOnObjPos &&)=delete
 
virtual bool operator== (const SfxPoolItem &_rAttr) const override
 pure virtual methods of class <SfxPoolItem> More...
 
virtual SwFormatWrapInfluenceOnObjPosClone (SfxItemPool *pPool=nullptr) const override
 
virtual bool QueryValue (css::uno::Any &rVal, sal_uInt8 nMemberId=0) const override
 
virtual bool PutValue (const css::uno::Any &rVal, sal_uInt8 nMemberId) override
 
void SetWrapInfluenceOnObjPos (sal_Int16 _nWrapInfluenceOnPosition)
 direct accessors to data More...
 
sal_Int16 GetWrapInfluenceOnObjPos (const bool _bIterativeAsOnceConcurrent=false) const
 to control, if value <ITERATIVE> has to be treated as <ONCE_CONCURRENT> More...
 
void SetAllowOverlap (bool bAllowOverlap)
 
bool GetAllowOverlap () const
 
void SetOverlapVertOffset (SwTwips nOverlapVertOffset)
 
SwTwips GetOverlapVertOffset () const
 
void dumpAsXml (xmlTextWriterPtr pWriter) const override
 
- Public Member Functions inherited from SfxPoolItem
void AddRef (sal_uInt32 n=1) const
 
virtual ~SfxPoolItem ()
 
void SetWhich (sal_uInt16 nId)
 
sal_uInt16 Which () const
 
T & StaticWhichCast (TypedWhichId< T > nId)
 
const T & StaticWhichCast (TypedWhichId< T > nId) const
 
T * DynamicWhichCast (TypedWhichId< T > nId)
 
const T * DynamicWhichCast (TypedWhichId< T > nId) const
 
virtual bool operator== (const SfxPoolItem &) const=0
 
bool operator!= (const SfxPoolItem &rItem) const
 
virtual bool operator< (const SfxPoolItem &) const
 
virtual bool IsSortable () const
 
virtual bool HasLookup () const
 
virtual lookup_iterator Lookup (lookup_iterator, lookup_iterator end) const
 
virtual bool GetPresentation (SfxItemPresentation ePresentation, MapUnit eCoreMetric, MapUnit ePresentationMetric, OUString &rText, const IntlWrapper &rIntlWrapper) const
 
virtual void ScaleMetrics (tools::Long lMult, tools::Long lDiv)
 
virtual bool HasMetrics () const
 
virtual bool QueryValue (css::uno::Any &rVal, sal_uInt8 nMemberId=0) const
 
virtual bool PutValue (const css::uno::Any &rVal, sal_uInt8 nMemberId)
 
virtual SfxPoolItemClone (SfxItemPool *pPool=nullptr) const=0
 
std::unique_ptr< SfxPoolItemCloneSetWhich (sal_uInt16 nNewWhich) const
 
std::unique_ptr< T > CloneSetWhich (TypedWhichId< T > nId) const
 
sal_uInt32 GetRefCount () const
 
SfxItemKind GetKind () const
 
virtual void dumpAsXml (xmlTextWriterPtr pWriter) const
 
virtual boost::property_tree::ptree dumpAsJSON () const
 
virtual bool IsVoidItem () const
 

Private Attributes

sal_Int16 mnWrapInfluenceOnPosition
 
bool mbAllowOverlap = true
 Allow objects to overlap, permitted by default. More...
 
SwTwips mnOverlapVertOffset = 0
 Vertical offset added during positioning to avoid an overlap. More...
 

Additional Inherited Members

- Public Types inherited from SfxPoolItem
typedef std::vector< SfxPoolItem * >::const_iterator lookup_iterator
 
- Protected Member Functions inherited from SfxPoolItem
 SfxPoolItem (sal_uInt16 nWhich=0)
 
 SfxPoolItem (const SfxPoolItem &rCopy)
 

Detailed Description

Allows positioning of floating screen objects without considering their own wrapping type and the wrapping types of the other floating screen objects.

See http://www.openoffice.org/specs/writer/compatibility/obj-pos-without-wrapping.sxw for details.

Definition at line 35 of file fmtwrapinfluenceonobjpos.hxx.

Constructor & Destructor Documentation

◆ SwFormatWrapInfluenceOnObjPos() [1/3]

SwFormatWrapInfluenceOnObjPos::SwFormatWrapInfluenceOnObjPos ( sal_Int16  _nWrapInfluenceOnPosition = css::text::WrapInfluenceOnPosition::ONCE_CONCURRENT)

Definition at line 30 of file fmtwrapinfluenceonobjpos.cxx.

Referenced by Clone().

◆ ~SwFormatWrapInfluenceOnObjPos()

SwFormatWrapInfluenceOnObjPos::~SwFormatWrapInfluenceOnObjPos ( )
overridevirtual

Definition at line 36 of file fmtwrapinfluenceonobjpos.cxx.

◆ SwFormatWrapInfluenceOnObjPos() [2/3]

SwFormatWrapInfluenceOnObjPos::SwFormatWrapInfluenceOnObjPos ( SwFormatWrapInfluenceOnObjPos const &  )
default

◆ SwFormatWrapInfluenceOnObjPos() [3/3]

SwFormatWrapInfluenceOnObjPos::SwFormatWrapInfluenceOnObjPos ( SwFormatWrapInfluenceOnObjPos &&  )
default

Member Function Documentation

◆ Clone()

SwFormatWrapInfluenceOnObjPos * SwFormatWrapInfluenceOnObjPos::Clone ( SfxItemPool pPool = nullptr) const
overridevirtual

Implements SfxPoolItem.

Definition at line 50 of file fmtwrapinfluenceonobjpos.cxx.

References SwFormatWrapInfluenceOnObjPos().

◆ dumpAsXml()

void SwFormatWrapInfluenceOnObjPos::dumpAsXml ( xmlTextWriterPtr  pWriter) const
overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 165 of file fmtwrapinfluenceonobjpos.cxx.

References mbAllowOverlap, mnWrapInfluenceOnPosition, and SfxPoolItem::Which().

◆ GetAllowOverlap()

bool SwFormatWrapInfluenceOnObjPos::GetAllowOverlap ( ) const

◆ GetOverlapVertOffset()

SwTwips SwFormatWrapInfluenceOnObjPos::GetOverlapVertOffset ( ) const

◆ GetWrapInfluenceOnObjPos()

sal_Int16 SwFormatWrapInfluenceOnObjPos::GetWrapInfluenceOnObjPos ( const bool  _bIterativeAsOnceConcurrent = false) const

to control, if value <ITERATIVE> has to be treated as <ONCE_CONCURRENT>

Definition at line 134 of file fmtwrapinfluenceonobjpos.cxx.

References mnWrapInfluenceOnPosition.

Referenced by operator==(), and QueryValue().

◆ operator=() [1/2]

SwFormatWrapInfluenceOnObjPos & SwFormatWrapInfluenceOnObjPos::operator= ( SwFormatWrapInfluenceOnObjPos &&  )
delete

◆ operator=() [2/2]

SwFormatWrapInfluenceOnObjPos & SwFormatWrapInfluenceOnObjPos::operator= ( SwFormatWrapInfluenceOnObjPos const &  )
delete

◆ operator==()

bool SwFormatWrapInfluenceOnObjPos::operator== ( const SfxPoolItem _rAttr) const
overridevirtual

pure virtual methods of class <SfxPoolItem>

Implements SfxPoolItem.

Definition at line 40 of file fmtwrapinfluenceonobjpos.cxx.

References GetWrapInfluenceOnObjPos(), mbAllowOverlap, mnOverlapVertOffset, and mnWrapInfluenceOnPosition.

◆ PutValue()

bool SwFormatWrapInfluenceOnObjPos::PutValue ( const css::uno::Any &  rVal,
sal_uInt8  nMemberId 
)
overridevirtual

◆ QueryValue()

bool SwFormatWrapInfluenceOnObjPos::QueryValue ( css::uno::Any &  rVal,
sal_uInt8  nMemberId = 0 
) const
overridevirtual

◆ SetAllowOverlap()

void SwFormatWrapInfluenceOnObjPos::SetAllowOverlap ( bool  bAllowOverlap)

Definition at line 148 of file fmtwrapinfluenceonobjpos.cxx.

References mbAllowOverlap.

Referenced by SwWrapTabPage::FillItemSet(), and PutValue().

◆ SetOverlapVertOffset()

void SwFormatWrapInfluenceOnObjPos::SetOverlapVertOffset ( SwTwips  nOverlapVertOffset)

◆ SetWrapInfluenceOnObjPos()

void SwFormatWrapInfluenceOnObjPos::SetWrapInfluenceOnObjPos ( sal_Int16  _nWrapInfluenceOnPosition)

direct accessors to data

Definition at line 117 of file fmtwrapinfluenceonobjpos.cxx.

References mnWrapInfluenceOnPosition.

Referenced by PutValue().

Member Data Documentation

◆ mbAllowOverlap

bool SwFormatWrapInfluenceOnObjPos::mbAllowOverlap = true
private

Allow objects to overlap, permitted by default.

Definition at line 40 of file fmtwrapinfluenceonobjpos.hxx.

Referenced by dumpAsXml(), GetAllowOverlap(), operator==(), and SetAllowOverlap().

◆ mnOverlapVertOffset

SwTwips SwFormatWrapInfluenceOnObjPos::mnOverlapVertOffset = 0
private

Vertical offset added during positioning to avoid an overlap.

Definition at line 42 of file fmtwrapinfluenceonobjpos.hxx.

Referenced by GetOverlapVertOffset(), operator==(), and SetOverlapVertOffset().

◆ mnWrapInfluenceOnPosition

sal_Int16 SwFormatWrapInfluenceOnObjPos::mnWrapInfluenceOnPosition
private

The documentation for this class was generated from the following files: