File indexing completed on 2024-05-19 03:56:19

 /*
     This file is part of the KDE libraries
 
     SPDX-FileCopyrightText: 1999 Waldo Bastian <bastian@kde.org>
     SPDX-FileCopyrightText: 2006 Jaison Lee <lee.jaison@gmail.com>
     SPDX-FileCopyrightText: 2011 Romain Perier <bambi@ubuntu.com>
 
     SPDX-License-Identifier: LGPL-2.0-only
 */
 
 #ifndef KBACKUP_H
 #define KBACKUP_H
 
 #include <QString>
 #include <kcoreaddons_export.h>
 
 /**
  * @namespace KBackup
  * Provides utility functions for backup of files.
  */
 namespace KBackup
 {
 /**
  * @brief Function to create a backup file for a given filename.
  *
  * This function creates a backup file from the given filename.
  * You can use this method even if you don't use KSaveFile.
  * @param filename the file to backup
  * @param backupDir optional directory where to save the backup file in.
  * If empty (the default), the backup will be in the same directory as @p filename.
  * @param backupExtension the extension to append to @p filename, "~" by default.
  * @return true if successful, or false if an error has occurred.
  */
 KCOREADDONS_EXPORT bool simpleBackupFile(const QString &filename, const QString &backupDir = QString(), const QString &backupExtension = QStringLiteral("~"));
 
 /**
  * @brief Function to create a backup file for a given filename.
  *
  * This function creates a series of numbered backup files from the
  * given filename.
  *
  * The backup file names will be of the form:
  *     \<name\>.\<number\>\<extension\>
  * for instance
  *     \verbatim chat.3.log \endverbatim
  *
  * The new backup file will be have the backup number 1.
  * Each existing backup file will have its number incremented by 1.
  * Any backup files with numbers greater than the maximum number
  * permitted (@p maxBackups) will be removed.
  * You can use this method even if you don't use KSaveFile.
  *
  * @param filename the file to backup
  * @param backupDir optional directory where to save the backup file in.
  * If empty (the default), the backup will be in the same directory as
  * @p filename.
  * @param backupExtension the extension to append to @p filename,
  * which is "~" by default.  Do not use an extension containing digits.
  * @param maxBackups the maximum number of backup files permitted.
  * For best performance a small number (10) is recommended.
  * @return true if successful, or false if an error has occurred.
  */
 KCOREADDONS_EXPORT bool numberedBackupFile(const QString &filename,
                                            const QString &backupDir = QString(),
                                            const QString &backupExtension = QStringLiteral("~"),
                                            const uint maxBackups = 10);
 }
 
 #endif