LibreOffice Module sw (master)  1
Public Member Functions | Private Attributes | List of all members
sw::mark::Bookmark Class Reference

#include <bookmrk.hxx>

Inheritance diagram for sw::mark::Bookmark:
[legend]
Collaboration diagram for sw::mark::Bookmark:
[legend]

Public Member Functions

 Bookmark (const SwPaM &rPaM, const vcl::KeyCode &rCode, const OUString &rName)
 
virtual void InitDoc (SwDoc *const io_Doc, sw::mark::InsertMode eMode, SwPosition const *pSepPos) override
 
virtual void DeregisterFromDoc (SwDoc *const io_pDoc) override
 
virtual auto InvalidateFrames () -> void override
 
virtual const OUString & GetShortName () const override
 
virtual const vcl::KeyCodeGetKeyCode () const override
 
virtual void SetShortName (const OUString &rShortName) override
 
virtual void SetKeyCode (const vcl::KeyCode &rCode) override
 
virtual bool IsHidden () const override
 
virtual const OUString & GetHideCondition () const override
 
virtual void Hide (bool rHide) override
 
virtual void SetHideCondition (const OUString &rHideCondition) override
 
virtual ::sfx2::IXmlIdRegistryGetRegistry () override
 
virtual bool IsInClipboard () const override
 
virtual bool IsInUndo () const override
 
virtual bool IsInContent () const override
 
virtual css::uno::Reference< css::rdf::XMetadatable > MakeUnoObject () override
 
- Public Member Functions inherited from sw::BroadcastingModify
virtual void CallSwClientNotify (const SfxHint &rHint) const override
 
- Public Member Functions inherited from SwModify
 SwModify ()
 
void NotifyClients (const SfxPoolItem *pOldValue, const SfxPoolItem *pNewValue)
 
void ModifyBroadcast (const SfxPoolItem *pOldValue, const SfxPoolItem *pNewValue)
 
virtual ~SwModify () override
 
void Add (SwClient *pDepend)
 
SwClientRemove (SwClient *pDepend)
 
bool HasWriterListeners () const
 
virtual bool GetInfo (SfxPoolItem &) const override
 
void LockModify ()
 
void UnlockModify ()
 
void SetInCache (bool bNew)
 
void SetInSwFntCache (bool bNew)
 
void SetInDocDTOR ()
 
bool IsModifyLocked () const
 
bool IsInCache () const
 
bool IsInSwFntCache () const
 
void CheckCaching (const sal_uInt16 nWhich)
 
bool HasOnlyOneListener () const
 
- Public Member Functions inherited from SwClient
 SwClient ()
 
 SwClient (SwClient &&) noexcept
 
virtual ~SwClient () override
 
virtual void SwClientNotify (const SwModify &, const SfxHint &rHint) override
 
std::unique_ptr< sw::ModifyChangedHintCheckRegistration (const SfxPoolItem *pOldValue)
 
virtual void ModifyNotification (const SfxPoolItem *pOldValue, const SfxPoolItem *pNewValue)
 
void SwClientNotifyCall (const SwModify &rModify, const SfxHint &rHint)
 
const SwModifyGetRegisteredIn () const
 
SwModifyGetRegisteredIn ()
 
void EndListeningAll ()
 
void StartListeningToSameModifyAs (const SwClient &)
 
- Public Member Functions inherited from sw::WriterListener
bool IsLast () const
 
- Public Member Functions inherited from sw::BroadcasterMixin
 BroadcasterMixin ()=default
 
 BroadcasterMixin (BroadcasterMixin const &)=default
 
BroadcasterMixinoperator= (const BroadcasterMixin &)
 
SvtBroadcasterGetNotifier ()
 
- Public Member Functions inherited from sw::mark::DdeBookmark
 DdeBookmark (const SwPaM &rPaM)
 
const SwServerObjectGetRefObject () const
 
SwServerObjectGetRefObject ()
 
bool IsServer () const
 
