Provides access to the marks of a document. More...

#include <IDocumentMarkAccess.hxx>

Inheritance diagram for IDocumentMarkAccess:

Classes
struct	ILazyDeleter
	To avoid recursive calls of deleteMark, the removal of dummy characters of fieldmarks has to be delayed; this is the baseclass that can be subclassed for that purpose. More...

class	iterator
	wrapper iterator: wraps iterator of implementation while hiding MarkBase class; only IMark instances can be retrieved directly. More...

Public Types
enum class	MarkType { UNO_BOOKMARK , DDE_BOOKMARK , BOOKMARK , CROSSREF_HEADING_BOOKMARK , CROSSREF_NUMITEM_BOOKMARK , ANNOTATIONMARK , TEXT_FIELDMARK , CHECKBOX_FIELDMARK , DROPDOWN_FIELDMARK , DATE_FIELDMARK , NAVIGATOR_REMINDER }

typedef iterator	const_iterator_t

Public Member Functions
virtual ::sw::mark::IMark *	makeMark (const SwPaM &rPaM, const OUString &rProposedName, MarkType eMark, ::sw::mark::InsertMode eMode, SwPosition const *pSepPos=nullptr)=0
	Generates a new mark in the document for a certain selection. More...

virtual sw::mark::IFieldmark *	makeFieldBookmark (const SwPaM &rPaM, const OUString &rName, const OUString &rType, SwPosition const *pSepPos=nullptr)=0

virtual sw::mark::IFieldmark *	makeNoTextFieldBookmark (const SwPaM &rPaM, const OUString &rName, const OUString &rType)=0

virtual sw::mark::IMark *	makeAnnotationMark (const SwPaM &rPaM, const OUString &rName)=0

virtual ::sw::mark::IMark *	getMarkForTextNode (const SwTextNode &rTextNode, MarkType eMark)=0
	Returns a mark in the document for a paragraph. More...

virtual void	repositionMark (::sw::mark::IMark *io_pMark, const SwPaM &rPaM)=0
	Moves an existing mark to a new selection and performs needed updates. More...

virtual bool	renameMark (::sw::mark::IMark *io_pMark, const OUString &rNewName)=0
	Renames an existing Mark, if possible. More...

virtual void	correctMarksAbsolute (const SwNode &rOldNode, const SwPosition &rNewPos, const sal_Int32 nOffset)=0
	Corrects marks (absolute) This method ignores the previous position of the mark in the paragraph. More...

virtual void	correctMarksRelative (const SwNode &rOldNode, const SwPosition &rNewPos, const sal_Int32 nOffset)=0
	Corrects marks (relative) This method uses the previous position of the mark in the paragraph as offset. More...

virtual void	deleteMarks (const SwNode &rStt, const SwNode &rEnd, std::vector< ::sw::mark::SaveBookmark > *pSaveBkmk, std::optional< sal_Int32 > oStartContentIdx, std::optional< sal_Int32 > oEndContentIdx)=0
	Deletes marks in a range. More...

virtual std::unique_ptr< ILazyDeleter >	deleteMark (const IDocumentMarkAccess::const_iterator_t &ppMark, bool isMoveNodes)=0
	Deletes a mark. More...

virtual void	deleteMark (const ::sw::mark::IMark *const pMark)=0
	Deletes a mark. More...

virtual void	clearAllMarks ()=0
	Clear (deletes) all marks. More...

virtual void	assureSortedMarkContainers () const =0

virtual const_iterator_t	getAllMarksBegin () const =0
	returns a STL-like random access iterator to the begin of the sequence of marks. More...

virtual const_iterator_t	getAllMarksEnd () const =0
	returns a STL-like random access iterator to the end of the sequence of marks. More...

virtual sal_Int32	getAllMarksCount () const =0
	returns the number of marks. More...

virtual const_iterator_t	findMark (const OUString &rMark) const =0
	Finds a mark by name. More...

virtual bool	isBookmarkDeleted (SwPaM const &rPaM, bool isReplace) const =0
	check if the selection would delete a BOOKMARK More...

virtual const_iterator_t	getBookmarksBegin () const =0
	returns a STL-like random access iterator to the begin of the sequence the IBookmarks. More...

virtual const_iterator_t	getBookmarksEnd () const =0
	returns a STL-like random access iterator to the end of the sequence of IBookmarks. More...

virtual sal_Int32	getBookmarksCount () const =0
	returns the number of IBookmarks. More...

virtual const_iterator_t	findBookmark (const OUString &rMark) const =0
	Finds a bookmark by name. More...

virtual const_iterator_t	findFirstBookmarkStartsAfter (const SwPosition &rPos) const =0
	Finds the first mark that is starting after. More...

