#include <IDocumentUndoRedo.hxx>

Inheritance diagram for IDocumentUndoRedo:

Public Member Functions
virtual void	DoUndo (bool const bDoUndo)=0
	Enable/Disable Undo. More...

virtual bool	DoesUndo () const =0
	Is Undo enabled? More...

virtual void	DoGroupUndo (bool const bDoUndo)=0
	Enable/Disable Group Undo. More...

virtual bool	DoesGroupUndo () const =0
	Is Group Undo enabled? More...

virtual void	DoDrawUndo (bool const bDoUndo)=0
	Enable/Disable Undo for Drawing objects. More...

virtual bool	DoesDrawUndo () const =0
	Is Undo for Drawing objects enabled? for Draw-Undo: writer wants to handle actions on Flys on its own. More...

virtual void	DoRepair (bool bRepair)=0
	Enable repair mode. More...

virtual bool	DoesRepair () const =0
	Is repair mode active? More...

virtual void	SetUndoNoModifiedPosition ()=0
	Set the position at which the document is in the "unmodified" state to the current position in the Undo stack. More...

virtual void	LockUndoNoModifiedPosition ()=0
	Prevent updates to the "unmodified" state position via SetUndoNoResetModified(). More...

virtual void	UnLockUndoNoModifiedPosition ()=0
	Allow updates to the "unmodified" state position via SetUndoNoResetModified(). More...

virtual void	SetUndoNoResetModified ()=0
	Disable (re)setting the document modified flag on Undo/Redo. More...

virtual bool	IsUndoNoResetModified () const =0
	Is setting the document modified flag on Undo/Redo disabled? More...

virtual bool	Undo ()=0
	Execute Undo. More...

virtual SwUndoId	StartUndo (SwUndoId const eUndoId, SwRewriter const *const pRewriter)=0
	Opens undo block. More...

virtual SwUndoId	EndUndo (SwUndoId const eUndoId, SwRewriter const *const pRewriter)=0
	Closes undo block. More...

virtual void	DelAllUndoObj ()=0
	Delete all Undo actions. More...

virtual bool	GetLastUndoInfo (OUString const o_pStr, SwUndoId const o_pId, const SwView *pView=nullptr) const =0
	Get Id and comment of last Undo action. More...

virtual SwUndoComments_t	GetUndoComments () const =0
	Get comments of Undo actions. More...

virtual bool	Redo ()=0
	Execute Redo. More...

virtual bool	GetFirstRedoInfo (OUString const o_pStr, SwUndoId const o_pId, const SwView *pView=nullptr) const =0
	Get Id and comment of first Redo action. More...

virtual SwUndoComments_t	GetRedoComments () const =0
	Get comments of Redo actions. More...

virtual bool	Repeat (::sw::RepeatContext &rContext, sal_uInt16 const nRepeatCnt)=0
	Repeat the last Undo action. More...

virtual SwUndoId	GetRepeatInfo (OUString *const o_pStr) const =0
	Get Id and comment of last Undo action, if it is Repeat capable. More...

virtual void	AppendUndo (std::unique_ptr< SwUndo > pUndo)=0
	Add new Undo action. More...

virtual void	ClearRedo ()=0
	Delete all Redo actions. More...

virtual bool	IsUndoNodes (SwNodes const &rNodes) const =0

virtual size_t	GetUndoActionCount (const bool bCurrentLevel=true) const =0
	Get the number of Undo actions. More...

virtual void	SetView (SwView *pView)=0
	Return undo/redo info for this view. More...

virtual bool	UndoWithOffset (size_t nUndoOffset)=0
	Zero offset means undoing the top undo action. More...

Protected Member Functions
virtual	~IDocumentUndoRedo ()

Detailed Description

Definition at line 37 of file IDocumentUndoRedo.hxx.

Constructor & Destructor Documentation

◆ ~IDocumentUndoRedo()

virtual IDocumentUndoRedo::~IDocumentUndoRedo ( )

inlineprotectedvirtual

Definition at line 219 of file IDocumentUndoRedo.hxx.

Member Function Documentation

◆ AppendUndo()

virtual void IDocumentUndoRedo::AppendUndo ( std::unique_ptr< SwUndo > pUndo )

pure virtual

Add new Undo action.

