PaM is Point and Mark: a selection of the document model. More...

#include <pam.hxx>

Inheritance diagram for SwPaM:

Collaboration diagram for SwPaM:

Public Member Functions
	SwPaM (const SwPosition &rPos, SwPaM *pRing=nullptr)

	SwPaM (const SwPosition &rMk, const SwPosition &rPt, SwPaM *pRing=nullptr)

	SwPaM (const SwNodeIndex &rMk, const SwNodeIndex &rPt, tools::Long nMkOffset=0, tools::Long nPtOffset=0, SwPaM *pRing=nullptr)

	SwPaM (const SwNode &rMk, const SwNode &rPt, tools::Long nMkOffset=0, tools::Long nPtOffset=0, SwPaM *pRing=nullptr)

	SwPaM (const SwNodeIndex &rMk, sal_Int32 nMkContent, const SwNodeIndex &rPt, sal_Int32 nPtContent, SwPaM *pRing=nullptr)

	SwPaM (const SwNode &rMk, sal_Int32 nMkContent, const SwNode &rPt, sal_Int32 nPtContent, SwPaM *pRing=nullptr)

	SwPaM (const SwNode &rNd, sal_Int32 nContent=0, SwPaM *pRing=nullptr)

	SwPaM (const SwNodeIndex &rNd, sal_Int32 nContent=0, SwPaM *pRing=nullptr)

virtual	~SwPaM () override

	SwPaM (SwPaM const &rPaM, SwPaM *pRing)
	this takes a second parameter, which indicates the Ring that the new PaM should be part of (may be null) More...

SwPaM &	operator= (const SwPaM &)
	@@ semantic: no copy assignment for super class Ring. More...

bool	Move (SwMoveFnCollection const &fnMove=fnMoveForward, SwGoInDoc fnGo=GoInContent)
	Movement of cursor. More...

bool	IsInFrontOfLabel () const

void	SetInFrontOfLabel_ (bool bNew)

virtual void	SetMark ()
	Unless this is called, the getter method of Mark will return Point. More...

void	DeleteMark ()

void	Exchange ()

bool	HasMark () const
	A PaM marks a selection if Point and Mark are distinct positions. More...

const SwPosition *	GetPoint () const

SwPosition *	GetPoint ()

const SwPosition *	GetMark () const

SwPosition *	GetMark ()

const SwPosition *	Start () const

SwPosition *	Start ()

const SwPosition *	End () const

SwPosition *	End ()

SwNode &	GetNode (bool bPoint=true) const

SwContentNode *	GetContentNode (bool bPoint=true) const

void	Normalize (bool bPointFirst=true)
	Normalizes PaM, i.e. More...

SwDoc &	GetDoc () const

SwPosition &	GetBound (bool bOne=true)

const SwPosition &	GetBound (bool bOne=true) const

sal_uInt16	GetPageNum (bool bAtPoint=true, const Point *pLayPos=nullptr)
	Get number of page which contains cursor. More...

bool	HasReadonlySel (bool bFormView) const
	Is in something protected (readonly) or selection contains something protected. More...

bool	ContainsPosition (const SwPosition &rPos) const

OUString	GetText () const

void	InvalidatePaM ()

SwPaM *	GetNext ()

const SwPaM *	GetNext () const

SwPaM *	GetPrev ()

const SwPaM *	GetPrev () const

bool	IsMultiSelection () const

void	dumpAsXml (xmlTextWriterPtr pWriter) const

Public Member Functions inherited from sw::Ring< SwPaM >
virtual	~Ring () COVERITY_NOEXCEPT_FALSE

void	unlink ()
	algo::unlink is buggy! don't call it directly! More...

void	MoveTo (SwPaM *pDestRing)
	Removes this item from its current ring container and adds it to another ring container. More...

ring_container	GetRingContainer ()

const_ring_container	GetRingContainer () const

Private Member Functions
	SwPaM (SwPaM const &rPaM)=delete

Private Attributes
SwPosition	m_Bound1

SwPosition	m_Bound2

SwPosition *	m_pPoint
	points at either m_Bound1 or m_Bound2 More...

SwPosition *	m_pMark
	points at either m_Bound1 or m_Bound2 More...

bool	m_bIsInFrontOfLabel

Additional Inherited Members
Public Types inherited from sw::Ring< SwPaM >
typedef std::add_const< SwPaM >::type	const_value_type

typedef RingContainer< SwPaM >	ring_container

typedef RingContainer< const_value_type >	const_ring_container

Protected Member Functions inherited from sw::Ring< SwPaM >
	Ring ()
	Creates a new item in a ring container all by itself. More...

	Ring (SwPaM *pRing)
	Creates a new item and add it to an existing ring container. More...

SwPaM *	GetNextInRing ()

const_value_type *	GetNextInRing () const

SwPaM *	GetPrevInRing ()

const_value_type *	GetPrevInRing () const

bool	unique () const

Detailed Description

PaM is Point and Mark: a selection of the document model.

Definition at line 136 of file pam.hxx.

Constructor & Destructor Documentation

SwPaM::SwPaM ( SwPaM const & rPaM )

privatedelete

Referenced by SwRangeRedline::GetDescr(), and SwUnoInternalPaM::operator=().

SwPaM::SwPaM	(	const SwPosition &	rPos,
		SwPaM *	pRing = `nullptr`
	)

explicit

Definition at line 335 of file pam.cxx.

SwPaM::SwPaM	(	const SwPosition &	rMk,
		const SwPosition &	rPt,
		SwPaM *	pRing = `nullptr`
	)

Definition at line 345 of file pam.cxx.

SwPaM::SwPaM	(	const SwNodeIndex &	rMk,
		const SwNodeIndex &	rPt,
		tools::Long	nMkOffset = `0`,
		tools::Long	nPtOffset = `0`,
		SwPaM *	pRing = `nullptr`
	)

Definition at line 355 of file pam.cxx.

References SwIndex::Assign(), SwNode::GetContentNode(), SwNodeIndex::GetNode(), m_Bound1, m_Bound2, m_pMark, m_pPoint, SwPosition::nContent, and SwPosition::nNode.