void SetRefObject (SwServerObject *pObj)
 
virtual ~DdeBookmark () override
 
- Public Member Functions inherited from sw::mark::MarkBase
virtual SwPositionGetMarkPos () const override
 
virtual const OUString & GetName () const override
 
virtual SwPositionGetOtherMarkPos () const override
 
virtual SwPositionGetMarkStart () const override
 
virtual SwPositionGetMarkEnd () const override
 
virtual bool IsCoveringPosition (const SwPosition &rPos) const override
 
virtual bool IsExpanded () const override
 
void SetName (const OUString &rName)
 
virtual void SetMarkPos (const SwPosition &rNewPos)
 
virtual void SetOtherMarkPos (const SwPosition &rNewPos)
 
virtual void ClearOtherMarkPos ()
 
virtual OUString ToString () const override
 
virtual void dumpAsXml (xmlTextWriterPtr pWriter) const override
 
void Swap ()
 
virtual ~MarkBase () override
 
const css::uno::WeakReference< css::text::XTextContent > & GetXBookmark () const
 
void SetXBookmark (css::uno::Reference< css::text::XTextContent > const &xBkmk)
 
- Public Member Functions inherited from sfx2::Metadatable
 Metadatable ()
 
virtual ~Metadatable ()
 
css::beans::StringPair GetMetadataReference () const
 
void SetMetadataReference (const css::beans::StringPair &i_rReference)
 
void EnsureMetadataReference ()
 
void RemoveMetadataReference ()
 
void RegisterAsCopyOf (Metadatable const &i_rSource, const bool i_bCopyPrecedesSource=false)
 
std::shared_ptr< MetadatableUndoCreateUndo () const
 
std::shared_ptr< MetadatableUndoCreateUndoForDelete ()
 
void RestoreMetadata (std::shared_ptr< MetadatableUndo > const &i_pUndo)
 
void JoinMetadatable (Metadatable const &i_rOther, const bool i_isMergedEmpty, const bool i_isOtherEmpty)
 

Private Attributes

vcl::KeyCode m_aCode
 
OUString m_sShortName
 
bool m_bHidden
 
OUString m_sHideCondition
 

Additional Inherited Members

- Protected Member Functions inherited from sw::mark::IBookmark
 IBookmark ()=default
 
- Protected Member Functions inherited from sw::mark::IMark
 IMark ()=default
 
- Protected Member Functions inherited from SwClient
 SwClient (SwModify *pToRegisterIn)
 
SwModifyGetRegisteredInNonConst () const
 
- Protected Member Functions inherited from sw::WriterListener
 WriterListener ()
 
virtual ~WriterListener () COVERITY_NOEXCEPT_FALSE
 
- Protected Member Functions inherited from sw::mark::MarkBase
virtual void Modify (const SfxPoolItem *pOld, const SfxPoolItem *pNew) override
 
 MarkBase (const SwPaM &rPaM, const OUString &rName)
 
- Static Protected Member Functions inherited from sw::mark::MarkBase
static OUString GenerateNewName (const OUString &rPrefix)
 
- Protected Attributes inherited from sw::mark::MarkBase
std::unique_ptr< SwPositionm_pPos1
 
std::unique_ptr< SwPositionm_pPos2
 
OUString m_aName
 
css::uno::WeakReference< css::text::XTextContent > m_wXBookmark
 

Detailed Description

Definition at line 153 of file bookmrk.hxx.

Constructor & Destructor Documentation

Bookmark::Bookmark ( const SwPaM rPaM,
const vcl::KeyCode rCode,
const OUString &  rName 
)

Definition at line 392 of file bookmrk.cxx.

References sw::mark::MarkBase::m_aName.

Member Function Documentation

void Bookmark::DeregisterFromDoc ( SwDoc *const  io_pDoc)
overridevirtual
virtual const OUString& sw::mark::Bookmark::GetHideCondition ( ) const
inlineoverridevirtual

Implements sw::mark::IBookmark.

