Description

This suspends all update messages from WSM until either the object is destroyed, or resume is called.

The top level history ID provided is included in the kLoadComplete message sent upon resume. This tells the receiver of the message into which history the load was done.

#include <FormItUndoManager.h>

Public Member Functions
	Suspend (bool bSuppress, size_t nTopLevelHistory, bool bFullUpdate)
	The bSuppress parameter can be set to false to indicate that the object should not take effect.

	~Suspend ()

void	resume ()

Constructor & Destructor Documentation

◆ Suspend()

FormIt::UndoManagement::Suspend::Suspend	(	bool	bSuppress,
		size_t	nTopLevelHistory,
		bool	bFullUpdate
	)

explicit

The bSuppress parameter can be set to false to indicate that the object should not take effect.

This is used to allow run-time determination while still using a stack object.

Parameters

nTopLevelHistory	= WSM::INVALID_ID
bFullUpdate	= true

◆ ~Suspend()

FormIt::UndoManagement::Suspend::~Suspend ( )

Member Function Documentation

◆ resume()

void FormIt::UndoManagement::Suspend::resume ( )

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