SwPaM::SwPaM	(	const SwNode &	rMk,
		const SwNode &	rPt,
		tools::Long	nMkOffset = `0`,
		tools::Long	nPtOffset = `0`,
		SwPaM *	pRing = `nullptr`
	)

Definition at line 376 of file pam.cxx.

References SwIndex::Assign(), SwNode::GetContentNode(), SwNodeIndex::GetNode(), m_Bound1, m_Bound2, m_pMark, m_pPoint, SwPosition::nContent, and SwPosition::nNode.

SwPaM::SwPaM	(	const SwNodeIndex &	rMk,
		sal_Int32	nMkContent,
		const SwNodeIndex &	rPt,
		sal_Int32	nPtContent,
		SwPaM *	pRing = `nullptr`
	)

Definition at line 397 of file pam.cxx.

References SwIndex::Assign(), SwNode::GetContentNode(), GetContentNode(), SwNodeIndex::GetNode(), GetNode(), m_pMark, m_pPoint, and SwPosition::nContent.

SwPaM::SwPaM	(	const SwNode &	rMk,
		sal_Int32	nMkContent,
		const SwNode &	rPt,
		sal_Int32	nPtContent,
		SwPaM *	pRing = `nullptr`
	)

Definition at line 410 of file pam.cxx.

References SwIndex::Assign(), SwNode::GetContentNode(), SwNodeIndex::GetNode(), m_pMark, m_pPoint, SwPosition::nContent, and SwPosition::nNode.

SwPaM::SwPaM	(	const SwNode &	rNd,
		sal_Int32	nContent = `0`,
		SwPaM *	pRing = `nullptr`
	)

Definition at line 425 of file pam.cxx.

References SwIndex::Assign(), SwNode::GetContentNode(), SwNodeIndex::GetNode(), m_pPoint, SwPosition::nContent, and SwPosition::nNode.

SwPaM::SwPaM	(	const SwNodeIndex &	rNd,
		sal_Int32	nContent = `0`,
		SwPaM *	pRing = `nullptr`
	)

Definition at line 437 of file pam.cxx.

References SwIndex::Assign(), SwNode::GetContentNode(), SwNodeIndex::GetNode(), m_pPoint, and SwPosition::nContent.

SwPaM::~SwPaM ( )

overridevirtual

Definition at line 448 of file pam.cxx.

SwPaM::SwPaM	(	SwPaM const &	rPaM,
		SwPaM *	pRing
	)

this takes a second parameter, which indicates the Ring that the new PaM should be part of (may be null)

Definition at line 450 of file pam.cxx.

Member Function Documentation

bool SwPaM::ContainsPosition ( const SwPosition & rPos ) const

inline

Definition at line 257 of file pam.hxx.

References End, and Start.

Referenced by sw::mark::MarkManager::getDropDownsFor(), and sw::DocumentRedlineManager::IsInRedlines().

void SwPaM::DeleteMark ( )

inline

clear the mark position; this helps if mark's SwIndex is registered at some node, and that node is then deleted

Definition at line 177 of file pam.hxx.

References GetNode().

void SwPaM::dumpAsXml ( xmlTextWriterPtr pWriter ) const

Definition at line 1151 of file pam.cxx.

References SwPosition::dumpAsXml(), GetMark(), GetPoint(), and HasMark().

Referenced by SwRangeRedline::dumpAsXml().

const SwPosition* SwPaM::End ( ) const

inline

Definition at line 217 of file pam.hxx.