virtual sw::mark::IMark *	getOneInnermostBookmarkFor (const SwPosition &rPos) const =0
	Get the innermost bookmark that contains rPos. More...

virtual const_iterator_t	getFieldmarksBegin () const =0
	returns a STL-like random access iterator to the begin of the sequence of fieldmarks. More...

virtual const_iterator_t	getFieldmarksEnd () const =0
	returns a STL-like random access iterator to the end of the sequence of fieldmarks. More...

virtual sal_Int32	getFieldmarksCount () const =0
	returns the number of IFieldmarks. More...

virtual ::sw::mark::IFieldmark *	getFieldmarkAt (const SwPosition &rPos) const =0
	get Fieldmark for CH_TXT_ATR_FIELDSTART/CH_TXT_ATR_FIELDEND at rPos More...

virtual sw::mark::IFieldmark *	getInnerFieldmarkFor (const SwPosition &pos) const =0

virtual sw::mark::IFieldmark *	getFieldmarkBefore (const SwPosition &pos, bool bLoop) const =0

virtual sw::mark::IFieldmark *	getFieldmarkAfter (const SwPosition &pos, bool bLoop) const =0

virtual ::sw::mark::IFieldmark *	getDropDownFor (const SwPosition &pos) const =0

virtual std::vector<::sw::mark::IFieldmark * >	getNoTextFieldmarksIn (const SwPaM &rPaM) const =0

virtual void	deleteFieldmarkAt (const SwPosition &rPos)=0

virtual ::sw::mark::IFieldmark *	changeFormFieldmarkType (::sw::mark::IFieldmark *pFieldmark, const OUString &rNewType)=0

virtual void	NotifyCursorUpdate (const SwCursorShell &rCursorShell)=0

virtual void	ClearFieldActivation ()=0

virtual const_iterator_t	getAnnotationMarksBegin () const =0

virtual const_iterator_t	getAnnotationMarksEnd () const =0

virtual sal_Int32	getAnnotationMarksCount () const =0

virtual const_iterator_t	findAnnotationMark (const OUString &rName) const =0

virtual sw::mark::IMark *	getAnnotationMarkFor (const SwPosition &rPosition) const =0

virtual ::sw::mark::IMark *	makeAnnotationBookmark (const SwPaM &rPaM, const OUString &rProposedName, MarkType eMark, ::sw::mark::InsertMode eMode, SwPosition const *pSepPos=nullptr)=0

virtual const_iterator_t	findAnnotationBookmark (const OUString &rName) const =0

virtual void	restoreAnnotationMarks (bool bDelete=true)=0

virtual const_iterator_t	findFirstAnnotationStartsAfter (const SwPosition &rPos) const =0
	Finds the first mark that is starting after. More...

Static Public Member Functions
static SW_DLLPUBLIC MarkType	GetType (const ::sw::mark::IMark &rMark)
	Returns the MarkType used to create the mark. More...

static SW_DLLPUBLIC OUString	GetCrossRefHeadingBookmarkNamePrefix ()

static SW_DLLPUBLIC bool	IsLegalPaMForCrossRefHeadingBookmark (const SwPaM &rPaM)

static void	DeleteFieldmarkCommand (::sw::mark::IFieldmark const &rMark)

Protected Member Functions
virtual	~IDocumentMarkAccess ()

Detailed Description

Provides access to the marks of a document.

Definition at line 39 of file IDocumentMarkAccess.hxx.

Member Typedef Documentation

◆ const_iterator_t

typedef iterator IDocumentMarkAccess::const_iterator_t

Definition at line 108 of file IDocumentMarkAccess.hxx.

Member Enumeration Documentation

◆ MarkType

enum class IDocumentMarkAccess::MarkType

strong

Enumerator
UNO_BOOKMARK
DDE_BOOKMARK
BOOKMARK
CROSSREF_HEADING_BOOKMARK
CROSSREF_NUMITEM_BOOKMARK
ANNOTATIONMARK
TEXT_FIELDMARK
CHECKBOX_FIELDMARK
DROPDOWN_FIELDMARK
DATE_FIELDMARK
NAVIGATOR_REMINDER

Definition at line 42 of file IDocumentMarkAccess.hxx.

Constructor & Destructor Documentation

◆ ~IDocumentMarkAccess()

virtual IDocumentMarkAccess::~IDocumentMarkAccess ( )

inlineprotectedvirtual

Definition at line 375 of file IDocumentMarkAccess.hxx.

Member Function Documentation

◆ assureSortedMarkContainers()

virtual void IDocumentMarkAccess::assureSortedMarkContainers ( ) const

pure virtual

Implemented in sw::mark::MarkManager.

Referenced by SwTable::ConvertSubtables(), and SwTextNode::Update().

◆ changeFormFieldmarkType()