Takes over ownership of pUndo.

Remarks: calls ClearRedo(), except for SwUndoId::START/SwUndoIdEND.; does nothing if !DoesUndo().

Implemented in sw::UndoManager.

◆ ClearRedo()

virtual void IDocumentUndoRedo::ClearRedo ( )

pure virtual

Delete all Redo actions.

Implemented in sw::UndoManager.

◆ DelAllUndoObj()

virtual void IDocumentUndoRedo::DelAllUndoObj ( )

pure virtual

Delete all Undo actions.

Of course Undo will be disabled during deletion.

Implemented in sw::UndoManager.

Referenced by SwDoc::ClearDoc(), SwEditShell::DelAllUndoObj(), sw::DocumentLinksAdministrationManager::EmbedAllLinks(), SwDoc::InsertDrawLabel(), SwDoc::InsertLabel(), SwView::InsertMedium(), lcl_FindSelection(), SwDocShell::MakeByExample(), SwDoc::MakeFlyAndMove(), UnfloatTableButton::MouseButtonDown(), and SwDoc::ReplaceStyles().

◆ DoDrawUndo()

virtual void IDocumentUndoRedo::DoDrawUndo ( bool const bDoUndo )

pure virtual

Enable/Disable Undo for Drawing objects.

Implemented in sw::UndoManager.

Referenced by SwVirtFlyDrawObj::Crop(), sw::DrawUndoGuard::DrawUndoGuard(), SwFEShell::EndCreate(), SwFEShell::EndDrag(), SwFEShell::ImpEndCreate(), SwVirtFlyDrawObj::Move(), SwVirtFlyDrawObj::Resize(), and sw::DrawUndoGuard::~DrawUndoGuard().

◆ DoesDrawUndo()

virtual bool IDocumentUndoRedo::DoesDrawUndo ( ) const

pure virtual

Is Undo for Drawing objects enabled? for Draw-Undo: writer wants to handle actions on Flys on its own.

Implemented in sw::UndoManager.

Referenced by SwFEShell::ImpEndCreate().

◆ DoesGroupUndo()

virtual bool IDocumentUndoRedo::DoesGroupUndo ( ) const

pure virtual

Is Group Undo enabled?

Implemented in sw::UndoManager.

Referenced by sw::DocumentContentOperationsManager::DeleteAndJoinWithRedlineImpl(), sw::DocumentContentOperationsManager::DeleteRangeImplImpl(), SwEditShell::DoesGroupUndo(), sw::DocumentContentOperationsManager::InsertString(), sw::DocumentContentOperationsManager::Overwrite(), and SwExtTextInput::~SwExtTextInput().

◆ DoesRepair()

virtual bool IDocumentUndoRedo::DoesRepair ( ) const

pure virtual

Is repair mode active?

Implemented in sw::UndoManager.

Referenced by SwBaseShell::ExecUndo().

◆ DoesUndo()

virtual bool IDocumentUndoRedo::DoesUndo ( ) const

pure virtual

Is Undo enabled?

Implemented in sw::UndoManager.

◆ DoGroupUndo()

virtual void IDocumentUndoRedo::DoGroupUndo ( bool const bDoUndo )

pure virtual

Enable/Disable Group Undo.

This determines whether successive Insert/Delete/Overwrite actions are combined.

Implemented in sw::UndoManager.

Referenced by SwEditShell::DoGroupUndo(), sw::GroupUndoGuard::GroupUndoGuard(), sw::GroupUndoGuard::~GroupUndoGuard(), and SwExtTextInput::~SwExtTextInput().

◆ DoRepair()

virtual void IDocumentUndoRedo::DoRepair ( bool bRepair )

pure virtual

Enable repair mode.

Implemented in sw::UndoManager.

Referenced by SwBaseShell::ExecUndo().

◆ DoUndo()

virtual void IDocumentUndoRedo::DoUndo ( bool const bDoUndo )

pure virtual

Enable/Disable Undo.

Implemented in sw::UndoManager.

