KCoreAddons

kbackup.h
1 /*
2  This file is part of the KDE libraries
3 
4  SPDX-FileCopyrightText: 1999 Waldo Bastian <[email protected]>
5  SPDX-FileCopyrightText: 2006 Jaison Lee <[email protected]>
6  SPDX-FileCopyrightText: 2011 Romain Perier <[email protected]>
7 
8  SPDX-License-Identifier: LGPL-2.0-only
9 */
10 
11 #ifndef KBACKUP_H
12 #define KBACKUP_H
13 
14 #include <kcoreaddons_export.h>
15 #include <QString>
16 
21 namespace KBackup
22 {
23 #if KCOREADDONS_ENABLE_DEPRECATED_SINCE(5, 75)
24 
56 KCOREADDONS_DEPRECATED_VERSION_BELATED(5, 75, 5, 0, "Use simpleBackupFile() or numberedBackupFile() directly")
57 KCOREADDONS_EXPORT bool backupFile(const QString &filename,
58  const QString &backupDir = QString());
59 #endif
60 
72 KCOREADDONS_EXPORT bool simpleBackupFile(const QString &filename,
73  const QString &backupDir = QString(),
74  const QString &backupExtension = QStringLiteral("~"));
75 
103 KCOREADDONS_EXPORT bool numberedBackupFile(const QString &filename,
104  const QString &backupDir = QString(),
105  const QString &backupExtension = QStringLiteral("~"),
106  const uint maxBackups = 10
107  );
108 
109 #if KCOREADDONS_ENABLE_DEPRECATED_SINCE(5, 75)
110 
133 KCOREADDONS_DEPRECATED_VERSION(5, 75, "No known users")
134 KCOREADDONS_EXPORT bool rcsBackupFile(const QString &filename,
135  const QString &backupDir = QString(),
136  const QString &backupMessage = QString()
137  );
138 #endif
139 }
140 
141 #endif
bool rcsBackupFile(const QString &qFilename, const QString &backupDir, const QString &backupMessage)
Function to create an rcs backup file for a given filename.
Definition: kbackup.cpp:50
bool numberedBackupFile(const QString &qFilename, const QString &backupDir, const QString &backupExtension, const uint maxBackups)
Function to create a backup file for a given filename.
Definition: kbackup.cpp:125
Provides utility functions for backup of files.
Definition: kbackup.cpp:23
bool simpleBackupFile(const QString &qFilename, const QString &backupDir, const QString &backupExtension)
Function to create a backup file for a given filename.
Definition: kbackup.cpp:33
KCOREADDONS_DEPRECATED_VERSION_BELATED(5, 75, 5, 0,"Use simpleBackupFile() or numberedBackupFile() directly") KCOREADDONS_EXPORT bool backupFile(const QString &filename
Function to create a backup file before saving.
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Fri Nov 27 2020 23:03:55 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.