Referenced by SwDoc::AppendDoc(), sw::DocumentRedlineManager::AppendRedline(), SwEditShell::ApplyChangedSentence(), SwXTextField::attach(), SwAccessibleMap::BuildSelectedParas(), sw::CalcBreaks(), SwRangeRedline::CalcStartEnd(), CanSkipOverRedline(), SwXMeta::CheckForOwnMemberMeta(), SwTable::CollectBoxSelection(), SwEditWin::Command(), SwXTextMarkup::commitTextRangeMarkup(), SwWW8ImplReader::ContainsSingleInlineGraphic(), SwHHCWrapper::Convert(), SwXText::Impl::ConvertCell(), sw::CopyBookmarks(), sw::DocumentContentOperationsManager::CopyFlyInFlyImpl(), sw::DocumentContentOperationsManager::CopyImpl(), sw::DocumentContentOperationsManager::CopyImplImpl(), sw::DocumentContentOperationsManager::CopyRange(), SwDoc::CorrAbs(), SwFltControlStack::Delete(), sw::DocumentContentOperationsManager::DeleteAndJoinWithRedlineImpl(), sw::DocumentContentOperationsManager::DeleteRangeImplImpl(), SwEditShell::DeleteSel(), sw::DocumentContentOperationsManager::DelFullPara(), SwDoc::DelNumRules(), SwCursor::ExpandToSentenceBorders(), SwUndo::FillSaveData(), SwUndo::FillSaveDataForFormat(), SwShellCursor::FillStartEnd(), SwXTextDocument::FindAny(), SwCursorShell::GetBoxNms(), SwEditShell::GetCurrentOutlineLevels(), SwUnoCursorHelper::GetCurTextFormatColl(), SwXTextPortion::getEnd(), SwXTextViewCursor::getEnd(), SwXParagraph::getEnd(), SwShellCursor::GetEndPos(), SwDoc::GetPaMDescr(), sw::GetRanges(), SwTextNode::GetRedlineText(), SwWW8AttrIter::GetRunLevelRedline(), SwEditShell::GetScalingOfSelectedText(), SwAccessibleFrameBase::GetSelectedState(), SwView::GetState(), SwXTextPortion::getString(), GetText(), SwCursorShell::GetTextFieldAtCursor(), SwXTextCursor::gotoRange(), SwCursorShell::GotoRedline(), SwCursorShell::GotoRedline_(), SwFEShell::HasBoxSelection(), HasReadonlySel(), sw::DocumentRedlineManager::HasRedline(), SwCursorShell::HasSelection(), SwEditShell::IgnoreGrammarErrorAt(), SwUndoReplace::Impl::Impl(), SwWW8AttrIter::IncludeEndOfParaCRInRedlineProperties(), SwWrtShell::Insert(), SwFEShell::InsertRow(), wwSectionManager::InsertSegments(), SwDoc::InsertSwSection(), InvalidatePaM(), sw::mark::MarkManager::isBookmarkDeleted(), SwCursorShell::IsCursorPtAtEnd(), SwDoc::IsInsRegionAvailable(), IDocumentMarkAccess::IsLegalPaMForCrossRefHeadingBookmark(), lcl_CursorIsInSection(), lcl_CutRedlines(), lcl_ExportFieldMark(), lcl_FillRedlineArray(), lcl_FindSelection(), lcl_ForceIntoMeta(), lcl_GetRedlineAtNodeInsertionOrDeletion(), lcl_SelectParaAndReset(), lcl_TstFlyRange(), SwRedlineTable::LOKRedlineNotification(), sw::mark::MarkManager::makeMark(), SwTextFrame::MakePos(), SwFltStackEntry::MakeRegion(), SwDoc::MakeUniqueNumRules(), SwRangeRedline::MoveFromSection(), SwDoc::MoveLeftMargin(), sw::DocumentContentOperationsManager::MoveNodeRange(), SwEditShell::MoveNumParas(), SwDoc::MoveParagraph(), SwDoc::MoveParagraphImpl(), sw::DocumentContentOperationsManager::MoveRange(), SwNodes::MoveRange(), SwUndoSaveContent::MoveToUndoNds(), SwDoc::NumUpDown(), SwRangeRedline::operator<(), OutASC_SwTextNode(), SwDoc::OutlineUpDown(), SwTextFrame::PaintEmpty(), PaMCorrAbs(), SwFEShell::Paste(), HTMLTable::PendingDrawObjectsInPaM(), SwHTMLParser::PendingObjectsInPaM(), SwWW8ImplReader::Read_And(), SwWW8ImplReader::Read_F_Tox(), SwWW8ImplReader::ReadText(), SwUndoDelete::RedoImpl(), SwUndoRedlineSort::RedoRedlineImpl(), SwUndo::RemoveIdxFromRange(), SwAccessibleParagraph::removeSelection(), sw::ReplaceBackReferences(), sw::ReplaceImpl(), sw::DocumentContentOperationsManager::ReplaceRange(), sw::DocumentContentOperationsManager::ReplaceRangeImpl(), SwDoc::ResetAttrs(), SwDoc::RstTextAttrs(), SaveFlyInRange(), SwUndoSaveSection::SaveSection(), SwWW8AttrIter::SearchNext(), SwCursorShell::SelectNxtPrvHyperlink(), sw::DocumentRedlineManager::SelNextRedline(), sw::DocumentRedlineManager::SelPrevRedline(), SwServerObject::SendDataChanged(), SwFltControlStack::SetAttrInDoc(), SwWW8FltControlStack::SetAttrInDoc(), SwDoc::SetCurFootnote(), SwRangeRedline::SetEnd(), SwUndoReplace::Impl::SetEnd(), SwDoc::SetFormatItemByAutoFormat(), SwUndoInserts::SetInsertRange(), SwEditShell::SetNumberingRestart(), SwXParagraph::setPropertyToDefault(), sw::DocumentRedlineManager::SetRedlineComment(), SwUndoRedlineSort::SetSaveRange(), SwDoc::SetTextFormatColl(), SwCursorShell::ShouldWait(), SwFEShell::Sort(), SwDoc::SortText(), SwDoc::Spell(), sw::DocumentRedlineManager::SplitRedline(), sw_GetJoinFlags(), SwUndoTextToTable::SwUndoTextToTable(), SwCursorShell::TestCurrPam(), SwDoc::TextToTable(), sw::DocumentContentOperationsManager::TransliterateText(), SwUndoInserts::UndoImpl(), SwUndoRedlineSort::UndoRedlineImpl(), SwDoc::UnProtectTables(), SwTextNode::Update(), sw::UpdateFramesForAddDeleteRedline(), sw::UpdateFramesForRemoveDeleteRedline(), SwCursor::UpDown(), Writer::Write(), and StgWriter::Write().

SwPosition* SwPaM::End ( )

inline

Definition at line 219 of file pam.hxx.

void SwPaM::Exchange ( )

Definition at line 492 of file pam.cxx.

References m_pMark, and m_pPoint.

Referenced by SwXTextViewCursor::collapseToEnd(), SwXTextCursor::collapseToEnd(), SwXTextViewCursor::collapseToStart(), SwXTextCursor::collapseToStart(), SwEditShell::Copy(), sw::DocumentContentOperationsManager::CopyImplImpl(), SwRangeRedline::DelCopyOfSection(), sw::DocumentContentOperationsManager::DelFullPara(), DoSearch(), sw::FindAttrImpl(), sw::FindFormatImpl(), SwFEShell::HasBoxSelection(), SwDoc::Hyphenate(), SwXReferenceMark::Impl::InsertRefMark(), SwXDocumentIndexMark::Impl::InsertTOXMark(), lcl_ExportHints(), lcl_FindSelection(), MakeBookRegionOrPoint(), SwTableCursor::MakeBoxSels(), sw::DocumentContentOperationsManager::MoveRange(), SwRangeRedline::MoveToSection(), Normalize(), SwWW8ImplReader::Read_F_Macro(), SwUndoDelete::RedoImpl(), SwUndo::RemoveIdxFromRange(), sw::DocumentContentOperationsManager::ReplaceRangeImpl(), SwCursorShell::SelTableBox(), SwEditWin::SetCursorTwipPosition(), SwEditShell::SetLinguRange(), sw_GetJoinFlags(), SwUndoDelete::SwUndoDelete(), SwUndoCompDoc::UndoImpl(), and SwCursor::UpDown().

SwPosition& SwPaM::GetBound ( bool bOne = true )

inline

Definition at line 245 of file pam.hxx.

Referenced by SwHTMLParser::Continue(), SwRangeRedline::DelCopyOfSection(), SwXMLImport::endDocument(), SwDoc::MergeTable(), SwRangeRedline::MoveFromSection(), SwDoc::MoveParagraphImpl(), XMLReader::Read(), WW8Reader::Read(), sw_JoinText(), and SwUndoCompDoc::UndoImpl().

