LibreOffice Module sw (master) 1
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
SwContact Class Referenceabstract

Base class for the following contact objects (frame + draw objects). More...

#include <dcontact.hxx>

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

Public Member Functions

 SwContact (SwFrameFormat *pToRegisterIn)
 For reader. Only the connection is created. More...
 
virtual ~SwContact () override
 
virtual const SwAnchoredObjectGetAnchoredObj (const SdrObject *_pSdrObj) const =0
 
virtual SwAnchoredObjectGetAnchoredObj (SdrObject *_pSdrObj)=0
 
virtual const SdrObjectGetMaster () const =0
 
virtual SdrObjectGetMaster ()=0
 
SwFrameFormatGetFormat ()
 
const SwFrameFormatGetFormat () const
 
bool IsInDTOR () const
 
virtual void MoveObjToVisibleLayer (SdrObject *_pDrawObj)
 method to move drawing object to corresponding visible layer More...
 
virtual void MoveObjToInvisibleLayer (SdrObject *_pDrawObj)
 method to move drawing object to corresponding invisible layer More...
 
const SwFormatAnchorGetAnchorFormat () const
 some virtual helper methods for information about the object (Writer fly frame resp. More...
 
RndStdIds GetAnchorId () const
 
bool ObjAnchoredAtPage () const
 
bool ObjAnchoredAtFly () const
 
bool ObjAnchoredAtPara () const
 
bool ObjAnchoredAtChar () const
 
bool ObjAnchoredAsChar () const
 
const SwNodeGetAnchorNode () const
 
virtual void GetAnchoredObjs (std::vector< SwAnchoredObject * > &_roAnchoredObjs) const =0
 get data collection of anchored objects, handled by with contact More...
 
sal_uInt32 GetMinOrdNum () const
 get minimum order number of anchored objects handled by with contact More...
 
sal_uInt32 GetMaxOrdNum () const
 get maximum order number of anchored objects handled by with contact More...
 
- Public Member Functions inherited from SdrObjUserCall
virtual ~SdrObjUserCall ()
 
virtual void Changed (const SdrObject &rObj, SdrUserCallType eType, const tools::Rectangle &rOldBoundRect)
 
virtual void const * GetPDFAnchorStructureElementKey (SdrObject const &rObj)
 
- Public Member Functions inherited from SwClient
 SwClient ()
 
 SwClient (SwClient &&) noexcept
 
virtual ~SwClient () override
 
std::optional< sw::ModifyChangedHintCheckRegistration (const SfxPoolItem *pOldValue)
 
void CheckRegistrationFormat (SwFormat &rOld)
 
const SwModifyGetRegisteredIn () const
 
SwModifyGetRegisteredIn ()
 
void EndListeningAll ()
 
void StartListeningToSameModifyAs (const SwClient &)
 
virtual bool GetInfo (SfxPoolItem &) const
 
- Public Member Functions inherited from sw::WriterListener
bool IsLast () const
 
virtual const SwCellFrameDynCastCellFrame () const
 
virtual const SwTabFrameDynCastTabFrame () const
 
virtual const SwRowFrameDynCastRowFrame () const
 
virtual const SwTableDynCastTable () const
 

Protected Member Functions

void SetInDTOR ()
 
virtual void SwClientNotify (const SwModify &, const SfxHint &rHint) override
 
- Protected Member Functions inherited from SwClient
 SwClient (SwModify *pToRegisterIn)
 
SwModifyGetRegisteredInNonConst () const
 
virtual void SwClientNotify (const SwModify &, const SfxHint &rHint) override
 
- Protected Member Functions inherited from sw::WriterListener
 WriterListener ()
 
virtual ~WriterListener () COVERITY_NOEXCEPT_FALSE
 
virtual void SwClientNotify (const SwModify &, const SfxHint &rHint)=0
 

Private Member Functions

void MoveObjToLayer (const bool _bToVisible, SdrObject *_pDrawObj)
 method to move object to visible/invisible layer More...
 

Private Attributes

bool mbInDTOR
 boolean, indicating destruction of contact object important note: boolean has to be set at the beginning of each destructor in the subclasses using method <SetInDTOR()>. More...
 

Detailed Description

Base class for the following contact objects (frame + draw objects).

Definition at line 66 of file dcontact.hxx.

Constructor & Destructor Documentation

◆ SwContact()

SwContact::SwContact ( SwFrameFormat pToRegisterIn)

For reader. Only the connection is created.

Definition at line 193 of file dcontact.cxx.

◆ ~SwContact()

SwContact::~SwContact ( )
overridevirtual

Definition at line 198 of file dcontact.cxx.

References SetInDTOR().

Member Function Documentation

◆ GetAnchoredObj() [1/2]

virtual const SwAnchoredObject * SwContact::GetAnchoredObj ( const SdrObject _pSdrObj) const
pure virtual

◆ GetAnchoredObj() [2/2]

virtual SwAnchoredObject * SwContact::GetAnchoredObj ( SdrObject _pSdrObj)
pure virtual

Implemented in SwFlyDrawContact, and SwDrawContact.

◆ GetAnchoredObjs()

virtual void SwContact::GetAnchoredObjs ( std::vector< SwAnchoredObject * > &  _roAnchoredObjs) const
pure virtual

get data collection of anchored objects, handled by with contact

Implemented in SwFlyDrawContact, and SwDrawContact.

Referenced by GetMaxOrdNum(), GetMinOrdNum(), SwDrawView::MoveRepeatedObjs(), and SwClientNotify().

◆ GetAnchorFormat()

const SwFormatAnchor & SwContact::GetAnchorFormat ( ) const
inline

some virtual helper methods for information about the object (Writer fly frame resp.

drawing object)

Definition at line 138 of file dcontact.hxx.

References GetFormat().

Referenced by SwDoc::ChgAnchor(), and SwTextFrame::HideAndShowObjects().

◆ GetAnchorId()

RndStdIds SwContact::GetAnchorId ( ) const
inline

◆ GetAnchorNode()

const SwNode & SwContact::GetAnchorNode ( ) const
inline

Definition at line 152 of file dcontact.hxx.

Referenced by SwFEShell::ShouldObjectBeSelected().

◆ GetFormat() [1/2]

SwFrameFormat * SwContact::GetFormat ( )
inline

◆ GetFormat() [2/2]

const SwFrameFormat * SwContact::GetFormat ( ) const
inline

Definition at line 113 of file dcontact.hxx.

References SwClient::GetRegisteredIn().

◆ GetMaster() [1/2]

virtual const SdrObject * SwContact::GetMaster ( ) const
pure virtual

◆ GetMaster() [2/2]

virtual SdrObject * SwContact::GetMaster ( )
pure virtual

Implemented in SwFlyDrawContact, and SwDrawContact.

◆ GetMaxOrdNum()

sal_uInt32 SwContact::GetMaxOrdNum ( ) const

get maximum order number of anchored objects handled by with contact

Definition at line 374 of file dcontact.cxx.

References GetAnchoredObjs().

Referenced by SwDrawView::ObjOrderChanged().

◆ GetMinOrdNum()

sal_uInt32 SwContact::GetMinOrdNum ( ) const

get minimum order number of anchored objects handled by with contact

Definition at line 349 of file dcontact.cxx.

References GetAnchoredObjs(), and SAL_MAX_UINT32.

Referenced by SwDrawView::ObjOrderChanged().

◆ IsInDTOR()

bool SwContact::IsInDTOR ( ) const
inline

Definition at line 116 of file dcontact.hxx.

◆ MoveObjToInvisibleLayer()

void SwContact::MoveObjToInvisibleLayer ( SdrObject _pDrawObj)
virtual

method to move drawing object to corresponding invisible layer

method to move drawing object to corresponding invisible layer - #i18447#

uses method <MoveObjToLayer(..)>

Parameters
_pDrawObjdrawing object, which will be moved to the visible layer

Reimplemented in SwFlyDrawContact.

Definition at line 237 of file dcontact.cxx.

References FlyFrameLeave, GetAnchoredObj(), GetFormat(), SdrObject::GetLayer(), SwAnchoredObject::GetObjRect(), SwAnchoredObject::GetPageFrame(), MoveObjToLayer(), and Notify_Background().

Referenced by SwDrawContact::DisconnectFromLayout(), SwTextFrame::HideAndShowObjects(), and SwFlyDrawContact::MoveObjToInvisibleLayer().

◆ MoveObjToLayer()

void SwContact::MoveObjToLayer ( const bool  _bToVisible,
SdrObject _pDrawObj 
)
private

method to move object to visible/invisible layer

method to move object to visible/invisible layer - #i18447#

Implementation for the public method <MoveObjToVisibleLayer(..)> and <MoveObjToInvisibleLayer(..)> If object is in invisible respectively visible layer, it's moved to the corresponding visible respectively invisible layers. For group object the members are individually moved to the corresponding layer, because <SdrObjGroup::GetLayer()> does return 0, if members aren't on the same layer as the group object, and <SdrObjGroup::SetLayer(..)|NbcSetLayer(..)> sets also the layer of the members.

Parameters
_bToVisibleinput parameter - boolean indicating, if object has to be moved to visible (== true) or invisible (== false) layer.
_pDrawObjinput parameter, which will be changed - drawing object, which will change its layer.

implementation for the public method <MoveObjToVisibleLayer(..)> and <MoveObjToInvisibleLayer(..)>

Definition at line 264 of file dcontact.cxx.

References CheckControlLayer(), IDocumentDrawModelAccess::GetControlsId(), IDocumentDrawModelAccess::GetHeavenId(), IDocumentDrawModelAccess::GetHellId(), IDocumentDrawModelAccess::GetInvisibleControlsId(), IDocumentDrawModelAccess::GetInvisibleHeavenId(), IDocumentDrawModelAccess::GetInvisibleHellId(), SdrObject::GetLayer(), SdrObjList::GetObj(), SdrObjList::GetObjCount(), SwClient::GetRegisteredIn(), SwClient::GetRegisteredInNonConst(), i, MoveObjToLayer(), and SdrObject::SetLayer().

Referenced by MoveObjToInvisibleLayer(), MoveObjToLayer(), and MoveObjToVisibleLayer().

◆ MoveObjToVisibleLayer()

void SwContact::MoveObjToVisibleLayer ( SdrObject _pDrawObj)
virtual

◆ ObjAnchoredAsChar()

bool SwContact::ObjAnchoredAsChar ( ) const
inline

◆ ObjAnchoredAtChar()

bool SwContact::ObjAnchoredAtChar ( ) const
inline

◆ ObjAnchoredAtFly()

bool SwContact::ObjAnchoredAtFly ( ) const
inline

Definition at line 147 of file dcontact.hxx.

Referenced by SwFrameNotify::ImplDestroy().

◆ ObjAnchoredAtPage()

bool SwContact::ObjAnchoredAtPage ( ) const
inline

Definition at line 146 of file dcontact.hxx.

Referenced by SwFrameNotify::ImplDestroy(), and SwFEShell::ShouldObjectBeSelected().

◆ ObjAnchoredAtPara()

bool SwContact::ObjAnchoredAtPara ( ) const
inline

◆ SetInDTOR()

void SwContact::SetInDTOR ( )
protected

Definition at line 204 of file dcontact.cxx.

References mbInDTOR.

Referenced by ~SwContact(), and SwDrawContact::~SwDrawContact().

◆ SwClientNotify()

void SwContact::SwClientNotify ( const SwModify rMod,
const SfxHint rHint 
)
overrideprotectedvirtual

Member Data Documentation

◆ mbInDTOR

bool SwContact::mbInDTOR
private

boolean, indicating destruction of contact object important note: boolean has to be set at the beginning of each destructor in the subclasses using method <SetInDTOR()>.

Definition at line 71 of file dcontact.hxx.

Referenced by SetInDTOR().


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