virtual ::sw::mark::IFieldmark * IDocumentMarkAccess::changeFormFieldmarkType	(	::sw::mark::IFieldmark *	pFieldmark,
		const OUString &	rNewType
	)

pure virtual

Implemented in sw::mark::MarkManager.

◆ clearAllMarks()

virtual void IDocumentMarkAccess::clearAllMarks ( )

pure virtual

Clear (deletes) all marks.

Implemented in sw::mark::MarkManager.

◆ ClearFieldActivation()

virtual void IDocumentMarkAccess::ClearFieldActivation ( )

pure virtual

Implemented in sw::mark::MarkManager.

Referenced by SwEditWin::MouseButtonDown(), and SwView::~SwView().

◆ correctMarksAbsolute()

virtual void IDocumentMarkAccess::correctMarksAbsolute	(	const SwNode &	rOldNode,
		const SwPosition &	rNewPos,
		const sal_Int32	nOffset
	)

pure virtual

Corrects marks (absolute) This method ignores the previous position of the mark in the paragraph.

Parameters

rOldNode	[in] the node from which nodes should be moved
rNewPos	[in] new position to which marks will be moved, if nOffset == 0
nOffset	[in] the offset by which the mark gets positioned of rNewPos

Implemented in sw::mark::MarkManager.

Referenced by SwDoc::CorrAbs().

◆ correctMarksRelative()

virtual void IDocumentMarkAccess::correctMarksRelative	(	const SwNode &	rOldNode,
		const SwPosition &	rNewPos,
		const sal_Int32	nOffset
	)

pure virtual

Corrects marks (relative) This method uses the previous position of the mark in the paragraph as offset.

Parameters

rOldNode	[in] the node from which nodes should be moved
rNewPos	[in] new position to which marks from the start of the paragraph will be moved, if nOffset == 0
nOffset	[in] the offset by which the mark gets positioned of rNewPos in addition to its old position in the paragraph

Implemented in sw::mark::MarkManager.

Referenced by SwDoc::CorrRel().

◆ deleteFieldmarkAt()

virtual void IDocumentMarkAccess::deleteFieldmarkAt ( const SwPosition & rPos )

pure virtual

Implemented in sw::mark::MarkManager.

Referenced by SwHistoryNoTextFieldmark::ResetInDoc(), and SwHistoryTextFieldmark::ResetInDoc().

◆ DeleteFieldmarkCommand()

void IDocumentMarkAccess::DeleteFieldmarkCommand ( ::sw::mark::IFieldmark const & rMark )

static

Definition at line 550 of file docbm.cxx.

References SwPosition::AdjustContent(), IDocumentContentOperations::DeleteAndJoin(), sw::mark::FindFieldSep(), SwPaM::GetDoc(), SwDoc::getIDocumentContentOperations(), SwPaM::GetPoint(), GetType(), and TEXT_FIELDMARK.

Referenced by SwWrtShell::DelLeft(), and SwWrtShell::DelRight().

◆ deleteMark() [1/2]

virtual void IDocumentMarkAccess::deleteMark ( const ::sw::mark::IMark *const pMark )

pure virtual

Deletes a mark.

Parameters

ppMark [in] the name of the mark to be deleted.

Implemented in sw::mark::MarkManager.

◆ deleteMark() [2/2]

virtual std::unique_ptr< ILazyDeleter > IDocumentMarkAccess::deleteMark	(	const IDocumentMarkAccess::const_iterator_t &	ppMark,
		bool	isMoveNodes
	)

pure virtual

Deletes a mark.

Parameters

ppMark	[in] an iterator pointing to the Mark to be deleted.
isMoveNodes	[in] the mark is deleted only temporarily for a node move, do not remove fieldmark chars.

Implemented in sw::mark::MarkManager.

Referenced by SwXText::Impl::ConvertCell(), SwInsertDBColAutoPilot::DataToDoc(), SwUndoSaveContent::DelContentIndex(), DeleteDDEMarks(), sw::DocumentContentOperationsManager::DelFullPara(), SwWrtShell::DelLeft(), SwWrtShell::DelRight(), SwContentTree::EditEntry(), SwTextShell::ExecField(), SwTextShell::Execute(), IMPL_LINK_NOARG(), SwXTextRange::Impl::Invalidate(), SwTransferable::Paste(), SwTransferable::PrivateDrop(), sw::DocumentContentOperationsManager::ReplaceRangeImpl(), SwUndoBookmark::ResetInDoc(), and SwHistoryBookmark::SetInDoc().

◆ deleteMarks()

virtual void IDocumentMarkAccess::deleteMarks	(	const SwNode &	rStt,
		const SwNode &	rEnd,
		std::vector< ::sw::mark::SaveBookmark > *	pSaveBkmk,
		std::optional< sal_Int32 >	oStartContentIdx,
		std::optional< sal_Int32 >	oEndContentIdx
	)