const SwPosition& SwPaM::GetBound ( bool bOne = true ) const

inline

Definition at line 247 of file pam.hxx.

SwContentNode* SwPaM::GetContentNode ( bool bPoint = true ) const

inline

Returns: current ContentNode at Point/Mark

Definition at line 229 of file pam.hxx.

References SwNode::GetContentNode(), and GetNode().

Referenced by SwAutoFormat::BuildHeadLine(), CheckMergeSel(), CheckSplitCells(), SwAutoCorrDoc::ChgAutoCorrWord(), SwDoc::ClearLineNumAttrs(), SwEditWin::Command(), SwHTMLParser::Continue(), SwEditShell::Copy(), SwWW8ImplReader::CoreLoad(), SwLayIdle::DoIdleJob_(), SwWW8ImplReader::emulateMSWordAddTextToParagraph(), SwXMLImport::endDocument(), SwView::ExecSpellPopup(), SwEditShell::FillByEx(), SwViewShell::FillPrtDoc(), GetAutoSumSel(), SwUnoCursorHelper::GetCurPageStyle(), SwHTMLParser::GetCurrFormatColl(), GetMergeSel(), GetNode(), SwCursorShell::GetSmartTagRect(), GetTableSel(), SwCursor::GoPrevNextCell(), SwEditShell::HandleCorrectionError(), SwDoc::InsertGlossary(), wwSectionManager::InsertSegments(), SwCursor::IsAtLeftRightMargin(), IsAtStartOrEndOfFrame(), SwUnoCursorHelper::IsEndOfPara(), SwXTextCursor::isEndOfSentence(), SwCursorShell::isInHiddenTextFrame(), SwCursor::IsInProtectTable(), SwContentAtPos::IsInRTLText(), SwCursorShell::IsSelFullPara(), SwUnoCursor::IsSelOvr(), SwTableCursor::IsSelOvrCheck(), SwCursor::IsStartEndSentence(), SwEditWin::KeyInput(), lcl_EnsureValidPam(), lcl_GetStartEndCell(), lcl_MoveCursor(), lcl_SetAttrPam(), SwCursor::LeftRight(), SwCursor::LeftRightMargin(), SwRedlineTable::LOKRedlineNotification(), SwUnoTableCursor::MakeBoxSels(), SwRootFrame::MakeTableCursors(), SwCursorShell::MoveCursorToNum(), SwRangeRedline::MoveFromSection(), SwWW8ImplReader::MoveInsideFly(), SwDoc::MoveParagraphImpl(), SwUndoSaveContent::MovePtForward(), sw::DocumentContentOperationsManager::MoveRange(), WW8TabDesc::ParkPaM(), SwTable::PrepareMerge(), SwReader::Read(), SwWW8ImplReader::Read_F_IncludeText(), SwWW8ImplReader::Read_HdFtFootnoteText(), SwWW8ImplReader::Read_HdFtTextAsHackedFrame(), SwWW8ImplReader::ReadChar(), SwUndoRedlineSort::RedoRedlineImpl(), SwCursorShell::RefreshBlockCursor(), SwUndoInsert::RepeatImpl(), sw::ReplaceBackReferences(), SwCursor::RestoreSavePos(), SwEditShell::SaveGlossaryDoc(), SwUndoSaveSection::SaveSection(), SwCursorShell::SelTableRowOrCol(), SwDoc::SetBoxAttr(), SwPamRanges::SetPam(), WW8TabDesc::SetPamInCell(), SwWW8ImplReader::SetSpacing(), SwDoc::SetTabBorders(), SwDoc::SetTabLineStyle(), SwWW8ImplReader::simpleAddTextToParagraph(), SwFEShell::Sort(), SwDoc::SortText(), SwHTMLParser::StripTrailingPara(), SwCursorShell::SwCursorShell(), SwPaM(), SwEditShell::TableToText(), SwUndoCompDoc::UndoImpl(), SwUndoRedlineSort::UndoRedlineImpl(), SwCursorShell::UpdateCursor(), SwCursor::UpDown(), and SwCallLink::~SwCallLink().

SwDoc& SwPaM::GetDoc ( ) const

inline

Returns: the document (SwDoc) at which the PaM is registered

Definition at line 243 of file pam.hxx.

References SwNode::GetDoc(), SwNodeIndex::GetNode(), and SwPosition::nNode.

const SwPosition* SwPaM::GetMark ( ) const

inline

Definition at line 209 of file pam.hxx.

SwPosition* SwPaM::GetMark ( )

inline

Definition at line 210 of file pam.hxx.

SwPaM* SwPaM::GetNext ( )

inline

Definition at line 264 of file pam.hxx.

References sw::Ring< value_type >::GetNextInRing().

Referenced by SwEditShell::AutoFormat(), SwAccessibleMap::BuildSelectedParas(), CheckRange(), SwCursorShell::ClearUpCursors(), SwEditWin::Command(), Writer::CopyNextPam(), sw::DeepCopyPaM(), SwEditShell::Delete(), SwEditShell::DeleteGlobalDocContent(), SwAutoFormat::DeleteSelImpl(), SwDoc::FillRubyList(), SwCursorShell::GetCursorCnt(), SwUnoCursorHelper::GetCurTextFormatColl(), SwAccessibleFrameBase::GetSelectedState(), SwEditShell::GotoGlobalDocContent(), SwCursorShell::GotoRedline(), SwView::HyphenateDocument(), SwEditShell::InsertGlobalDocContent(), SwDoc::InsertGlossary(), SwEditShell::IsInsRegionAvailable(), lcl_FindSelection(), lcl_GetBoxSel(), lcl_SetNodeNumStart(), lcl_TstFlyRange(), SwTableCursor::MakeBoxSels(), SwDoc::MergeTable(), SwEditShell::MoveGlobalDocContent(), SwEditShell::MoveLeftMargin(), SwEditShell::NoNum(), SwUnoInternalPaM::operator=(), PaMCorrAbs(), PaMCorrRel(), SwCursorShell::ParkPams(), SwFEShell::Paste(), SwReader::Read(), SwAccessibleParagraph::removeSelection(), SwEditShell::ResetAttr(), SwUnoCursorHelper::resetCursorPropertyValue(), SwXTextView::select(), SwEditShell::SetAttrItem(), SwEditShell::SetAttrSet(), SwUnoCursorHelper::SetCursorAttr(), SwUnoCursorHelper::setNumberingProperty(), SwDoc::SetRubyList(), SwCursorShell::SetSelection(), SwView::StartTextConversion(), SwEditShell::TableToText(), SwEditShell::TransliterateText(), SwDoc::UnProtectTables(), SwWriter::Write(), SwDoc::~SwDoc(), and SwUnoInternalPaM::~SwUnoInternalPaM().

