diff options
Diffstat (limited to 'kdecore/ksavefile.h')
-rw-r--r-- | kdecore/ksavefile.h | 152 |
1 files changed, 0 insertions, 152 deletions
diff --git a/kdecore/ksavefile.h b/kdecore/ksavefile.h deleted file mode 100644 index 448c9ca1a..000000000 --- a/kdecore/ksavefile.h +++ /dev/null @@ -1,152 +0,0 @@ -/* - This file is part of the KDE libraries - Copyright (c) 1999 Waldo Bastian <bastian@kde.org> - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Library General Public - License version 2 as published by the Free Software Foundation. - - 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 _KSAVEFILE_H_ -#define _KSAVEFILE_H_ - -#include <tqstring.h> -#include <stdio.h> -#include <errno.h> -#include <ktempfile.h> - -class KSaveFilePrivate; - -/** - * The KSaveFile class has been made to write out changes to an existing - * file atomically. - * This means that EITHER: - * a) - * All changes have been written successfully to the file. - * - * b) - * Some error occurred, no changes have been written whatsoever and the - * old file is still in place. - */ -class KDECORE_EXPORT KSaveFile -{ -public: - /** - * Creates a new KSaveFile with the given file name. - * @param filename the path of the file - * @param mode the mode of the file (see chmod(1)) - */ - KSaveFile(const TQString &filename, int mode = 0666 ); - - /** - * The destructor closes the file. - * You might want to call close() explicitely though, to test whether it worked. - **/ - ~KSaveFile(); - - /** - * Returns the status of the file based on errno. (see errno.h) - * 0 means OK. - * - * You should check the status after object creation to check - * whether a file could be created in the first place. - * - * You may check the status after closing the file to verify that - * the file has indeed been written correctly. - * @return the errno status, 0 means ok - **/ - int status() const - { return mTempFile.status(); } - - /** - * The name of the file as passed to the constructor. - * @return The name of the file, or TQString::null if opening the - * file has failed - **/ - TQString name() const; - - /** - * An integer file descriptor open for writing to the file. - * @return The file descriptor, or a negative number if opening - * the temporary file failed - **/ - int handle() const - { return mTempFile.handle(); } - - /** - * A FILE* stream open for writing to the file. - * @return FILE* stream open for writing to the file, or 0 - * if opening the temporary file failed - **/ - FILE *fstream() - { return mTempFile.fstream(); } - - /** - * A TQFile* open for writing to the file. - * @return A TQFile open for writing to the file, or 0 if - * opening the temporary file failed. - **/ - TQFile *file() - { return mTempFile.file(); } - - /** - * A TQTextStream* open for writing to the file. - * @return A TQTextStream that is open for writing to the file, or 0 - * if opening the temporary file failed - **/ - TQTextStream *textStream() - { return mTempFile.textStream(); } - - /** - * A TQDataStream* open for writing to the file. - * @return A TQDataStream that is open for writing to the file, or 0 - * if opening the file failed - **/ - TQDataStream *dataStream() - { return mTempFile.dataStream(); } - - /** - * Aborts the write operation and removes any intermediate files - * This implies a close. - **/ - void abort(); - - /** - * Closes the file and makes the changes definitive. - * Returns 'true' is successful, or 'false' if an error has occurred. - * See status() for details about errors. - * @return true if successful, or false if an error has occurred. - **/ - bool close(); - - /** - * Static method to create a backup file before saving. - * 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. - * @since 3.2 - */ - static bool backupFile( const TQString& filename, - const TQString& backupDir = TQString::null, - const TQString& backupExtension = TQString::tqfromLatin1( "~" ) ); - -private: - TQString mFileName; - KTempFile mTempFile; - - KSaveFilePrivate *d; -}; - -#endif |