pure virtual

Deletes marks in a range.

Note: navigator reminders are excluded

Implemented in sw::mark::MarkManager.

Referenced by DelBookmarks().

◆ findAnnotationBookmark()

virtual const_iterator_t IDocumentMarkAccess::findAnnotationBookmark ( const OUString & rName ) const

pure virtual

Implemented in sw::mark::MarkManager.

Referenced by SwPostItHelper::getLayoutInfos(), and lcl_storeAnnotationMarks().

◆ findAnnotationMark()

virtual const_iterator_t IDocumentMarkAccess::findAnnotationMark ( const OUString & rName ) const

pure virtual

Implemented in sw::mark::MarkManager.

Referenced by SwTextAnnotationField::GetAnnotationMark().

◆ findBookmark()

virtual const_iterator_t IDocumentMarkAccess::findBookmark ( const OUString & rMark ) const

pure virtual

Finds a bookmark by name.

Parameters

rName [in] the name of the bookmark to find.

Returns: an iterator pointing to the bookmark, or getBookmarksEnd() if nothing was found.

Implemented in sw::mark::MarkManager.

Referenced by SwContentTree::BringBookmarksToAttention(), SwWW8ImplReader::CoreLoad(), SwXBookmarks::getByName(), SwXBookmarks::hasByName(), and SwEditWin::RequestHelp().

◆ findFirstAnnotationStartsAfter()

virtual const_iterator_t IDocumentMarkAccess::findFirstAnnotationStartsAfter ( const SwPosition & rPos ) const

pure virtual

Finds the first mark that is starting after.

Returns: an iterator pointing to the mark, or pointing to getAnnotationMarksEnd() if nothing was found.

Implemented in sw::mark::MarkManager.

◆ findFirstBookmarkStartsAfter()

virtual const_iterator_t IDocumentMarkAccess::findFirstBookmarkStartsAfter ( const SwPosition & rPos ) const

pure virtual

Finds the first mark that is starting after.

Returns: an iterator pointing to the mark, or pointing to getBookmarksEnd() if nothing was found.

Implemented in sw::mark::MarkManager.

Referenced by Writer::FindPos_Bkmk(), SwCursorShell::GoNextBookmark(), and SwCursorShell::GoPrevBookmark().

◆ findMark()

virtual const_iterator_t IDocumentMarkAccess::findMark ( const OUString & rMark ) const

pure virtual

Finds a mark by name.

Parameters

rName [in] the name of the mark to find.

Returns: an iterator pointing to the mark, or pointing to getAllMarksEnd() if nothing was found.

Implemented in sw::mark::MarkManager.

Referenced by SwContentTree::EditEntry(), SwTextShell::ExecField(), SwTextShell::Execute(), SwGetRefFieldType::FindAnchor(), SwWrtShell::GotoMark(), IMPL_LINK_NOARG(), SwWW8FltRefStack::IsFootnoteEdnBkmField(), SwView::JumpToSwMark(), SwUndoRenameBookmark::Rename(), SwHTMLParser::SetAttr_(), SwHistoryBookmark::SetInDoc(), and SwXBookmark::setName().

◆ getAllMarksBegin()

virtual const_iterator_t IDocumentMarkAccess::getAllMarksBegin ( ) const

pure virtual

returns a STL-like random access iterator to the begin of the sequence of marks.

Implemented in sw::mark::MarkManager.

Referenced by sw::CopyBookmarks(), SwUndoSaveContent::DelContentIndex(), DeleteDDEMarks(), SwTextShell::Execute(), MSWordExportBase::GetBookmarks(), SwHTMLParser::HasCurrentParaBookmarks(), IMPL_LINK(), SwWW8FltRefStack::IsFootnoteEdnBkmField(), SwHTMLWriter::OutBookmarks(), SwUndoBookmark::ResetInDoc(), SwWW8FltRefStack::SetAttrInDoc(), and SwHTMLParser::StripTrailingPara().

◆ getAllMarksCount()

virtual sal_Int32 IDocumentMarkAccess::getAllMarksCount ( ) const

pure virtual

returns the number of marks.

Note: annotation marks are excluded

Implemented in sw::mark::MarkManager.

Referenced by SwBookmarkControl::Command(), sw::DocumentContentOperationsManager::CopyImplImpl(), sw::DocumentContentOperationsManager::CopyWithFlyInFly(), SwUndoSaveContent::DelContentIndex(), MSWordExportBase::GetBookmarks(), and SwHTMLWriter::OutBookmarks().

◆ getAllMarksEnd()

virtual const_iterator_t IDocumentMarkAccess::getAllMarksEnd ( ) const