const SwPaM* SwPaM::GetNext ( ) const

inline

Definition at line 266 of file pam.hxx.

References sw::Ring< value_type >::GetNextInRing().

SwNode& SwPaM::GetNode ( bool bPoint = true ) const

inline

Returns: current Node at Point/Mark

Definition at line 223 of file pam.hxx.

References SwPosition::nNode.

Referenced by SwHTMLParser::AppendTextNode(), SwWW8ImplReader::AppendTextNode(), SwXFootnote::attach(), SwXTextField::attach(), SwXFrame::attachToRange(), SwEditShell::AutoCorrect(), SwAutoFormat::BuildEnum(), SwHTMLParser::BuildTable(), SwEditShell::CanMergeTable(), SwXText::Impl::CheckForOwnMember(), SwAutoCorrDoc::ChgAutoCorrWord(), SwXText::Impl::ConvertCell(), SwXText::convertToTextFrame(), SwFEShell::Copy(), SwFEShell::CopyDrawSel(), SwXBodyText::CreateTextCursor(), SwXTextFrame::createTextCursor(), SwXBodyText::createTextCursorByRange(), SwXCell::createTextCursorByRange(), SwXHeadFootText::createTextCursorByRange(), SwXTextFrame::createTextCursorByRange(), SwAutoFormat::DelEmptyLine(), SwAutoCorrDoc::Delete(), SwDoc::DeleteCol(), SwDoc::DeleteRow(), SwEditShell::DeleteSel(), SwWrtShell::DelLeft(), SwWrtShell::DelRight(), SwHTMLParser::EndPara(), SwHTMLParser::FinishFootEndNote(), SwEditShell::GetChunkForAutoText(), SwEditShell::GetCorrection(), SwEditShell::GetCurFootnote(), SwUnoCursorHelper::getCursorPropertyValue(), SwEditShell::GetCurWord(), SwRangeRedline::GetDescr(), SwEditShell::GetDropText(), SwSpellDialogChildWindow::GetFocus(), SwEditShell::GetGrammarCorrection(), SwEditShell::GetGrfSize(), SwEditShell::GetIMapGraphic(), SwCursorShell::GetOutlinePos(), SwDoc::GetPaMDescr(), SwEditShell::GetPrevAutoCorrWord(), SwXRedline::getPropertyValue(), SwXTextTableCursor::getPropertyValue(), SwXTextPortion::getString(), GetTableSel(), SwLangHelper::GetTextForLanguageGuessing(), SwCursor::GoEndWordWT(), SwCursorShell::GoNextCell(), SwCursor::GoNextWordWT(), SwCursor::GoPrevWordWT(), SwCursor::GoSentence(), SwCursor::GoStartWordWT(), GotoCurrRegionAndSkip(), SwCursor::GotoFootnoteAnchor(), SwCursorShell::GotoNextOutline(), SwCursorShell::GotoPrevOutline(), SwXTextViewCursor::gotoRange(), SwXTextCursor::gotoRange(), SwWW8ImplReader::HandlePageBreakChar(), SwFEShell::HasBoxSelection(), sw::sidebar::IMPL_LINK(), SwAutoCorrDoc::Insert(), SwWrtShell::Insert(), SwFEShell::Insert(), sw::DocumentContentOperationsManager::InsertDrawObj(), SwHTMLParser::InsertImage(), SwXReferenceMark::Impl::InsertRefMark(), SwXText::insertString(), SwXText::insertTextContent(), SwCursorShell::IsCursorInTable(), SwCursor::IsEndWordWT(), SwCursor::IsInProtectTable(), MSWordExportBase::IsInTable(), SwCursor::IsInWordWT(), SwUnoCursorHelper::IsNodeNumStart(), SwCursor::IsSelOvr(), SwCursor::IsStartWordWT(), SwAutoFormat::JoinPrevPara(), lcl_CollectDeletedRedlines(), lcl_CreatePortions(), lcl_GetBoxSel(), lcl_IsNewStyleTable(), lcl_UpDown(), SwNoTextFrame::LeftMargin(), SwTextFrame::LeftMargin(), SwSpellDialogChildWindow::LoseFocus(), SwDOCXReader::MakeEntries(), SwFEShell::MergeTab(), SwEditShell::MergeTable(), SwDoc::MergeTable(), sw::DocumentContentOperationsManager::MoveRange(), SwUndoSaveContent::MoveToUndoNds(), SwTableCursor::NewTableSelection(), SwHTMLParser::NextToken(), numfunc::NumDownChangesIndent(), WW8TabDesc::ParkPaM(), SwTransferable::Paste(), SwFEShell::Paste(), SwFEShell::PastePages(), SwWW8ImplReader::Read_F_IncludeText(), SwWW8ImplReader::Read_F_Tox(), SwWW8ImplReader::Read_LFOPosition(), SwWW8ImplReader::Read_LR(), SwWW8ImplReader::ReadText(), SwWW8ImplReader::ReadTextAttr(), SwUndoSort::RedoImpl(), SwWW8ImplReader::RegisterNumFormatOnTextNode(), SwUndoTextToTable::RepeatImpl(), SwUndoTableToText::RepeatImpl(), SwUndoFormatAttr::RepeatImpl(), SwUndoInsLayFormat::RepeatImpl(), SwUndoTableHeadline::RepeatImpl(), SwEditShell::ReplaceDropText(), SwAutoCorrDoc::ReplaceRange(), SwNoTextFrame::RightMargin(), SwTextFrame::RightMargin(), SwCursor::SelectWordWT(), SwHTMLParser::SetAnchorAndAdjustment(), SwAutoCorrDoc::SetAttr(), SwFltControlStack::SetAttrInDoc(), SwUnoCursorHelper::SetCursorAttr(), SwAutoCorrDoc::SetINetAttr(), SwUndRng::SetPaM(), WW8TabDesc::SetPamInCell(), SwXTextViewCursor::setPropertyValue(), SwXTextTableCursor::setPropertyValue(), SwWW8ImplReader::SetTextFormatCollAndListLevel(), SwEditShell::SplitTable(), SwPaM(), SwUndoDelete::SwUndoDelete(), SwUndoRedlineDelete::SwUndoRedlineDelete(), SwUndoTableMerge::SwUndoTableMerge(), SwAutoCorrDoc::TransliterateRTLWord(), SwUndoCompDoc::UndoImpl(), SwTextFrame::UnitDown_(), SwTextFrame::UnitUp_(), SwCursorShell::UpdateCursor(), SwCursor::UpDown(), sw::sidebar::WriterInspectorTextPanel::WriterInspectorTextPanel(), and MSWordExportBase::WriteText().

