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 {
36 KCOREADDONS_EXPORT bool backupFile(const QString &filename,
37  const QString &backupDir = QString());
38 
50 KCOREADDONS_EXPORT bool simpleBackupFile(const QString &filename,
51  const QString &backupDir = QString(),
52  const QString &backupExtension = QStringLiteral("~"));
53 
81 KCOREADDONS_EXPORT bool numberedBackupFile(const QString &filename,
82  const QString &backupDir = QString(),
83  const QString &backupExtension = QStringLiteral("~"),
84  const uint maxBackups = 10
85  );
86 
109 KCOREADDONS_EXPORT bool rcsBackupFile(const QString &filename,
110  const QString &backupDir = QString(),
111  const QString &backupMessage = QString()
112  );
113 }
114 
115 #endif
bool backupFile(const QString &qFilename, const QString &backupDir)
Function to create a backup file before saving.
Definition: kbackup.cpp:24
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:63
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:137
Provides utility functions for backup of files.
Definition: kbackup.cpp:21
bool simpleBackupFile(const QString &qFilename, const QString &backupDir, const QString &backupExtension)
Function to create a backup file for a given filename.
Definition: kbackup.cpp:47
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Tue May 26 2020 23:09:02 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.