PdfDocUndo Struct Reference

PdfDocUndo class. More...

#include <pdfix.h>

Public Member Functions
virtual bool	BeginOperation ()=0
virtual bool	EndOperation ()=0
virtual int	GetNumEntries () const =0
	Get the number of entries in the PdfDocUndo. More...
virtual bool	Execute ()=0
virtual int	GetTitle (wchar_t *buffer, int len) const =0
	Gets a undo title. More...
virtual void *	GetData ()=0
	Gets user-supplied data to pass to the element. More...

Detailed Description

PdfDocUndo class.

A PdfDocUndo object represents undo or redo operation on a PdfDoc.

Member Function Documentation

BeginOperation()

virtual bool PdfDocUndo::BeginOperation ( )

pure virtual

Begin tracking the document changes for collecting them into the PdfDocUndo object. You must call PdfDocUndo::EndOperation to stop collecting document change.

Returns

true if the tracking was successfully set, false otherwise.

See also

PdfDocUndo::EndOperation

EndOperation()

virtual bool PdfDocUndo::EndOperation ( )

pure virtual

Stop tracking the document changes for collecting them into the PdfDocUndo object. You must call PdfDocUndo::EndOperation to stop collecting document change.

Returns

true if the tracking was successfully set, false otherwise.

See also

PdfDocUndo::BegindOperation

Execute()

virtual bool PdfDocUndo::Execute ( )

pure virtual

Execute the PdfDocUndo. Execution of this undo automatically creates a redo operation to undo the undone changes and vice versa.

Returns

true if the undo/redo execution was successful, false otherwise.

GetData()

virtual void * PdfDocUndo::GetData ( )

pure virtual

Gets user-supplied data to pass to the element.

Returns

User-supplied data from the undo object.

GetNumEntries()

virtual int PdfDocUndo::GetNumEntries ( ) const

pure virtual

Get the number of entries in the PdfDocUndo.

Returns

the number of undo entries.

GetTitle()

virtual int PdfDocUndo::GetTitle ( wchar_t *  buffer, int  len  ) const

pure virtual

Gets a undo title.

Parameters

buffer	(filled by method) If the buffer is null function returns required length of string
len	Length of a buffer to be filled in.

Returns

Number of characters written into buffer of required length.