sal_uInt16 SwPaM::GetPageNum	(	bool	bAtPoint = `true`,
		const Point *	pLayPos = `nullptr`
	)

Get number of page which contains cursor.

return page number at cursor (for reader and page bound frames)

Definition at line 552 of file pam.cxx.

References SwFrame::FindPageFrame(), SwNode::GetContentNode(), IDocumentLayoutAccess::GetCurrentLayout(), SwNode::GetDoc(), SwDoc::getIDocumentLayoutAccess(), SwContentNode::getLayoutFrame(), SwNodeIndex::GetNode(), SwPageFrame::GetPhyPageNum(), m_pMark, m_pPoint, and SwPosition::nNode.

Referenced by sw::DocumentContentOperationsManager::CopyImplImpl(), SwXTextViewCursor::getPage(), SwFEShell::Insert(), and lcl_GetPrintUIOptions().

const SwPosition* SwPaM::GetPoint ( ) const

inline

Definition at line 207 of file pam.hxx.

SwPosition* SwPaM::GetPoint ( )

inline

Definition at line 208 of file pam.hxx.

SwPaM* SwPaM::GetPrev ( )

inline

Definition at line 268 of file pam.hxx.

References sw::Ring< value_type >::GetPrevInRing().

Referenced by SwAutoFormat::DeleteSelImpl(), SwEditShell::GetDropText(), SwCursorShell::GotoRedline(), SwTableCursor::MakeBoxSels(), and SwFEShell::Paste().

const SwPaM* SwPaM::GetPrev ( ) const

inline

Definition at line 270 of file pam.hxx.

References sw::Ring< value_type >::GetPrevInRing().

OUString SwPaM::GetText ( ) const

bool SwPaM::HasMark ( ) const

inline

A PaM marks a selection if Point and Mark are distinct positions.

Returns: true if the PaM spans a selection

Definition at line 205 of file pam.hxx.

Referenced by sw::DocumentRedlineManager::AcceptRedline(), SwDoc::AppendUndoForInsertFromDB(), SwEditShell::ApplyChangedSentence(), SwXTextField::attach(), SwXTextTable::attach(), SwXFrame::attachToRange(), SwEditShell::AutoFormat(), SwCursorShell::BlockCursorToCursor(), SwAccessibleMap::BuildSelectedParas(), SwHHCWrapper::ChangeText(), SwHHCWrapper::ChangeText_impl(), SwXMeta::CheckForOwnMemberMeta(), SwCursorShell::CheckTableBoxContent(), SwCursorShell::ClearUpCursors(), SwEditWin::Command(), SwHHCWrapper::Convert(), SwFormatClipboard::Copy(), sw::DocumentContentOperationsManager::CopyImplImpl(), sw::DocumentContentOperationsManager::CopyRange(), SwXRedlinePortion::CreateRedlineProperties(), SwAutoFormat::DelEmptyLine(), SwFltControlStack::Delete(), SwXTextRange::DeleteAndInsert(), SwChartDataSequence::DeleteBox(), sw::DocumentContentOperationsManager::DeleteRangeImplImpl(), sw::DocumentRedlineManager::DeleteRedline(), SwEditShell::DeleteSel(), sw::DocumentContentOperationsManager::DelFullPara(), SwLayIdle::DoIdleJob_(), dumpAsXml(), SwView::ExecSpellPopup(), SwView::Execute(), SwCursor::ExpandToSentenceBorders(), SwEditShell::FillByEx(), SwViewShell::FillPrtDoc(), SwShellCursor::FillRects(), SwCursor::FindAll(), SwRedlineTable::FindAtPosition(), SwCursorShell::FindValidContentNode(), SwEditWin::FlushInBuffer(), GetCellRangeName(), SwEditShell::GetCurLang(), SwEditShell::GetCurrentOutlineLevels(), SwCursorShell::GetCursorCnt(), SwEditShell::GetGrfNode_(), SwEditShell::GetGrfSize(), SwEditShell::GetIMapGraphic(), SwXRedline::getPropertyValue(), SwXTextTableCursor::getRangeName(), SwAccessibleFrameBase::GetSelectedState(), SwView::GetState(), SwXTextRange::getString(), SwUnoCursorHelper::GetTextFromPam(), SwCursorShell::GoNextCell(), SwXTextViewCursor::gotoRange(), SwXTextCursor::gotoRange(), SwCursorShell::GotoRedline(), SwNavigationMgr::GotoSwPosition(), SwCursor::GotoTable(), SwCursorShell::HasMark(), HasReadonlySel(), SwCursorShell::HasSelection(), SwXTextPortion::init(), SwXText::insertControlCharacter(), SwUnoCursorHelper::InsertFile(), SwDoc::InsertSwSection(), SwNodes::InsertTextSection(), SwEditShell::InsertURL(), SwCursor::IsInProtectTable(), SwEditShell::IsInsRegionAvailable(), SwDoc::IsInsRegionAvailable(), IDocumentMarkAccess::IsLegalPaMForCrossRefHeadingBookmark(), SwCursorShell::IsSelection(), SwUnoTableCursor::IsSelOvr(), SwCursor::IsSelOvr(), SwTableCursor::IsSelOvrCheck(), lcl_CreatePortions(), lcl_CursorOk(), lcl_CursorSelect(), lcl_dbg_out(), lcl_FillRedlineArray(), SwCursorShell::LeftRight(), SwTableCursor::MakeBoxSels(), sw::mark::MarkManager::makeMark(), sw::mark::MarkBase::MarkBase(), SwEditShell::MoveNumParas(), SwDoc::MoveParagraph(), sw::DocumentContentOperationsManager::MoveRange(), SwNodes::MoveRange(), SwCursor::MoveTable(), SwCursorShell::MoveTable(), SwFEShell::NewFlyFrame(), Normalize(), operator<<(), SwUnoInternalPaM::operator=(), operator=(), SwCursorShell::Push(), SwUndoDelete::RedoImpl(), sw::DocumentRedlineManager::RejectRedline(), SwAccessibleParagraph::removeSelection(), SwUndoOverwrite::RepeatImpl(), SwUndoDelete::RepeatImpl(), sw::ReplaceBackReferences(), sw::DocumentContentOperationsManager::ReplaceRangeImpl(), sw::mark::MarkManager::repositionMark(), sw::DocumentContentOperationsManager::ReRead(), SwDoc::ResetAttrs(), SwAccessibleContext::Select(), SwCursorShell::SelectHiddenRange(), SwDoc::SelectNextRubyChars(), SwContentTree::SelectOutlinesWithSelection(), SwUnoCursorHelper::SelectPam(), sw::DocumentRedlineManager::SelNextRedline(), sw::DocumentRedlineManager::SelPrevRedline(), SwFltControlStack::SetAttrInDoc(), SwCursorShell::SetCursor(), SwDoc::SetFormatItemByAutoFormat(), SwExtTextInput::SetInputData(), SwUndoInserts::SetInsertRange(), SwDoc::SetNumRule(), SwCursorShell::SetSelection(), SwUnoCursorHelper::SetString(), SwUndRng::SetValues(), SwCursor::SttEndDoc(), SwWrtShell::SttSelect(), SwRangeRedline::SwRangeRedline(), SwUndoDelete::SwUndoDelete(), SwUndoInsSection::SwUndoInsSection(), SwXRedlinePortion::SwXRedlinePortion(), SwXTextTableCursor::SwXTextTableCursor(), SwCursorShell::TestCurrPam(), SwUndoRedline::UndoImpl(), SwDoc::UnProtectTables(), SwTextNode::Update(), SwCursorShell::UpdateCursor(), SwEditShell::UpdateOneField(), SwCursor::UpDown(), SwWriter::Write(), sw::XTextRangeToSwPaM(), and SwCallLink::~SwCallLink().

