LibreOffice Module sw (master) 1
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
SwXBookmark Class Reference

UNO API wrapper around an internal sw::mark::IMark. More...

#include <unobookmark.hxx>

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

Classes

class  Impl
 

Public Member Functions

virtual ::sfx2::Metadatable * GetCoreObject () override
 
virtual css::uno::Reference< css::frame::XModel > GetModel () override
 
virtual OUString SAL_CALL getImplementationName () override
 
virtual sal_Bool SAL_CALL supportsService (const OUString &rServiceName) override
 
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames () override
 
virtual void SAL_CALL dispose () override
 
virtual void SAL_CALL addEventListener (const css::uno::Reference< css::lang::XEventListener > &xListener) override
 
virtual void SAL_CALL removeEventListener (const css::uno::Reference< css::lang::XEventListener > &xListener) override
 
virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo () override
 
virtual void SAL_CALL setPropertyValue (const OUString &rPropertyName, const css::uno::Any &rValue) override
 
virtual css::uno::Any SAL_CALL getPropertyValue (const OUString &rPropertyName) override
 
virtual void SAL_CALL addPropertyChangeListener (const OUString &rPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener > &xListener) override
 
virtual void SAL_CALL removePropertyChangeListener (const OUString &rPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener > &xListener) override
 
virtual void SAL_CALL addVetoableChangeListener (const OUString &rPropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener > &xListener) override
 
virtual void SAL_CALL removeVetoableChangeListener (const OUString &rPropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener > &xListener) override
 
virtual OUString SAL_CALL getName () override
 
virtual void SAL_CALL setName (const OUString &rName) override
 
virtual void SAL_CALL attach (const css::uno::Reference< css::text::XTextRange > &xTextRange) override
 
virtual css::uno::Reference< css::text::XTextRange > SAL_CALL getAnchor () override
 

Static Public Member Functions

static rtl::Reference< SwXBookmark > CreateXBookmark (SwDoc &rDoc, ::sw::mark::IMark *pBookmark)
 
::sw::mark::IMark const * GetBookmarkInDoc (SwDoc const *const pDoc, const css::uno::Reference< css::uno::XInterface > &xUT)
 

Protected Member Functions

void attachToRangeEx (const css::uno::Reference< css::text::XTextRange > &xTextRange, IDocumentMarkAccess::MarkType eType, bool isFieldmarkSeparatorAtStart=false)
 
virtual void attachToRange (const css::uno::Reference< css::text::XTextRange > &xTextRange)
 
::sw::mark::IMark * GetBookmark () const
 
IDocumentMarkAccess * GetIDocumentMarkAccess ()
 
SwDoc * GetDoc ()
 
void registerInMark (SwXBookmark &rXMark, ::sw::mark::IMark *const pMarkBase)
 
virtual ~SwXBookmark () override
 
 SwXBookmark (SwDoc *const pDoc)
 
 SwXBookmark ()
 descriptor More...
 

Private Attributes

::sw::UnoImplPtr< Impl > m_pImpl
 

Detailed Description

UNO API wrapper around an internal sw::mark::IMark.

Definition at line 49 of file unobookmark.hxx.

Constructor & Destructor Documentation

◆ ~SwXBookmark()

SwXBookmark::~SwXBookmark ( )
overrideprotectedvirtual

Definition at line 153 of file unobkm.cxx.

◆ SwXBookmark() [1/2]

SwXBookmark::SwXBookmark ( SwDoc *const  pDoc)
protected

Definition at line 143 of file unobkm.cxx.

◆ SwXBookmark() [2/2]

SwXBookmark::SwXBookmark ( )
protected

descriptor

Definition at line 148 of file unobkm.cxx.

References m_pImpl.

Referenced by CreateXBookmark().

Member Function Documentation

◆ addEventListener()

void SAL_CALL SwXBookmark::addEventListener ( const css::uno::Reference< css::lang::XEventListener > &  xListener)
overridevirtual

Definition at line 287 of file unobkm.cxx.

References m_pImpl.

Referenced by SwXFieldmark::addEventListener().

◆ addPropertyChangeListener()

void SAL_CALL SwXBookmark::addPropertyChangeListener ( const OUString &  rPropertyName,
const css::uno::Reference< css::beans::XPropertyChangeListener > &  xListener 
)
overridevirtual

Definition at line 476 of file unobkm.cxx.

◆ addVetoableChangeListener()