Referenced by SwFEShell::Copy(), SwFEShell::CreateDefaultShape(), SwEditShell::DoUndo(), GetMergeSel(), SwDoc::InsCopyOfTable(), SwUndoParagraphSigning::Insert(), SwDoc::InsertSwSection(), lcl_CreateWorkingDocument(), lcl_FindSelection(), sw::mark::MarkManager::makeFieldBookmark(), SwDoc::MakeFlyAndMove(), sw::mark::MarkManager::makeNoTextFieldBookmark(), SwDBManager::MergeMailFiles(), SwFEShell::NewFlyFrame(), SwTransferable::PrepareForCopyTextRange(), SwTable::PrepareMerge(), SwUndoParagraphSigning::Remove(), SwDoc::SetColRowWidthHeight(), SwDocStyleSheet::SetName(), SwDoc::SetTableAutoFormat(), SwDoc::SortText(), SwDoc::SplitDoc(), SwAutoFormat::SwAutoFormat(), SwEditShell::SwEditShell(), SwDoc::TextToTable(), sw::UndoGuard::UndoGuard(), SwDoc::~SwDoc(), and sw::UndoGuard::~UndoGuard().

◆ EndUndo()

virtual SwUndoId IDocumentUndoRedo::EndUndo	(	SwUndoId const	eUndoId,
		SwRewriter const *const	pRewriter
	)

pure virtual

Closes undo block.

Remarks: StartUndo() and EndUndo() do nothing if !DoesUndo().

Parameters

nUndoId	undo ID for the list action
pRewriter	rewriter for comments

See also: SwUndo::GetComment

If the given nUndoId is not SwUndoId::EMPTY or SwUndoId::END, the comment of the resulting list action will be set via the nUndoId, applying the given pRewriter (if not 0). Otherwise the comment of the resulting list action is unchanged if it has an UndoId that is not SwUndoId::START set by StartUndo, and in case the UndoId is SwUndoId::START the comment of the list action defaults to the comment of the last action contained in the list action.

Implemented in sw::UndoManager.

Referenced by sw::DocumentRedlineManager::AcceptAllRedline(), sw::DocumentRedlineManager::AcceptRedline(), SwDoc::AppendDoc(), SwEditShell::AppendTextNode(), SwXTextTable::attach(), SwXTextSection::attach(), SwXFrame::attachToRange(), SwDoc::Chain(), SwDoc::ChgAnchor(), SwDoc::ChkBoxNumFormat(), SwDoc::CompareDoc(), SwDoc::ConvertFieldsToText(), SwEditShell::Delete(), SwXTextCursor::DeleteAndInsert(), sw::DocumentContentOperationsManager::DeleteAndJoinWithRedlineImpl(), SwDoc::DeleteCol(), SwDrawView::DeleteMarked(), SwDoc::DeleteRow(), SwDoc::DeleteSelection(), SwDoc::DeleteTOX(), SwEditShell::DelNumRules(), SwDoc::DelSectionFormat(), SwEditShell::EndUndo(), SwTextShell::ExecField(), SwBreakDashedLine::execute(), SwCursor::Find_Text(), SwCursor::FindAttrs(), SwCursor::FindFormat(), SwWrtShell::GotoContentControl(), SwFmDrawPage::group(), SwEditShell::InsertGlobalDocContent(), SwDoc::InsertGlossary(), SwEditShell::InsertSection(), SwDoc::InsertTableOf(), SwEditShell::InsertURL(), lcl_setCharFormatSequence(), lcl_SetNodeNumStart(), SwDoc::MakeFlyAndMove(), SwDoc::MergeDoc(), SwEditShell::MergeTable(), SwDoc::MergeTable(), SwDoc::MoveParagraphImpl(), SwFEShell::NewFlyFrame(), SwEditShell::NoNum(), SwEditShell::NumUpDown(), SwDoc::OutlineUpDown(), SwEditShell::OutlineUpDown(), SwFEShell::Paste(), sw::DocumentRedlineManager::RejectRedline(), SwDoc::RemoveInvisibleContent(), SwEditShell::Replace(), SwDoc::ReplaceNumRule(), sw::DocumentContentOperationsManager::ReplaceRangeImpl(), SwEditShell::ResetAttr(), SwUnoCursorHelper::resetCursorPropertyValue(), SwFlyAtContentFrame::SetAbsPos(), SwEditShell::SetAttrItem(), SwEditShell::SetAttrSet(), SwEditShell::SetCurNumRule(), SwUnoCursorHelper::SetCursorAttr(), SwDocStyleSheet::SetItemSet(), SwEditShell::SetNodeNumStart(), SwUnoCursorHelper::setNumberingProperty(), SwDoc::SetNumRule(), SwEditShell::SetNumRuleStart(), SwDoc::SetOutlineNumRule(), SwXTextTable::setPropertyValue(), SwDoc::SetRubyList(), SwCursorShell::SetShadowCursorPos(), SwXText::setString(), SwUnoCursorHelper::SetString(), SwEditShell::SetTableBoxFormulaAttrs(), SwDoc::SetTabRows(), SwEditShell::SetTextFormatColl(), SwEditShell::SignParagraph(), SwDoc::SortText(), SwEditShell::SplitNode(), SwEditShell::SplitTable(), SwDoc::TextToTable(), SwEditShell::TransliterateText(), SwDoc::Unchain(), SwFmDrawPage::ungroup(), SwDoc::UnProtectTables(), SwTOXMgr::UpdateOrInsertTOX(), SwEditShell::UpdateTableOf(), and SwExtTextInput::~SwExtTextInput().