bool SwPaM::HasReadonlySel ( bool bFormView ) const

Is in something protected (readonly) or selection contains something protected.

is in protected section or selection surrounds something protected

Definition at line 598 of file pam.cxx.

References End(), SwNode::FindSectionNode(), sw::proofreadingiterator::get(), IDocumentSettingAccess::get(), sw::DocumentSettingManager::get(), SwFormat::GetContent(), SwFormatContent::GetContentIdx(), SwNode::GetContentNode(), IDocumentLayoutAccess::GetCurrentLayout(), SwNode::GetDoc(), GetDoc(), SwDoc::GetDocumentSettingManager(), SwDoc::GetEditShell(), IDocumentMarkAccess::getFieldmarkFor(), sw::mark::IFieldmark::GetFieldname(), SwDoc::getIDocumentLayoutAccess(), SwDoc::getIDocumentMarkAccess(), SwDoc::getIDocumentSettingAccess(), SwIndex::GetIndex(), SwNodeIndex::GetIndex(), SwContentNode::getLayoutFrame(), GetMark(), sw::mark::IMark::GetMarkStart(), SwNodeIndex::GetNode(), SwNode::GetNodes(), GetPoint(), comphelper::getProcessComponentContext(), SwFormat::GetProtect(), SwSectionNode::GetSection(), SwNode::GetSectionNode(), SwDoc::GetSections(), HasMark(), i, IDocumentMarkAccess::isBookmarkDeleted(), SvxProtectItem::IsContentProtected(), SwEditShell::IsCursorInParagraphMetadataField(), SwNodes::IsDocNodes(), SwSection::IsEditInReadonlyFlag(), SwFrame::IsProtected(), SwSection::IsProtectFlag(), JumpEdit, lcl_FindEditInReadonlyFrame(), n, SwPosition::nContent, SwPosition::nNode, ODF_UNHANDLED, Point, PROTECT_BOOKMARKS, PROTECT_FIELDS, PROTECT_FORM, RES_TXTATR_FIELD(), SwVectorModifyBase< Value >::size(), and Start().

Referenced by SwCursorShell::HasReadonlySel(), and SwCursorShell::IsOverReadOnlyPos().

void SwPaM::InvalidatePaM ( )

Definition at line 1129 of file pam.cxx.

References End(), index, SwPosition::nNode, and Start().

Referenced by sw::mark::Fieldmark::Invalidate().

bool SwPaM::IsInFrontOfLabel ( ) const

inline

Definition at line 171 of file pam.hxx.

Referenced by SwAccessibleParagraph::GetCaretPos(), SwCursorShell::LeftRight(), and SwCursorShell::UpdateCursor().

bool SwPaM::IsMultiSelection ( ) const

inline

bool SwPaM::Move	(	SwMoveFnCollection const &	fnMove = `fnMoveForward`,
		SwGoInDoc	fnGo = `GoInContent`
	)

Movement of cursor.

movement of cursor

Definition at line 504 of file pam.cxx.

References m_bIsInFrontOfLabel.

