class KTextEditor.ModificationInterface


abstract class

Table of contents
Modules
ktexteditor Classes
All Classes
Module ktexteditor
Namespace ktexteditor
Class KTextEditor.ModificationInterface
Inherits

External modification extension interface for the Document.

Introduction

The class ModificationInterface provides methods to handle modifications of all opened files caused by external programs. Whenever the modified-on-disk state changes the signal modifiedOnDisk() is emitted along with a ModifiedOnDiskReason. Set the state by calling setModifiedOnDisk(). Whether the Editor should show warning dialogs to inform the user about external modified files can be controlled with setModifiedOnDiskWarning(). The slot modifiedOnDisk() is called to ask the user what to do whenever a file was modified.

Accessing the ModificationInterface

The ModificationInterface is supposed to be an extension interface for a Document, i.e. the Document inherits the interface provided that the used KTextEditor library implements the interface. Use qobject_cast to access the interface:

// doc is of type KTextEditor.Document*
KTextEditor.ModificationInterface *iface =
qobject_cast( doc );

if( iface ) { // the implementation supports the interface // do stuff }

See also KTextEditor.Document Author Christoph Cullmann \



enums

enum details

methods