<HTML>
<HEAD>
<TITLE>Source: ksavefile.h</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>Source: ksavefile.h</h1>
</TD>
<TD valign="top" align="right" colspan="1"></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<pre>
/*
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., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
#ifndef _KSAVEFILE_H_
#define _KSAVEFILE_H_
#include <qstring.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 occured, no changes have been written whatsoever and the
* old file is still in place.
*/
class KSaveFile
{
public:
KSaveFile(const QString &filename, int mode = 0666 );
/**
* The destructor closes the file.
**/
~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.
**/
int status()
{ return mTempFile.status(); }
/**
* The name of the file as passed to the constructor.
**/
QString name();
/**
* An integer file descriptor open for writing to the file
**/
int handle()
{ return mTempFile.handle(); }
/**
* A FILE* stream open for writing to the file
**/
FILE *fstream()
{ return mTempFile.fstream(); }
/**
* A QFile* open for writing to the file
**/
QFile *file()
{ return mTempFile.file(); }
/**
* A QTextStream* open for writing to the file
**/
QTextStream *textStream()
{ return mTempFile.textStream(); }
/**
* A QDataStream* open for writing to the file
**/
QDataStream *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 successfull, or 'false' if an error has occured.
* See status() for details about errors.
**/
bool close();
private:
QString mFileName;
KTempFile mTempFile;
KSaveFilePrivate *d;
};
#endif
</pre>
<HR>
<table>
<tr><td><small>Generated by: qateam on updates.mandrakesoft.com on Mon Dec 30 16:08:56 2002, using kdoc 2.0a53.</small></td></tr>
</table>
</BODY>
</HTML>