Referenced by sw::DocumentContentOperationsManager::AppendTextNode(), SwXFrame::attachToRange(), SwEditShell::AutoFormatBySplitNode(), SwHTMLParser::BuildTableCell(), SwHTMLParser::CallParser(), SwDoc::ClearLineNumAttrs(), SwHTMLParser::Continue(), SwHHCWrapper::Convert(), SwXText::Impl::ConvertCell(), SwDoc::ConvertFieldsToText(), SwFormatClipboard::Copy(), sw::DocumentContentOperationsManager::CopyImplImpl(), SwWW8ImplReader::CoreLoad(), SwXRedlineText::createEnumeration(), SwXRedline::createEnumeration(), wwSectionManager::CreateSep(), SwXBodyText::CreateTextCursor(), SwXTextFrame::createTextCursor(), SwXHeadFootText::createTextCursorByRange(), SwXTextRange::DeleteAndInsert(), SwDoc::DeleteRowCol(), sw::DocumentContentOperationsManager::DelFullPara(), DoSearch(), SwAutoFormat::DoTable(), SwHTMLParser::EndAttr(), SwXMLImport::endDocument(), SwHTMLParser::EndSection(), SwChartDataSequence::ExtendTo(), SwDoc::FillRubyList(), SwXText::Impl::finishOrAppendParagraph(), SwXDocumentIndex::getAnchor(), SwXTextSection::getAnchor(), SwServerObject::GetData(), SwXTextRange::getEnd(), SwXTextRange::getStart(), GoNextPara(), GoPrevPara(), SwCursor::GotoRegion(), SwCursor::GotoTable(), SwCursor::GotoTableBox(), IMPL_LINK(), SwHTMLParser::InsertHorzRule(), SwHTMLParser::InsertImage(), wwSectionManager::InsertSegments(), SwNodes::InsertTextSection(), IsEmptyBox(), SwContentAtPos::IsInRTLText(), lcl_CpyBox(), lcl_EnsureValidPam(), SwCursor::LeftRight(), SwTableCursor::MakeBoxSels(), SwCursorShell::MakeOutlineSel(), SwDoc::MergeTable(), SwDoc::MoveParagraphImpl(), SwUndoSaveContent::MovePtBackward(), SwUndoSaveContent::MovePtForward(), sw::DocumentContentOperationsManager::MoveRange(), SwHTMLParser::NewDivision(), SwHTMLParser::NewMultiCol(), SwWW8ImplReader::Read_F_Macro(), SwUndoAttr::RedoImpl(), SwUndo::RemoveIdxFromRange(), SwUndoInsert::RepeatImpl(), SwUndoDelete::RepeatImpl(), SwUndoTableToText::RepeatImpl(), sw::DocumentContentOperationsManager::ReplaceRange(), sw::DocumentContentOperationsManager::ReplaceRangeImpl(), SwAccessibleTable::selectAccessibleChild(), SwCursorShell::SelTable(), SwCursorShell::SelTableBox(), SwCursorShell::SelTableRowOrCol(), SwHTMLParser::SetAnchorAndAdjustment(), SwUndRng::SetPaM(), SwXFrame::setPropertyValue(), SwDoc::SetRubyList(), SwHTMLParser::SplitAttrTab(), sw::DocumentContentOperationsManager::SplitNode(), SwXMLImport::startDocument(), SwHTMLParser::StripTrailingPara(), SwCursor::SttEndDoc(), SwFormatField::SwClientNotify(), SwUndoDelete::SwUndoDelete(), SwXTextTableCursor::SwXTextTableCursor(), SwEditShell::TableToText(), SwUndoInsert::UndoImpl(), SwUndoInserts::UndoImpl(), SwUndoSplitTable::UndoImpl(), SwTOXBaseSection::Update(), SwDoc::UpdatePagesForPrintingWithPostItData(), SwCursor::UpDown(), and SwWriter::Write().

void SwPaM::Normalize ( bool bPointFirst = true )

Normalizes PaM, i.e.

sort point and mark.

Parameters

bPointFirst true: If the point is behind the mark then swap. false: If the mark is behind the point then swap.

Definition at line 541 of file pam.cxx.

References Exchange(), HasMark(), m_pMark, and m_pPoint.

Referenced by sw::DocumentContentOperationsManager::DelFullPara(), SwTextShell::Execute(), FindAttrsImpl(), SwWrtShell::Insert(), SwXDocumentIndexMark::Impl::InsertTOXMark(), lcl_CreatePortions(), lcl_ExportHints(), and sw::DocumentContentOperationsManager::ReplaceRange().

SwPaM & SwPaM::operator= ( const SwPaM & rPam )

@@ semantic: no copy assignment for super class Ring.

Definition at line 460 of file pam.cxx.

References DeleteMark(), HasMark(), m_pMark, m_pPoint, and SetMark().

void SwPaM::SetInFrontOfLabel_ ( bool bNew )

inline

Definition at line 172 of file pam.hxx.

void SwPaM::SetMark ( )

virtual

Unless this is called, the getter method of Mark will return Point.

Reimplemented in SwShellTableCursor, and SwShellCursor.

Definition at line 478 of file pam.cxx.

References m_Bound1, m_Bound2, m_pMark, and m_pPoint.

const SwPosition* SwPaM::Start ( ) const

inline

Definition at line 212 of file pam.hxx.

SwPosition* SwPaM::Start ( )

inline

Definition at line 214 of file pam.hxx.

Member Data Documentation

bool SwPaM::m_bIsInFrontOfLabel

private

Definition at line 142 of file pam.hxx.

Referenced by Move().

SwPosition SwPaM::m_Bound1

private

Definition at line 138 of file pam.hxx.

Referenced by SetMark(), and SwPaM().

SwPosition SwPaM::m_Bound2

private

Definition at line 139 of file pam.hxx.

Referenced by SetMark(), and SwPaM().

SwPosition* SwPaM::m_pMark

private

points at either m_Bound1 or m_Bound2

Definition at line 141 of file pam.hxx.

Referenced by Exchange(), GetPageNum(), Normalize(), operator=(), SetMark(), and SwPaM().

SwPosition* SwPaM::m_pPoint

private

points at either m_Bound1 or m_Bound2

Definition at line 140 of file pam.hxx.

Referenced by Exchange(), GetPageNum(), Normalize(), operator=(), SetMark(), and SwPaM().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation