KTextEditor::RecoveryInterface Class Reference

Document extension interface to control crash recovery. More...

#include <recoveryinterface.h>

List of all members.

Public Member Functions
	RecoveryInterface ()
virtual	~RecoveryInterface ()
virtual void	discardDataRecovery ()=0
virtual bool	isDataRecoveryAvailable () const =0
virtual void	recoverData ()=0

---

Detailed Description

Document extension interface to control crash recovery.

When the system or the application using the editor component crashed with unsaved changes in the Document, the View notifies the user about the lost data and asks, whether the data should be recovered.

This interface gives you control over the data recovery process. Use isDataRecoveryAvailable() to check for lost data. If you do not want the editor component to handle the data recovery process automatically, you can either trigger the data recovery by calling recoverData() or discard it by discardDataRecovery().

Since:

4.6

Definition at line 44 of file recoveryinterface.h.

---

Constructor & Destructor Documentation

RecoveryInterface::RecoveryInterface

(

)

Constructor.

Definition at line 310 of file ktexteditor.cpp.

RecoveryInterface::~RecoveryInterface

(

)

[virtual]

Virtual destructor.

Definition at line 314 of file ktexteditor.cpp.

---

Member Function Documentation

virtual void KTextEditor::RecoveryInterface::discardDataRecovery

(

)

[pure virtual]

If recover data is available, calling discardDataRecovery() will discard the recover data and the recover data is lost.

If isDataRecoveryAvailable() returns false, calling this function does nothing.

See also:

isDataRecoveryAvailable(), recoverData()

virtual bool KTextEditor::RecoveryInterface::isDataRecoveryAvailable

(

)

const [pure virtual]

Returns whether a recovery is available for the current document.

See also:

recoverData(), discardDataRecovery()

virtual void KTextEditor::RecoveryInterface::recoverData

(

)

[pure virtual]

If recover data is available, calling recoverData() will trigger the recovery of the data.

If isDataRecoveryAvailable() returns false, calling this function does nothing.

See also:

isDataRecoveryAvailable(), discardDataRecovery()

---

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

• recoveryinterface.h
• ktexteditor.cpp