pure virtual

returns a STL-like random access iterator to the end of the sequence of marks.

Implemented in sw::mark::MarkManager.

Referenced by sw::CopyBookmarks(), DeleteDDEMarks(), SwTextShell::ExecField(), SwTextShell::Execute(), SwGetRefFieldType::FindAnchor(), SwHTMLParser::HasCurrentParaBookmarks(), IMPL_LINK(), SwWW8FltRefStack::IsFootnoteEdnBkmField(), SwView::JumpToSwMark(), SwUndoRenameBookmark::Rename(), SwUndoBookmark::ResetInDoc(), SwHTMLParser::SetAttr_(), SwXBookmark::setName(), and SwHTMLParser::StripTrailingPara().

◆ getAnnotationMarkFor()

virtual sw::mark::IMark * IDocumentMarkAccess::getAnnotationMarkFor ( const SwPosition & rPosition ) const

pure virtual

Implemented in sw::mark::MarkManager.

Referenced by SwCursor::SelectWordWT().

◆ getAnnotationMarksBegin()

virtual const_iterator_t IDocumentMarkAccess::getAnnotationMarksBegin ( ) const

pure virtual

Implemented in sw::mark::MarkManager.

Referenced by SwXTextField::getAnchor(), MSWordExportBase::GetAnnotationMarks(), and lcl_storeAnnotationMarks().

◆ getAnnotationMarksCount()

virtual sal_Int32 IDocumentMarkAccess::getAnnotationMarksCount ( ) const

pure virtual

Implemented in sw::mark::MarkManager.

Referenced by MSWordExportBase::GetAnnotationMarks().

◆ getAnnotationMarksEnd()

virtual const_iterator_t IDocumentMarkAccess::getAnnotationMarksEnd ( ) const

pure virtual

Implemented in sw::mark::MarkManager.

Referenced by SwXTextField::getAnchor(), SwTextAnnotationField::GetAnnotationMark(), and lcl_storeAnnotationMarks().

◆ getBookmarksBegin()

virtual const_iterator_t IDocumentMarkAccess::getBookmarksBegin ( ) const

pure virtual

returns a STL-like random access iterator to the begin of the sequence the IBookmarks.

Implemented in sw::mark::MarkManager.

Referenced by SwBookmarkControl::Command(), SwEnhancedPDFExportHelper::EnhancedPDFExport(), SwView::ExecuteStatusLine(), SwContentType::FillMemberList(), Writer::FindPos_Bkmk(), SwXBookmarks::getByIndex(), SwXBookmarks::getCount(), SwXBookmarks::getElementNames(), SwCursorShell::GoPrevBookmark(), SwXBookmarks::hasElements(), SwInsertBookmarkDlg::HaveBookmarksChanged(), lcl_FillSubRegionList(), SwInsertBookmarkDlg::PopulateTable(), SwFieldRefPage::UpdateSubType(), and SwContentTree::UpdateTracking().

◆ getBookmarksCount()

virtual sal_Int32 IDocumentMarkAccess::getBookmarksCount ( ) const

pure virtual

returns the number of IBookmarks.

Implemented in sw::mark::MarkManager.

Referenced by SwXBookmarks::getByIndex(), SwInsertBookmarkDlg::HaveBookmarksChanged(), and SwInsertBookmarkDlg::PopulateTable().

◆ getBookmarksEnd()

virtual const_iterator_t IDocumentMarkAccess::getBookmarksEnd ( ) const

pure virtual

◆ GetCrossRefHeadingBookmarkNamePrefix()

OUString IDocumentMarkAccess::GetCrossRefHeadingBookmarkNamePrefix ( )

static

Definition at line 536 of file docbm.cxx.

Referenced by SwScriptInfo::InitScriptInfo(), sw::mark::CrossRefHeadingBookmark::IsLegalName(), and SwFltBookmark::SwFltBookmark().

◆ getDropDownFor()

virtual ::sw::mark::IFieldmark * IDocumentMarkAccess::getDropDownFor ( const SwPosition & pos ) const

pure virtual

Implemented in sw::mark::MarkManager.

◆ getFieldmarkAfter()

virtual sw::mark::IFieldmark * IDocumentMarkAccess::getFieldmarkAfter	(	const SwPosition &	pos,
		bool	bLoop
	)		const

pure virtual

Implemented in sw::mark::MarkManager.

Referenced by SwCursorShell::GetFieldmarkAfter(), and SwVbaFormField::Next().

◆ getFieldmarkAt()

virtual ::sw::mark::IFieldmark * IDocumentMarkAccess::getFieldmarkAt ( const SwPosition & rPos ) const

pure virtual

get Fieldmark for CH_TXT_ATR_FIELDSTART/CH_TXT_ATR_FIELDEND at rPos

Implemented in sw::mark::MarkManager.

Referenced by sw::CalcBreaks(), sw::util::RedlineStack::close(), sw::DocumentContentOperationsManager::DelFullPara(), SwWrtShell::DelLeft(), SwWrtShell::DelRight(), SwFieldFormCheckboxPortion::Format(), lcl_ExportFieldMark(), SwCursor::LeftRight(), ModelToViewHelper::ModelToViewHelper(), SwHTMLWriter::OutPointFieldmarks(), MSWordExportBase::OutputTextNode(), and SwFieldFormCheckboxPortion::Paint().

◆ getFieldmarkBefore()

virtual sw::mark::IFieldmark * IDocumentMarkAccess::getFieldmarkBefore	(	const SwPosition &	pos,
		bool	bLoop
	)		const

pure virtual

Implemented in sw::mark::MarkManager.

Referenced by SwCursorShell::GetFieldmarkBefore(), and SwVbaFormField::Previous().

◆ getFieldmarksBegin()

virtual const_iterator_t IDocumentMarkAccess::getFieldmarksBegin ( ) const

pure virtual

returns a STL-like random access iterator to the begin of the sequence of fieldmarks.

Implemented in sw::mark::MarkManager.

Referenced by SwTextShell::ExecField(), SwCursorShell::GotoFormControl(), IsCursorInFieldmarkHidden(), lcl_getFieldmark(), XMLReader::Read(), SwTextFrame::RegisterToNode(), and SwXFieldEnumeration::SwXFieldEnumeration().

◆ getFieldmarksCount()

virtual sal_Int32 IDocumentMarkAccess::getFieldmarksCount ( ) const

pure virtual

returns the number of IFieldmarks.

Implemented in sw::mark::MarkManager.

◆ getFieldmarksEnd()

virtual const_iterator_t IDocumentMarkAccess::getFieldmarksEnd ( ) const

pure virtual

returns a STL-like random access iterator to the end of the sequence of fieldmarks.

Implemented in sw::mark::MarkManager.

Referenced by SwTextShell::ExecField(), SwCursorShell::GotoFormControl(), IsCursorInFieldmarkHidden(), lcl_getFieldmark(), XMLReader::Read(), SwTextFrame::RegisterToNode(), and SwXFieldEnumeration::SwXFieldEnumeration().

◆ getInnerFieldmarkFor()

virtual sw::mark::IFieldmark * IDocumentMarkAccess::getInnerFieldmarkFor ( const SwPosition & pos ) const

pure virtual

Implemented in sw::mark::MarkManager.

Referenced by SwXText::Impl::ConvertCell(), sw::DocumentContentOperationsManager::DelFullPara(), SwTextPaintInfo::DrawBackBrush(), SwTextShell::ExecField(), SwTextShell::Execute(), SwXTextDocument::executeFromFieldEvent(), SwCursorShell::GetContentAtPos(), SwCursorShell::GetCurrentFieldmark(), SwTextShell::GetState(), SwPaM::HasReadonlySel(), sw::MakeInsertText(), ModelToViewHelper::ModelToViewHelper(), MSWordExportBase::NeedTextNodeSplit(), MSWordExportBase::OutputTextNode(), SwCursor::SelectWordWT(), SwTextShell::StateField(), and SwTextFormatter::WhichTextPor().

◆ getMarkForTextNode()

virtual ::sw::mark::IMark * IDocumentMarkAccess::getMarkForTextNode	(	const SwTextNode &	rTextNode,
		MarkType	eMark
	)

pure virtual

Returns a mark in the document for a paragraph.

If there is none, a mark will be created.

Parameters

rTextNode	[in] the paragraph being marked (a selection over the paragraph is marked)
eMark	[in] the type of the new mark.

Returns: a pointer to the new mark (name might have changed).

Implemented in sw::mark::MarkManager.

Referenced by SwFieldRefPage::FillItemSet(), SwTOXPara::GetURL(), and SwTOXPara::SwTOXPara().

◆ getNoTextFieldmarksIn()

virtual std::vector<::sw::mark::IFieldmark * > IDocumentMarkAccess::getNoTextFieldmarksIn ( const SwPaM & rPaM ) const

pure virtual

Implemented in sw::mark::MarkManager.

Referenced by ModelToViewHelper::ModelToViewHelper().

◆ getOneInnermostBookmarkFor()

virtual sw::mark::IMark * IDocumentMarkAccess::getOneInnermostBookmarkFor ( const SwPosition & rPos ) const

pure virtual

Get the innermost bookmark that contains rPos.

Implemented in sw::mark::MarkManager.

◆ GetType()

IDocumentMarkAccess::MarkType IDocumentMarkAccess::GetType ( const ::sw::mark::IMark & rMark )

