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

#include <bookmark.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)
 
void InitDoc (SwDoc &io_Doc, sw::mark::InsertMode eMode, SwPosition const *pSepPos) override
 
void DeregisterFromDoc (SwDoc &io_rDoc) override
 
auto InvalidateFrames () -> void override
 
const OUString & GetShortName () const override
 
const vcl::KeyCode & GetKeyCode () const override
 
void SetShortName (const OUString &rShortName) override
 
void SetKeyCode (const vcl::KeyCode &rCode) override
 
bool IsHidden () const override
 
const OUString & GetHideCondition () const override
 
void Hide (bool rHide) override
 
void SetHideCondition (const OUString &rHideCondition) override
 
::sfx2::IXmlIdRegistry & GetRegistry () override
 
bool IsInClipboard () const override
 
bool IsInUndo () const override
 
bool IsInContent () const override
 
void sendLOKDeleteCallback ()
 
css::uno::Reference< css::rdf::XMetadatable > MakeUnoObject () override
 
virtual const OUString & GetShortName () const =0
 
virtual const vcl::KeyCode & GetKeyCode () const =0
 
virtual void SetShortName (const OUString &)=0
 
virtual void SetKeyCode (const vcl::KeyCode &)=0
 
virtual bool IsHidden () const =0
 
virtual const OUString & GetHideCondition () const =0
 
virtual void Hide (bool hide)=0
 
virtual void SetHideCondition (const OUString &)=0
 
virtual const SwPosition & GetMarkPos () const =0
 
virtual const SwPosition & GetOtherMarkPos () const =0
 
virtual const SwPosition & GetMarkStart () const =0
 
virtual const SwPosition & GetMarkEnd () const =0
 
virtual const OUString & GetName () const =0
 
virtual bool IsExpanded () const =0
 
virtual bool IsCoveringPosition (const SwPosition &rPos) const =0
 
virtual OUString ToString () const =0
 
virtual void dumpAsXml (xmlTextWriterPtr pWriter) const =0
 
- Public Member Functions inherited from sw::mark::DdeBookmark
 DdeBookmark (const SwPaM &rPaM)
 
const SwServerObject * GetRefObject () const
 
SwServerObject * GetRefObject ()
 
bool IsServer () const
 
void SetRefObject (SwServerObject *pObj)
 
virtual void DeregisterFromDoc (SwDoc &rDoc)
 
 ~DdeBookmark () override
 
- Public Member Functions inherited from sw::mark::MarkBase
SwPosition & GetMarkPos () const override
 
const OUString & GetName () const override
 
SwPosition & GetOtherMarkPos () const override
 
SwPosition & GetMarkStart () const override
 
SwPosition & GetMarkEnd () const override
 
bool IsCoveringPosition (const SwPosition &rPos) const override
 
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 auto InvalidateFrames () -> void
 
OUString ToString () const override
 
void dumpAsXml (xmlTextWriterPtr pWriter) const override
 
void Swap ()
 
virtual void InitDoc (SwDoc &, sw::mark::InsertMode, SwPosition const *)
 
 ~MarkBase () override
 
const unotools::WeakReference< SwXBookmark > & GetXBookmark () const
 
void SetXBookmark (rtl::Reference< SwXBookmark > const &xBkmk)
 

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 sw::mark::MarkBase
void SwClientNotify (const SwModify &, const SfxHint &) override
 
 MarkBase (const SwPaM &rPaM, OUString aName)
 
- Static Protected Member Functions inherited from sw::mark::MarkBase
static OUString GenerateNewName (std::u16string_view rPrefix)
 
- Protected Attributes inherited from sw::mark::MarkBase
std::optional< SwPosition > m_oPos1
 
std::optional< SwPosition > m_oPos2
 
OUString m_aName
 
unotools::WeakReference< SwXBookmark > m_wXBookmark
 

Detailed Description

Definition at line 156 of file core/inc/bookmark.hxx.

Constructor & Destructor Documentation

◆ Bookmark()

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

Definition at line 413 of file core/crsr/bookmark.cxx.

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

Member Function Documentation

◆ DeregisterFromDoc()

void Bookmark::DeregisterFromDoc ( SwDoc &  io_rDoc)
overridevirtual

Reimplemented from sw::mark::DdeBookmark.

Definition at line 456 of file core/crsr/bookmark.cxx.

References sw::mark::DdeBookmark::DeregisterFromDoc(), SwDoc::getIDocumentState(), SwDoc::GetIDocumentUndoRedo(), InvalidateFrames(), and IDocumentState::SetModified().