◆ GetFirstRedoInfo()

virtual bool IDocumentUndoRedo::GetFirstRedoInfo	(	OUString *const	o_pStr,
		SwUndoId *const	o_pId,
		const SwView *	pView = `nullptr`
	)		const

pure virtual

Get Id and comment of first Redo action.

Parameters

o_pStr	if not 0, receives comment of first Redo action.
o_pId	if not 0, receives Id of first Redo action.
pView	if not nullptr, get the info for this view

Returns: true if there is a Redo action, false if none

Implemented in sw::UndoManager.

Referenced by SwDoc::ChgPageDesc(), SwBaseShell::ExecUndo(), SwEditShell::GetFirstRedoInfo(), and SwEditShell::Redo().

◆ GetLastUndoInfo()

virtual bool IDocumentUndoRedo::GetLastUndoInfo	(	OUString *const	o_pStr,
		SwUndoId *const	o_pId,
		const SwView *	pView = `nullptr`
	)		const

pure virtual

Get Id and comment of last Undo action.

Parameters

o_pStr	if not 0, receives comment of last Undo action.
o_pId	if not 0, receives Id of last Undo action.
pView	if not nullptr, get the info for this view

Returns: true if there is a Undo action, false if none

Implemented in sw::UndoManager.

Referenced by SwBaseShell::ExecUndo(), and SwEditShell::GetLastUndoInfo().

◆ GetRedoComments()

virtual SwUndoComments_t IDocumentUndoRedo::GetRedoComments ( ) const

pure virtual

Get comments of Redo actions.

Returns: comments of all top-level Redo actions.

Implemented in sw::UndoManager.

Referenced by SwWrtShell::GetDoStrings().

◆ GetRepeatInfo()

virtual SwUndoId IDocumentUndoRedo::GetRepeatInfo ( OUString *const o_pStr ) const

pure virtual

Get Id and comment of last Undo action, if it is Repeat capable.

Parameters

o_pStr if not 0, receives comment of last Undo action if it is Repeat capable.

Returns: Id of last Undo action if it is Repeat capable, or SwUndoId::EMPTY if there is none or it is not Repeat capable.

Implemented in sw::UndoManager.

Referenced by SwEditShell::GetRepeatInfo().

◆ GetUndoActionCount()

virtual size_t IDocumentUndoRedo::GetUndoActionCount ( const bool bCurrentLevel = true ) const

pure virtual

Get the number of Undo actions.

Implemented in sw::UndoManager.

Referenced by SwEditWin::Command(), SwEditWin::MouseButtonUp(), SwEditWin::SetApplyTemplate(), and SwExtTextInput::~SwExtTextInput().

◆ GetUndoComments()

virtual SwUndoComments_t IDocumentUndoRedo::GetUndoComments ( ) const

pure virtual

Get comments of Undo actions.

Returns: comments of all top-level Undo actions.

Implemented in sw::UndoManager.

Referenced by SwWrtShell::GetDoStrings().

◆ IsUndoNodes()

virtual bool IDocumentUndoRedo::IsUndoNodes ( SwNodes const & rNodes ) const

pure virtual

Implemented in sw::UndoManager.