Definition at line 178 of file bookmrk.hxx.

References m_sHideCondition.

virtual const vcl::KeyCode& sw::mark::Bookmark::GetKeyCode ( ) const
inlineoverridevirtual

Implements sw::mark::IBookmark.

Definition at line 170 of file bookmrk.hxx.

References m_aCode.

sfx2::IXmlIdRegistry & Bookmark::GetRegistry ( )
overridevirtual

Implements sfx2::Metadatable.

Definition at line 456 of file bookmrk.cxx.

References assert(), sw::mark::MarkBase::GetMarkPos(), and SwDoc::GetXmlIdRegistry().

virtual const OUString& sw::mark::Bookmark::GetShortName ( ) const
inlineoverridevirtual

Implements sw::mark::IBookmark.

Definition at line 168 of file bookmrk.hxx.

References m_sShortName.

void Bookmark::Hide ( bool  rHide)
overridevirtual

Implements sw::mark::IBookmark.

Definition at line 438 of file bookmrk.cxx.

References InvalidateFrames(), and m_bHidden.

void Bookmark::InitDoc ( SwDoc *const  io_Doc,
sw::mark::InsertMode  eMode,
SwPosition const *  pSepPos 
)
overridevirtual
auto Bookmark::InvalidateFrames ( ) -> void
overridevirtual

Reimplemented from sw::mark::MarkBase.

Definition at line 429 of file bookmrk.cxx.

Referenced by DeregisterFromDoc(), Hide(), InitDoc(), and SetHideCondition().

virtual bool sw::mark::Bookmark::IsHidden ( ) const
inlineoverridevirtual

Implements sw::mark::IBookmark.

Definition at line 176 of file bookmrk.hxx.

References m_bHidden.

bool Bookmark::IsInClipboard ( ) const
overridevirtual

Implements sfx2::Metadatable.

Definition at line 463 of file bookmrk.cxx.

References assert(), sw::mark::MarkBase::GetMarkPos(), and SwDoc::IsClipBoard().

bool Bookmark::IsInContent ( ) const
overridevirtual

Implements sfx2::Metadatable.

Definition at line 475 of file bookmrk.cxx.

References assert(), sw::mark::MarkBase::GetMarkPos(), and SwDoc::IsInHeaderFooter().

bool Bookmark::IsInUndo ( ) const
overridevirtual

Implements sfx2::Metadatable.

Definition at line 470 of file bookmrk.cxx.

uno::Reference< rdf::XMetadatable > Bookmark::MakeUnoObject ( )
overridevirtual
void Bookmark::SetHideCondition ( const OUString &  rHideCondition)
overridevirtual

Implements sw::mark::IBookmark.

Definition at line 447 of file bookmrk.cxx.

References InvalidateFrames(), and m_sHideCondition.

virtual void sw::mark::Bookmark::SetKeyCode ( const vcl::KeyCode rCode)
inlineoverridevirtual

Implements sw::mark::IBookmark.

Definition at line 174 of file bookmrk.hxx.

References m_aCode.

virtual void sw::mark::Bookmark::SetShortName ( const OUString &  rShortName)
inlineoverridevirtual

Implements sw::mark::IBookmark.

Definition at line 172 of file bookmrk.hxx.

References m_sShortName.

Member Data Documentation

vcl::KeyCode sw::mark::Bookmark::m_aCode
private

Definition at line 191 of file bookmrk.hxx.

Referenced by GetKeyCode(), and SetKeyCode().

bool sw::mark::Bookmark::m_bHidden
private

Definition at line 193 of file bookmrk.hxx.

Referenced by Hide(), and IsHidden().

OUString sw::mark::Bookmark::m_sHideCondition
private

Definition at line 194 of file bookmrk.hxx.

Referenced by GetHideCondition(), and SetHideCondition().

OUString sw::mark::Bookmark::m_sShortName
private

Definition at line 192 of file bookmrk.hxx.

Referenced by GetShortName(), and SetShortName().


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