Chameleon

Chameleon Svn Source Tree

Root/branches/xZenu/src/util/doxygen/qtools/qfile.h

Source at commit 1322 created 9 years 5 months ago.
By meklort, Add doxygen to utils folder
1/****************************************************************************
2**
3**
4** Definition of QFile class
5**
6** Created : 930831
7**
8** Copyright (C) 1992-2000 Trolltech AS. All rights reserved.
9**
10** This file is part of the tools module of the Qt GUI Toolkit.
11**
12** This file may be distributed under the terms of the Q Public License
13** as defined by Trolltech AS of Norway and appearing in the file
14** LICENSE.QPL included in the packaging of this file.
15**
16** This file may be distributed and/or modified under the terms of the
17** GNU General Public License version 2 as published by the Free Software
18** Foundation and appearing in the file LICENSE.GPL included in the
19** packaging of this file.
20**
21** Licensees holding valid Qt Enterprise Edition or Qt Professional Edition
22** licenses may use this file in accordance with the Qt Commercial License
23** Agreement provided with the Software.
24**
25** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
26** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
27**
28** See http://www.trolltech.com/pricing.html or email sales@trolltech.com for
29** information about Qt Commercial License Agreements.
30** See http://www.trolltech.com/qpl/ for QPL licensing information.
31** See http://www.trolltech.com/gpl/ for GPL licensing information.
32**
33** Contact info@trolltech.com if any conditions of this licensing are
34** not clear to you.
35**
36**********************************************************************/
37
38#ifndef QFILE_H
39#define QFILE_H
40
41#ifndef QT_H
42#include "qiodevice.h"
43#include "qstring.h"
44#include <stdio.h>
45#endif // QT_H
46
47class QDir;
48
49
50class Q_EXPORT QFile : public QIODevice// file I/O device class
51{
52public:
53 QFile();
54 QFile( const QString &name );
55 virtual ~QFile();
56
57 QStringname()const;
58 voidsetName( const QString &name );
59
60 typedef QCString (*EncoderFn)( const QString &fileName );
61 typedef QString (*DecoderFn)( const QCString &localfileName );
62 static QCString encodeName( const QString &fileName );
63 static QString decodeName( const QCString &localFileName );
64 static void setEncodingFunction( EncoderFn );
65 static void setDecodingFunction( DecoderFn );
66
67 boolexists() const;
68 static bool exists( const QString &fileName );
69
70 boolremove();
71 static bool remove( const QString &fileName );
72
73 boolopen( int );
74 boolopen( int, FILE * );
75 boolopen( int, int );
76 voidclose();
77 voidflush();
78
79 uintsize()const;
80 intat()const;
81 boolat( int );
82 boolatEnd() const;
83
84 intreadBlock( char *data, uint len );
85 intwriteBlock( const char *data, uint len );
86 intwriteBlock( const QByteArray& data )
87 { return QIODevice::writeBlock(data); }
88 intreadLine( char *data, uint maxlen );
89 intreadLine( QString &, uint maxlen );
90
91 intgetch();
92 intputch( int );
93 intungetch( int );
94
95 inthandle() const;
96
97 int64 pos() const;
98 int64 toEnd();
99 bool seek(int64 pos);
100
101protected:
102 QStringfn;
103 FILE *fh;
104 intfd;
105 intlength;
106 boolext_f;
107 void * d;
108
109private:
110 voidinit();
111 QCString ungetchBuffer;
112
113private:// Disabled copy constructor and operator=
114#if defined(Q_DISABLE_COPY)
115 QFile( const QFile & );
116 QFile &operator=( const QFile & );
117#endif
118};
119
120
121inline QString QFile::name() const
122{ return fn; }
123
124inline int QFile::at() const
125{ return ioIndex; }
126
127
128#endif // QFILE_H
129

Archive Download this file

Revision: 1322