Referenced by SwNodes::ChgNode(), SwNodes::CopyNodes(), SwTextNode::CopyText(), SwTextNode::CutImpl(), SwTextNode::IsInUndo(), SwSectionNode::MakeCopy(), and SwNodes::MoveNodes().

◆ IsUndoNoResetModified()

virtual bool IDocumentUndoRedo::IsUndoNoResetModified ( ) const

pure virtual

Is setting the document modified flag on Undo/Redo disabled?

Implemented in sw::UndoManager.

◆ LockUndoNoModifiedPosition()

virtual void IDocumentUndoRedo::LockUndoNoModifiedPosition ( )

pure virtual

Prevent updates to the "unmodified" state position via SetUndoNoResetModified().

Implemented in sw::UndoManager.

◆ Redo()

virtual bool IDocumentUndoRedo::Redo ( )

pure virtual

Execute Redo.

Returns: true if executing the first Redo action was successful.

Implemented in sw::UndoManager.

Referenced by SwEditShell::Redo().

◆ Repeat()

virtual bool IDocumentUndoRedo::Repeat	(	::sw::RepeatContext &	rContext,
		sal_uInt16 const	nRepeatCnt
	)

pure virtual

Repeat the last Undo action.

Returns: true if repeating the last Undo Redo action was attempted.

Implemented in sw::UndoManager.

Referenced by SwEditShell::Repeat().

◆ SetUndoNoModifiedPosition()

virtual void IDocumentUndoRedo::SetUndoNoModifiedPosition ( )

pure virtual

Set the position at which the document is in the "unmodified" state to the current position in the Undo stack.

Implemented in sw::UndoManager.

Referenced by sw::DocumentStateManager::ResetModified().

◆ SetUndoNoResetModified()

virtual void IDocumentUndoRedo::SetUndoNoResetModified ( )

pure virtual

Disable (re)setting the document modified flag on Undo/Redo.

Implemented in sw::UndoManager.

Referenced by IMPL_LINK_NOARG(), SwUserFieldType::SetContent(), SwEditShell::SetGlblDocSaveLinks(), SwEditShell::SetTableChgMode(), and SwEditShell::SetUndoNoResetModified().

◆ SetView()

virtual void IDocumentUndoRedo::SetView ( SwView * pView )

pure virtual

Return undo/redo info for this view.

Implemented in sw::UndoManager.

Referenced by SwDrawTextShell::StateUndo().

◆ StartUndo()

virtual SwUndoId IDocumentUndoRedo::StartUndo	(	SwUndoId const	eUndoId,
		SwRewriter const *const	pRewriter
	)

pure virtual

Opens undo block.

Remarks: StartUndo() and EndUndo() do nothing if !DoesUndo().

Parameters

nUndoId	undo ID for the list action
pRewriter	rewriter for comments

See also: SwUndo::GetComment

If the given nUndoId is equal to zero an undo object with ID SwUndoId::START will be generated.

Returns: the undo ID of the created object

Implemented in sw::UndoManager.