◆ GetHideCondition()

const OUString & sw::mark::Bookmark::GetHideCondition ( ) const
inlineoverridevirtual

Implements sw::mark::IBookmark.

Definition at line 181 of file core/inc/bookmark.hxx.

References m_sHideCondition.

◆ GetKeyCode()

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

Implements sw::mark::IBookmark.

Definition at line 173 of file core/inc/bookmark.hxx.

References m_aCode.

◆ GetRegistry()

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

Definition at line 498 of file core/crsr/bookmark.cxx.

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

◆ GetShortName()

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

Implements sw::mark::IBookmark.

Definition at line 171 of file core/inc/bookmark.hxx.

References m_sShortName.

◆ Hide()

void Bookmark::Hide ( bool  rHide)
overridevirtual

Implements sw::mark::IBookmark.

Definition at line 479 of file core/crsr/bookmark.cxx.

References InvalidateFrames(), and m_bHidden.

◆ InitDoc()

void Bookmark::InitDoc ( SwDoc &  io_Doc,
sw::mark::InsertMode  eMode,
SwPosition const *  pSepPos 
)
overridevirtual

Reimplemented from sw::mark::MarkBase.

Definition at line 444 of file core/crsr/bookmark.cxx.

References SwDoc::getIDocumentState(), SwDoc::GetIDocumentUndoRedo(), InvalidateFrames(), and IDocumentState::SetModified().

◆ InvalidateFrames()

auto Bookmark::InvalidateFrames ( ) -> void
overridevirtual

Reimplemented from sw::mark::MarkBase.

Definition at line 470 of file core/crsr/bookmark.cxx.

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

◆ IsHidden()

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

Implements sw::mark::IBookmark.

Definition at line 179 of file core/inc/bookmark.hxx.

References m_bHidden.

◆ IsInClipboard()

bool Bookmark::IsInClipboard ( ) const
override

Definition at line 504 of file core/crsr/bookmark.cxx.

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

◆ IsInContent()

bool Bookmark::IsInContent ( ) const
override

Definition at line 515 of file core/crsr/bookmark.cxx.

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

◆ IsInUndo()

bool Bookmark::IsInUndo ( ) const
override

Definition at line 510 of file core/crsr/bookmark.cxx.

◆ MakeUnoObject()

uno::Reference< rdf::XMetadatable > Bookmark::MakeUnoObject ( )
override

Definition at line 521 of file core/crsr/bookmark.cxx.

References SwXBookmark::CreateXBookmark(), and sw::mark::MarkBase::GetMarkPos().

◆ sendLOKDeleteCallback()

void Bookmark::sendLOKDeleteCallback ( )

Definition at line 423 of file core/crsr/bookmark.cxx.

References SfxViewShell::Current(), tools::JsonWriter::finishAndGetAsOString(), sw::mark::MarkBase::GetMarkPos(), sw::mark::MarkBase::GetName(), comphelper::LibreOfficeKit::isActive(), SfxViewShell::libreOfficeKitViewCallback(), tools::JsonWriter::put(), result, and tools::JsonWriter::startNode().

Referenced by sw::mark::MarkManager::deleteMark().

◆ SetHideCondition()

void Bookmark::SetHideCondition ( const OUString &  rHideCondition)
overridevirtual

Implements sw::mark::IBookmark.

Definition at line 488 of file core/crsr/bookmark.cxx.

References m_sHideCondition.

◆ SetKeyCode()

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

Implements sw::mark::IBookmark.

Definition at line 177 of file core/inc/bookmark.hxx.

References m_aCode.

◆ SetShortName()

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

Implements sw::mark::IBookmark.

Definition at line 175 of file core/inc/bookmark.hxx.

References m_sShortName.

Member Data Documentation

◆ m_aCode

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

Definition at line 195 of file core/inc/bookmark.hxx.

Referenced by GetKeyCode(), and SetKeyCode().

◆ m_bHidden

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

Definition at line 197 of file core/inc/bookmark.hxx.

Referenced by Hide(), and IsHidden().

◆ m_sHideCondition

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

Definition at line 198 of file core/inc/bookmark.hxx.

Referenced by GetHideCondition(), and SetHideCondition().

◆ m_sShortName

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

Definition at line 196 of file core/inc/bookmark.hxx.

Referenced by GetShortName(), and SetShortName().

The documentation for this class was generated from the following files:
Generated on Sun Jul 30 2023 04:32:08 for LibreOffice Module sw (master) by doxygen 1.9.3