static

Returns the MarkType used to create the mark.

Definition at line 502 of file docbm.cxx.

References ANNOTATIONMARK, BOOKMARK, CHECKBOX_FIELDMARK, CROSSREF_HEADING_BOOKMARK, CROSSREF_NUMITEM_BOOKMARK, DATE_FIELDMARK, DDE_BOOKMARK, DROPDOWN_FIELDMARK, NAVIGATOR_REMINDER, TEXT_FIELDMARK, and UNO_BOOKMARK.

Referenced by SwHistory::Add(), SwBookmarkControl::Command(), sw::CopyBookmarks(), SwWW8ImplReader::CoreLoad(), SwXBookmark::CreateXBookmark(), SwUndoSaveContent::DelContentIndex(), DeleteDDEMarks(), DeleteFieldmarkCommand(), sw::mark::MarkManager::deleteMark(), sw::mark::MarkManager::deleteMarks(), SwTextShell::Execute(), MSWordExportBase::GetBookmarks(), SwXBookmarks::getByIndex(), SwXBookmarks::getCount(), SwXBookmarks::getElementNames(), SwVbaFormField::getType(), SwVbaFormFieldCheckBox::getValid(), SwVbaFormFieldDropDown::getValid(), SwVbaFormFieldTextInput::getValid(), SwXBookmarks::hasElements(), SwInsertBookmarkDlg::HaveBookmarksChanged(), IMPL_LINK(), sw::mark::MarkManager::isBookmarkDeleted(), sw::mark::isDeleteMark(), lcl_getFieldmark(), SwInsertBookmarkDlg::PopulateTable(), SwEditWin::RequestHelp(), SwCursor::SelectWordWT(), and SwFieldRefPage::UpdateSubType().

◆ isBookmarkDeleted()

virtual bool IDocumentMarkAccess::isBookmarkDeleted	(	SwPaM const &	rPaM,
		bool	isReplace
	)		const

pure virtual

check if the selection would delete a BOOKMARK

Implemented in sw::mark::MarkManager.

Referenced by SwPaM::HasReadonlySel().

◆ IsLegalPaMForCrossRefHeadingBookmark()

bool IDocumentMarkAccess::IsLegalPaMForCrossRefHeadingBookmark ( const SwPaM & rPaM )

static

Definition at line 541 of file docbm.cxx.

References SwPaM::End(), SwPosition::GetContentIndex(), SwPaM::GetMark(), SwPosition::GetNode(), SwPaM::GetPoint(), SwNode::GetTextNode(), SwPaM::HasMark(), SwNode::IsTextNode(), SwTextNode::Len(), and SwPaM::Start().

Referenced by SwXBookmark::attachToRangeEx(), sw::mark::CrossRefBookmark::CrossRefBookmark(), and SwFltControlStack::SetAttrInDoc().

◆ makeAnnotationBookmark()

virtual ::sw::mark::IMark * IDocumentMarkAccess::makeAnnotationBookmark	(	const SwPaM &	rPaM,
		const OUString &	rProposedName,
		MarkType	eMark,
		::sw::mark::InsertMode	eMode,
		SwPosition const *	pSepPos = `nullptr`
	)

pure virtual

Referenced by lcl_storeAnnotationMarks().

◆ makeAnnotationMark()

virtual sw::mark::IMark * IDocumentMarkAccess::makeAnnotationMark	(	const SwPaM &	rPaM,
		const OUString &	rName
	)

pure virtual

Implemented in sw::mark::MarkManager.

Referenced by SwXTextField::attach(), SwWrtShell::InsertField2(), and SwFltControlStack::SetAttrInDoc().

◆ makeFieldBookmark()

virtual sw::mark::IFieldmark * IDocumentMarkAccess::makeFieldBookmark	(	const SwPaM &	rPaM,
		const OUString &	rName,
		const OUString &	rType,
		SwPosition const *	pSepPos = `nullptr`
	)

pure virtual

Implemented in sw::mark::MarkManager.

Referenced by SwWW8ImplReader::End_Field(), SwTextShell::ExecField(), and SwHistoryTextFieldmark::SetInDoc().

◆ makeMark()

virtual ::sw::mark::IMark * IDocumentMarkAccess::makeMark	(	const SwPaM &	rPaM,
		const OUString &	rProposedName,
		MarkType	eMark,
		::sw::mark::InsertMode	eMode,
		SwPosition const *	pSepPos = `nullptr`
	)

pure virtual

Generates a new mark in the document for a certain selection.

Parameters

rPaM	[in] the selection being marked.
rProposedName	[in] the proposed name of the new mark.
eMark	[in] the type of the new mark.
eMode	[in] is the new mark part of a text copy operation

Returns: a pointer to the new mark (name might have changed).

Referenced by sw::CopyBookmarks(), SwTextShell::ExecField(), sw::DocumentContentOperationsManager::ReplaceRangeImpl(), SwHTMLParser::SetAttr_(), SwFltControlStack::SetAttrInDoc(), SwCursorShell::SetBookmark(), SwCursorShell::SetBookmark2(), SwHistoryBookmark::SetInDoc(), sw::mark::SaveBookmark::SetInDoc(), and SwXTextRange::SetPositions().

◆ makeNoTextFieldBookmark()

virtual sw::mark::IFieldmark * IDocumentMarkAccess::makeNoTextFieldBookmark	(	const SwPaM &	rPaM,
		const OUString &	rName,
		const OUString &	rType
	)

pure virtual

Implemented in sw::mark::MarkManager.

Referenced by SwTextShell::ExecField(), SwWW8ImplReader::Read_F_FormCheckBox(), SwWW8ImplReader::Read_F_FormListBox(), and SwHistoryNoTextFieldmark::SetInDoc().

◆ NotifyCursorUpdate()

virtual void IDocumentMarkAccess::NotifyCursorUpdate ( const SwCursorShell & rCursorShell )

pure virtual

Implemented in sw::mark::MarkManager.

Referenced by SwCursorShell::UpdateCursor().

◆ renameMark()

virtual bool IDocumentMarkAccess::renameMark	(	::sw::mark::IMark *	io_pMark,
		const OUString &	rNewName
	)

pure virtual

Renames an existing Mark, if possible.

Parameters

io_pMark	[in/out] the mark to be renamed
rNewName	[in] new name for the mark

Returns: false, if renaming failed (because the name is already in use)

Implemented in sw::mark::MarkManager.

Referenced by sw::CopyBookmarks(), SwUndoRenameBookmark::Rename(), and SwXBookmark::setName().

◆ repositionMark()

virtual void IDocumentMarkAccess::repositionMark	(	::sw::mark::IMark *	io_pMark,
		const SwPaM &	rPaM
	)

pure virtual

Moves an existing mark to a new selection and performs needed updates.

Parameters

io_pMark	[in/out] the mark to be moved
rPaM	[in] new selection to be marked

Implemented in sw::mark::MarkManager.

Referenced by SwDoc::AppendDoc(), and SwHTMLParser::StripTrailingPara().

◆ restoreAnnotationMarks()

virtual void IDocumentMarkAccess::restoreAnnotationMarks ( bool bDelete = true )

pure virtual

Implemented in sw::mark::MarkManager.

Referenced by SwBaseShell::Execute(), XMLReader::Read(), and SwXMLWriter::Write_().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ const_iterator_t

Member Enumeration Documentation

◆ MarkType

Constructor & Destructor Documentation

◆ ~IDocumentMarkAccess()

Member Function Documentation

◆ assureSortedMarkContainers()

◆ changeFormFieldmarkType()

◆ clearAllMarks()

◆ ClearFieldActivation()

◆ correctMarksAbsolute()

◆ correctMarksRelative()

◆ deleteFieldmarkAt()

◆ DeleteFieldmarkCommand()

◆ deleteMark() [1/2]

◆ deleteMark() [2/2]

◆ deleteMarks()

◆ findAnnotationBookmark()

◆ findAnnotationMark()

◆ findBookmark()

◆ findFirstAnnotationStartsAfter()

◆ findFirstBookmarkStartsAfter()

◆ findMark()

◆ getAllMarksBegin()

◆ getAllMarksCount()

◆ getAllMarksEnd()

◆ getAnnotationMarkFor()

◆ getAnnotationMarksBegin()

◆ getAnnotationMarksCount()

◆ getAnnotationMarksEnd()

◆ getBookmarksBegin()

◆ getBookmarksCount()

◆ getBookmarksEnd()

◆ GetCrossRefHeadingBookmarkNamePrefix()

◆ getDropDownFor()

◆ getFieldmarkAfter()

◆ getFieldmarkAt()

◆ getFieldmarkBefore()

◆ getFieldmarksBegin()

◆ getFieldmarksCount()

◆ getFieldmarksEnd()

◆ getInnerFieldmarkFor()

◆ getMarkForTextNode()

◆ getNoTextFieldmarksIn()

◆ getOneInnermostBookmarkFor()

◆ GetType()

◆ isBookmarkDeleted()

◆ IsLegalPaMForCrossRefHeadingBookmark()

◆ makeAnnotationBookmark()

◆ makeAnnotationMark()

◆ makeFieldBookmark()

◆ makeMark()

◆ makeNoTextFieldBookmark()

◆ NotifyCursorUpdate()

◆ renameMark()

◆ repositionMark()

◆ restoreAnnotationMarks()