Referenced by sw::DocumentRedlineManager::AcceptAllRedline(), sw::DocumentRedlineManager::AcceptRedline(), SwDoc::AppendDoc(), SwEditShell::AppendTextNode(), SwXTextTable::attach(), SwXTextSection::attach(), SwXFrame::attachToRange(), SwDoc::Chain(), SwDoc::ChgAnchor(), SwDoc::ChkBoxNumFormat(), SwDoc::CompareDoc(), SwDoc::ConvertFieldsToText(), SwEditShell::Delete(), SwXTextCursor::DeleteAndInsert(), sw::DocumentContentOperationsManager::DeleteAndJoinWithRedlineImpl(), SwDoc::DeleteCol(), SwDrawView::DeleteMarked(), SwDoc::DeleteRow(), SwEditShell::DeleteSel(), SwDoc::DeleteSelection(), SwDoc::DeleteTOX(), SwEditShell::DelNumRules(), SwDoc::DelSectionFormat(), SwTextShell::ExecField(), SwBreakDashedLine::execute(), SwCursor::Find_Text(), SwCursor::FindAttrs(), SwCursor::FindFormat(), SwWrtShell::GotoContentControl(), SwFmDrawPage::group(), SwEditShell::InsertGlobalDocContent(), SwDoc::InsertGlossary(), SwEditShell::InsertSection(), SwDoc::InsertTableOf(), SwEditShell::InsertURL(), lcl_setCharFormatSequence(), lcl_SetNodeNumStart(), SwDoc::MakeFlyAndMove(), SwDoc::MergeDoc(), SwEditShell::MergeTable(), SwDoc::MergeTable(), SwDoc::MoveParagraphImpl(), SwFEShell::NewFlyFrame(), SwEditShell::NoNum(), SwEditShell::NumUpDown(), SwDoc::OutlineUpDown(), SwEditShell::OutlineUpDown(), SwFEShell::Paste(), sw::DocumentRedlineManager::RejectRedline(), SwDoc::RemoveInvisibleContent(), SwEditShell::Replace(), SwDoc::ReplaceNumRule(), sw::DocumentContentOperationsManager::ReplaceRangeImpl(), SwEditShell::ResetAttr(), SwUnoCursorHelper::resetCursorPropertyValue(), SwFlyAtContentFrame::SetAbsPos(), SwEditShell::SetAttrItem(), SwEditShell::SetAttrSet(), SwEditShell::SetCurNumRule(), SwUnoCursorHelper::SetCursorAttr(), SwDocStyleSheet::SetItemSet(), SwEditShell::SetNodeNumStart(), SwUnoCursorHelper::setNumberingProperty(), SwDoc::SetNumRule(), SwEditShell::SetNumRuleStart(), SwDoc::SetOutlineNumRule(), SwXTextTable::setPropertyValue(), SwDoc::SetRubyList(), SwCursorShell::SetShadowCursorPos(), SwXText::setString(), SwUnoCursorHelper::SetString(), SwEditShell::SetTableBoxFormulaAttrs(), SwDoc::SetTabRows(), SwEditShell::SetTextFormatColl(), SwEditShell::SignParagraph(), SwDoc::SortText(), SwEditShell::SplitNode(), SwEditShell::SplitTable(), SwEditShell::StartUndo(), SwDoc::TextToTable(), SwEditShell::TransliterateText(), SwDoc::Unchain(), SwFmDrawPage::ungroup(), SwDoc::UnProtectTables(), SwTOXMgr::UpdateOrInsertTOX(), SwEditShell::UpdateTableOf(), and SwExtTextInput::~SwExtTextInput().

◆ Undo()

virtual bool IDocumentUndoRedo::Undo ( )

pure virtual

Execute Undo.

Returns: true if executing the last Undo action was successful.

Implemented in sw::UndoManager.

Referenced by SwDoc::RestoreInvisibleContent().

◆ UndoWithOffset()

virtual bool IDocumentUndoRedo::UndoWithOffset ( size_t nUndoOffset )

pure virtual

Zero offset means undoing the top undo action.

Implemented in sw::UndoManager.

Referenced by SwEditShell::Undo().

◆ UnLockUndoNoModifiedPosition()

virtual void IDocumentUndoRedo::UnLockUndoNoModifiedPosition ( )

pure virtual

Allow updates to the "unmodified" state position via SetUndoNoResetModified().

Implemented in sw::UndoManager.

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

IDocumentUndoRedo.hxx

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IDocumentUndoRedo()

Member Function Documentation

◆ AppendUndo()

◆ ClearRedo()

◆ DelAllUndoObj()

◆ DoDrawUndo()

◆ DoesDrawUndo()

◆ DoesGroupUndo()

◆ DoesRepair()

◆ DoesUndo()

◆ DoGroupUndo()

◆ DoRepair()

◆ DoUndo()

◆ EndUndo()

◆ GetFirstRedoInfo()

◆ GetLastUndoInfo()

◆ GetRedoComments()

◆ GetRepeatInfo()

◆ GetUndoActionCount()

◆ GetUndoComments()

◆ IsUndoNodes()

◆ IsUndoNoResetModified()

◆ LockUndoNoModifiedPosition()

◆ Redo()

◆ Repeat()

◆ SetUndoNoModifiedPosition()

◆ SetUndoNoResetModified()

◆ SetView()

◆ StartUndo()

◆ Undo()

◆ UndoWithOffset()

◆ UnLockUndoNoModifiedPosition()