• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KTextEditor

  • interfaces
  • ktexteditor
modificationinterface.h
Go to the documentation of this file.
1/* This file is part of the KDE project
2 Copyright (C) 2005 Christoph Cullmann (cullmann@kde.org)
3 Copyright (C) 2005 Dominik Haumann (dhdev@gmx.de) (documentation)
4
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public
7 License as published by the Free Software Foundation; either
8 version 2 of the License, or (at your option) any later version.
9
10 This library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Library General Public License for more details.
14
15 You should have received a copy of the GNU Library General Public License
16 along with this library; see the file COPYING.LIB. If not, write to
17 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
19*/
20
21#ifndef KDELIBS_KTEXTEDITOR_MODIFICATIONINTERFACE_H
22#define KDELIBS_KTEXTEDITOR_MODIFICATIONINTERFACE_H
23
24#include <ktexteditor/ktexteditor_export.h>
25
26#include <QtCore/QObject>
27
28namespace KTextEditor
29{
30
31class Document;
32class View;
33
70class KTEXTEDITOR_EXPORT ModificationInterface
71{
72 public:
73 ModificationInterface ();
74
78 virtual ~ModificationInterface ();
79
80 public:
84 enum ModifiedOnDiskReason {
85 OnDiskUnmodified = 0,
86 OnDiskModified = 1,
87 OnDiskCreated = 2,
88 OnDiskDeleted = 3
89 };
90
91 public:
101 virtual void setModifiedOnDisk( ModifiedOnDiskReason reason ) = 0;
102
110 virtual void setModifiedOnDiskWarning ( bool on ) = 0;
111
112 /*
113 * These stuff is implemented as SLOTS in the real document
114 */
115 public:
123 virtual void slotModifiedOnDisk( View *view = 0 ) = 0;
124
125 /*
126 * These stuff is implemented as SIGNALS in the real document
127 */
128 public:
138 virtual void modifiedOnDisk (KTextEditor::Document *document,
139 bool isModified,
140 KTextEditor::ModificationInterface::ModifiedOnDiskReason reason) = 0;
141
142 private:
143 class ModificationInterfacePrivate* const d;
144};
145
146}
147
148Q_DECLARE_INTERFACE(KTextEditor::ModificationInterface, "org.kde.KTextEditor.ModificationInterface")
149
150#endif
151
152// kate: space-indent on; indent-width 2; replace-tabs on;
153
KTextEditor::Document
A KParts derived class representing a text document.
Definition: document.h:112
KTextEditor::ModificationInterface
External modification extension interface for the Document.
Definition: modificationinterface.h:71
KTextEditor::ModificationInterface::ModifiedOnDiskReason
ModifiedOnDiskReason
Reasons why a document is modified on disk.
Definition: modificationinterface.h:84
KTextEditor::ModificationInterface::setModifiedOnDiskWarning
virtual void setModifiedOnDiskWarning(bool on)=0
Control, whether the editor should show a warning dialog whenever a file was modified on disk.
KTextEditor::ModificationInterface::setModifiedOnDisk
virtual void setModifiedOnDisk(ModifiedOnDiskReason reason)=0
Set the document's modified-on-disk state to reason.
KTextEditor::ModificationInterface::slotModifiedOnDisk
virtual void slotModifiedOnDisk(View *view=0)=0
Ask the user what to do, if the file was modified on disk.
KTextEditor::ModificationInterface::modifiedOnDisk
virtual void modifiedOnDisk(KTextEditor::Document *document, bool isModified, KTextEditor::ModificationInterface::ModifiedOnDiskReason reason)=0
This signal is emitted whenever the document changed its modified-on-disk state.
KTextEditor::View
A text widget with KXMLGUIClient that represents a Document.
Definition: view.h:146
ktexteditor_export.h
KTextEditor
Namespace for the KDE Text Editor Interfaces.
Definition: annotationinterface.h:31
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KTextEditor

Skip menu "KTextEditor"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal