/usr/include/ktexteditor/recoveryinterface.h is in kdelibs5-dev 4:4.13.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | /* This file is part of the KDE project
Copyright (C) 2010 David Nolden (david.nolden.kdevelop@art-master.de)
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KDELIBS_KTEXTEDITOR_RECOVERYINTERFACE_H
#define KDELIBS_KTEXTEDITOR_RECOVERYINTERFACE_H
#include <ktexteditor/ktexteditor_export.h>
namespace KTextEditor
{
/**
* \brief Document extension interface to control crash recovery.
*
* \ingroup kte_group_doc_extensions
*
* 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
*/
class KTEXTEDITOR_EXPORT RecoveryInterface
{
public:
/**
* Constructor.
*/
RecoveryInterface();
/**
* Virtual destructor.
*/
virtual ~RecoveryInterface();
public:
/**
* Returns whether a recovery is available for the current document.
*
* \see recoverData(), discardDataRecovery()
*/
virtual bool isDataRecoveryAvailable() const = 0;
/**
* If recover data is available, calling recoverData() will trigger the
* recovery of the data. If isDataRecoveryAvailable() returns \e false,
* calling this function does nothing.
*
* \see isDataRecoveryAvailable(), discardDataRecovery()
*/
virtual void recoverData() = 0;
/**
* If recover data is available, calling discardDataRecovery() will discard
* the recover data and the recover data is lost.
* If isDataRecoveryAvailable() returns \e false, calling this function
* does nothing.
*
* \see isDataRecoveryAvailable(), recoverData()
*/
virtual void discardDataRecovery() = 0;
/**
* TODO KDE5 (see SwapFile::setTrackingEnabled())
* Enables or disables the writing of swap files.
* @note Enabling/disabling only works when the document is \e not modified!
*/
// void setDataRecoveryEnabled(bool enable);
// bool dataRecoveryEnabled() const;
private:
class RecoveryInterfacePrivate* const d;
};
}
Q_DECLARE_INTERFACE(KTextEditor::RecoveryInterface, "org.kde.KTextEditor.RecoveryInterface")
#endif
// kate: space-indent on; indent-width 2; replace-tabs on;
|