void SAL_CALL SwXBookmark::addVetoableChangeListener ( const OUString &  rPropertyName,
const css::uno::Reference< css::beans::XVetoableChangeListener > &  xListener 
)
overridevirtual

Definition at line 492 of file unobkm.cxx.

◆ attach()

void SAL_CALL SwXBookmark::attach ( const css::uno::Reference< css::text::XTextRange > &  xTextRange)
overridevirtual

Definition at line 257 of file unobkm.cxx.

References attachToRange().

Referenced by SwXFieldmark::attach().

◆ attachToRange()

void SwXBookmark::attachToRange ( const css::uno::Reference< css::text::XTextRange > &  xTextRange)
protectedvirtual
Exceptions
css::lang::IllegalArgumentException
css::uno::RuntimeException

Definition at line 252 of file unobkm.cxx.

References attachToRangeEx(), and IDocumentMarkAccess::BOOKMARK.

Referenced by attach().

◆ attachToRangeEx()

void SwXBookmark::attachToRangeEx ( const css::uno::Reference< css::text::XTextRange > &  xTextRange,
IDocumentMarkAccess::MarkType  eType,
bool  isFieldmarkSeparatorAtStart = false 
)
protected
Exceptions
css::lang::IllegalArgumentException
css::uno::RuntimeException

Definition at line 195 of file unobkm.cxx.

References IDocumentMarkAccess::BOOKMARK, IDocumentMarkAccess::CROSSREF_HEADING_BOOKMARK, IDocumentMarkAccess::CROSSREF_NUMITEM_BOOKMARK, eType, SwXTextRange::GetDoc(), sw::mark::CrossRefHeadingBookmark::IsLegalName(), sw::mark::CrossRefNumItemBookmark::IsLegalName(), IDocumentMarkAccess::IsLegalPaMForCrossRefHeadingBookmark(), m_pImpl, SwPaM::Start(), and sw::XTextRangeToSwPaM().

Referenced by attachToRange().

◆ CreateXBookmark()

rtl::Reference< SwXBookmark > SwXBookmark::CreateXBookmark ( SwDoc &  rDoc,
::sw::mark::IMark *  pBookmark 
)
static

Definition at line 157 of file unobkm.cxx.

References IDocumentMarkAccess::ANNOTATIONMARK, IDocumentMarkAccess::GetType(), sw::mark::MarkBase::GetXBookmark(), m_pImpl, and SwXBookmark().

Referenced by getBookmarkColor(), SwXBookmarks::getByIndex(), SwXBookmarks::getByName(), lcl_ExportHints(), SwXServiceProvider::MakeInstance(), and sw::mark::Bookmark::MakeUnoObject().

◆ dispose()

void SAL_CALL SwXBookmark::dispose ( void  )
overridevirtual

Definition at line 278 of file unobkm.cxx.

References m_pImpl.

Referenced by SwXFieldmark::dispose().

◆ getAnchor()

uno::Reference< text::XTextRange > SAL_CALL SwXBookmark::getAnchor ( )
overridevirtual

Definition at line 263 of file unobkm.cxx.

References SwXTextRange::CreateXTextRange(), and m_pImpl.

Referenced by SwXFieldmark::getAnchor().

◆ GetBookmark()

sw::mark::IMark * SwXBookmark::GetBookmark ( ) const
protected

Definition at line 128 of file unobkm.cxx.

References m_pImpl.

◆ GetBookmarkInDoc()

sw::mark::IMark const * SwXBookmark::GetBookmarkInDoc ( SwDoc const *const  pDoc,
const css::uno::Reference< css::uno::XInterface > &  xUT 
)
static
Returns
IMark for this, but only if it lives in pDoc

Definition at line 184 of file unobkm.cxx.

References m_pImpl.

Referenced by SwUnoCursorHelper::GetSelectableFromAny().

◆ GetCoreObject()

sfx2::Metadatable * SwXBookmark::GetCoreObject ( )
override

Definition at line 364 of file unobkm.cxx.

References m_pImpl.

◆ GetDoc()

SwDoc * SwXBookmark::GetDoc ( )
protected

Definition at line 138 of file unobkm.cxx.

References m_pImpl.

◆ GetIDocumentMarkAccess()

IDocumentMarkAccess * SwXBookmark::GetIDocumentMarkAccess ( )
protected

Definition at line 133 of file unobkm.cxx.

References m_pImpl.

◆ getImplementationName()

OUString SAL_CALL SwXBookmark::getImplementationName ( )
overridevirtual

Definition at line 343 of file unobkm.cxx.

◆ GetModel()

uno::Reference< frame::XModel > SwXBookmark::GetModel ( )
overridevirtual

Definition at line 369 of file unobkm.cxx.

References SfxObjectShell::GetModel(), and m_pImpl.

◆ getName()

OUString SAL_CALL SwXBookmark::getName ( )
overridevirtual

Definition at line 303 of file unobkm.cxx.

References m_pImpl.

Referenced by getPropertyValue(), and setName().

◆ getPropertySetInfo()

uno::Reference< beans::XPropertySetInfo > SAL_CALL SwXBookmark::getPropertySetInfo ( )
overridevirtual

Definition at line 380 of file unobkm.cxx.

References aSwMapProvider, SwUnoPropertyMapProvider::GetPropertySet(), SfxItemPropertySet::getPropertySetInfo(), and PROPERTY_MAP_BOOKMARK.

◆ getPropertyValue()

uno::Any SAL_CALL SwXBookmark::getPropertyValue ( const OUString &  rPropertyName)
overridevirtual

Definition at line 436 of file unobkm.cxx.

References sw::GetDefaultTextContentValue(), getName(), m_pImpl, UNO_LINK_DISPLAY_NAME, UNO_NAME_BOOKMARK_CONDITION, and UNO_NAME_BOOKMARK_HIDDEN.

◆ getSupportedServiceNames()

uno::Sequence< OUString > SAL_CALL SwXBookmark::getSupportedServiceNames ( )
overridevirtual

Definition at line 354 of file unobkm.cxx.

◆ registerInMark()

void SwXBookmark::registerInMark ( SwXBookmark &  rXMark,
::sw::mark::IMark *const  pMarkBase 
)
protected

Definition at line 122 of file unobkm.cxx.

References m_pImpl.

◆ removeEventListener()

void SAL_CALL SwXBookmark::removeEventListener ( const css::uno::Reference< css::lang::XEventListener > &  xListener)
overridevirtual

Definition at line 295 of file unobkm.cxx.

References m_pImpl.

Referenced by SwXFieldmark::removeEventListener().

◆ removePropertyChangeListener()

void SAL_CALL SwXBookmark::removePropertyChangeListener ( const OUString &  rPropertyName,
const css::uno::Reference< css::beans::XPropertyChangeListener > &  xListener 
)
overridevirtual

Definition at line 484 of file unobkm.cxx.

◆ removeVetoableChangeListener()

void SAL_CALL SwXBookmark::removeVetoableChangeListener ( const OUString &  rPropertyName,
const css::uno::Reference< css::beans::XVetoableChangeListener > &  xListener 
)
overridevirtual

Definition at line 500 of file unobkm.cxx.

◆ setName()

void SAL_CALL SwXBookmark::setName ( const OUString &  rName)
overridevirtual

Definition at line 312 of file unobkm.cxx.

References IDocumentMarkAccess::findMark(), IDocumentMarkAccess::getAllMarksEnd(), SwPaM::GetMark(), getName(), m_pImpl, IDocumentMarkAccess::renameMark(), and SwPaM::SetMark().

◆ setPropertyValue()

void SAL_CALL SwXBookmark::setPropertyValue ( const OUString &  rPropertyName,
const css::uno::Any &  rValue 
)
overridevirtual

Definition at line 391 of file unobkm.cxx.

References m_pImpl, UNO_NAME_BOOKMARK_CONDITION, and UNO_NAME_BOOKMARK_HIDDEN.

◆ supportsService()

sal_Bool SAL_CALL SwXBookmark::supportsService ( const OUString &  rServiceName)
overridevirtual

Definition at line 348 of file unobkm.cxx.

References cppu::supportsService().

Member Data Documentation

◆ m_pImpl

::sw::UnoImplPtr<Impl> SwXBookmark::m_pImpl
private

Definition at line 56 of file unobookmark.hxx.

Referenced by addEventListener(), attachToRangeEx(), CreateXBookmark(), dispose(), getAnchor(), GetBookmark(), GetBookmarkInDoc(), GetCoreObject(), GetDoc(), GetIDocumentMarkAccess(), GetModel(), getName(), getPropertyValue(), registerInMark(), removeEventListener(), setName(), and setPropertyValue().

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