class KTextEditor.ModificationInterfaceabstract class |
|
|
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
See also KTextEditor.Document
Author Christoph Cullmann \ |
|
Virtual destructor. |
|
This signal is emitted whenever the document changed its modified-on-disk state. document - the Document object that represents the file on disk isModified - if true, the file was modified rather than created or deleted reason - the reason why the signal was emitted See also setModifiedOnDisk() |
|
Set the document's modified-on-disk state to reason. KTextEditor implementations should emit the signal modifiedOnDisk() along with the reason. When the document is in a clean state again the reason should be ModifiedOnDiskReason.OnDiskUnmodified.
reason - the modified-on-disk reason. See also ModifiedOnDiskReason, modifiedOnDisk() |
|
Control, whether the editor should show a warning dialog whenever a file was modified on disk. If on is true the editor will show warning dialogs. on - controls, whether the editor should show a warning dialog for files modified on disk |
|
Ask the user what to do, if the file was modified on disk. The argument view is used to avoid asking again, when the editor regains focus after the dialog is hidden. view - the view that should be notified of the user's decision See also setModifiedOnDisk(), modifiedOnDisk() |
OnDiskUnmodified | - | Not modified | |
OnDiskModified | - | The file was modified by another program | |
OnDiskCreated | - | The file was created by another program | |
OnDiskDeleted | - | The file was deleted |