QFile Class Reference

QFile Class Reference
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions

#include <qfile.h>

Class Description

+ Examples:

Definition at line 65 of file qfile.h.

+ Inheritance diagram for QFile:

Public Types

enum  FileError {
  NoError = 0, ReadError = 1, WriteError = 2, FatalError = 3,
  ResourceError = 4, OpenError = 5, AbortError = 6, TimeOutError = 7,
  UnspecifiedError = 8, RemoveError = 9, RenameError = 10, PositionError = 11,
  ResizeError = 12, PermissionsError = 13, CopyError = 14
}
 
enum  Permission {
  ReadOwner = 0x4000, WriteOwner = 0x2000, ExeOwner = 0x1000, ReadUser = 0x0400,
  WriteUser = 0x0200, ExeUser = 0x0100, ReadGroup = 0x0040, WriteGroup = 0x0020,
  ExeGroup = 0x0010, ReadOther = 0x0004, WriteOther = 0x0002, ExeOther = 0x0001
}
 
enum  FileHandleFlag { AutoCloseHandle = 0x0001, DontCloseHandle = 0 }
 
enum  MemoryMapFlags { NoOptions = 0 }
 
typedef QByteArray(* EncoderFn) (const QString &fileName)
 
typedef QString(* DecoderFn) (const QByteArray &localfileName)
 
- Public Types inherited from QIODevice
enum  OpenModeFlag {
  NotOpen = 0x0000, ReadOnly = 0x0001, WriteOnly = 0x0002, ReadWrite = ReadOnly | WriteOnly,
  Append = 0x0004, Truncate = 0x0008, Text = 0x0010, Unbuffered = 0x0020
}
 

Public Member Functions

 QFile ()
 
 QFile (const QString &name)
 
 QFile (QObject *parent)
 
 QFile (const QString &name, QObject *parent)
 
 ~QFile ()
 
FileError error () const
 
void unsetError ()
 
QString fileName () const
 
void setFileName (const QString &name)
 
bool exists () const
 
QString readLink () const
 
QString symLinkTarget () const
 
bool remove ()
 
bool rename (const QString &newName)
 
bool link (const QString &newName)
 
bool copy (const QString &newName)
 
bool isSequential () const
 
bool open (OpenMode flags)
 
bool open (FILE *f, OpenMode flags)
 
bool open (int fd, OpenMode flags)
 
bool open (FILE *f, OpenMode ioFlags, FileHandleFlags handleFlags)
 
bool open (int fd, OpenMode ioFlags, FileHandleFlags handleFlags)
 
virtual void close ()
 
qint64 size () const
 
qint64 pos () const
 
bool seek (qint64 offset)
 
bool atEnd () const
 
bool flush ()
 
bool resize (qint64 sz)
 
Permissions permissions () const
 
bool setPermissions (Permissions permissionSpec)
 
int handle () const
 
uchar * map (qint64 offset, qint64 size, MemoryMapFlags flags=NoOptions)
 
bool unmap (uchar *address)
 
virtual QAbstractFileEngine * fileEngine () const
 
- Public Member Functions inherited from QIODevice
 QIODevice ()
 
 QIODevice (QObject *parent)
 
virtual ~QIODevice ()
 
OpenMode openMode () const
 
void setTextModeEnabled (bool enabled)
 
bool isTextModeEnabled () const
 
bool isOpen () const
 
bool isReadable () const
 
bool isWritable () const
 
virtual bool reset ()
 
virtual qint64 bytesAvailable () const
 
virtual qint64 bytesToWrite () const
 
qint64 read (char *data, qint64 maxlen)
 
QByteArray read (qint64 maxlen)
 
QByteArray readAll ()
 
qint64 readLine (char *data, qint64 maxlen)
 
QByteArray readLine (qint64 maxlen=0)
 
virtual bool canReadLine () const
 
qint64 write (const char *data, qint64 len)
 
qint64 write (const char *data)
 
qint64 write (const QByteArray &data)
 
qint64 peek (char *data, qint64 maxlen)
 
QByteArray peek (qint64 maxlen)
 
virtual bool waitForReadyRead (int msecs)
 
virtual bool waitForBytesWritten (int msecs)
 
void ungetChar (char c)
 
bool putChar (char c)
 
bool getChar (char *c)
 
QString errorString () const
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=0)
 
virtual ~QObject ()
 
virtual bool event (QEvent *)
 
virtual bool eventFilter (QObject *, QEvent *)
 
QString objectName () const
 
void setObjectName (const QString &name)
 
bool isWidgetType () const
 
bool signalsBlocked () const
 
bool blockSignals (bool b)
 
QThread * thread () const
 
void moveToThread (QThread *thread)
 
int startTimer (int interval)
 
void killTimer (int id)
 
template<typename T >
T findChild (const QString &aName=QString()) const
 
template<typename T >
QList< T > findChildren (const QString &aName=QString()) const
 
template<typename T >
QList< T > findChildren (const QRegExp &re) const
 
const QObjectList & children () const
 
void setParent (QObject *)
 
void installEventFilter (QObject *)
 
void removeEventFilter (QObject *)
 
bool connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=0, const QObject *receiver=0, const char *member=0)
 
bool disconnect (const QObject *receiver, const char *member=0)
 
void dumpObjectTree ()
 
void dumpObjectInfo ()
 
bool setProperty (const char *name, const QVariant &value)
 
QVariant property (const char *name) const
 
QList< QByteArray > dynamicPropertyNames () const
 
void setUserData (uint id, QObjectUserData *data)
 
QObjectUserData * userData (uint id) const
 
QObject * parent () const
 
bool inherits (const char *classname) const
 

Static Public Member Functions

static QByteArray encodeName (const QString &fileName)
 
static QString decodeName (const QByteArray &localFileName)
 
static QString decodeName (const char *localFileName)
 
static void setEncodingFunction (EncoderFn)
 
static void setDecodingFunction (DecoderFn)
 
static bool exists (const QString &fileName)
 
static QString readLink (const QString &fileName)
 
static QString symLinkTarget (const QString &fileName)
 
static bool remove (const QString &fileName)
 
static bool rename (const QString &oldName, const QString &newName)
 
static bool link (const QString &oldname, const QString &newName)
 
static bool copy (const QString &fileName, const QString &newName)
 
static bool resize (const QString &filename, qint64 sz)
 
static Permissions permissions (const QString &filename)
 
static bool setPermissions (const QString &filename, Permissions permissionSpec)
 
- Static Public Member Functions inherited from QObject
static bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 
static bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static uint registerUserData ()
 

Protected Member Functions

 QFile (QFilePrivate &dd, QObject *parent=0)
 
qint64 readData (char *data, qint64 maxlen)
 
qint64 writeData (const char *data, qint64 len)
 
qint64 readLineData (char *data, qint64 maxlen)
 
- Protected Member Functions inherited from QIODevice
 QIODevice (QIODevicePrivate &dd, QObject *parent=0)
 
void setOpenMode (OpenMode openMode)
 
void setErrorString (const QString &errorString)
 
- Protected Member Functions inherited from QObject
QObject * sender () const
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 
virtual void timerEvent (QTimerEvent *)
 
virtual void childEvent (QChildEvent *)
 
virtual void customEvent (QEvent *)
 
virtual void connectNotify (const char *signal)
 
virtual void disconnectNotify (const char *signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=0)
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 
- Signals inherited from QIODevice
void readyRead ()
 
void bytesWritten (qint64 bytes)
 
void aboutToClose ()
 
void readChannelFinished ()
 
- Signals inherited from QObject
void destroyed (QObject *=0)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- Static Protected Attributes inherited from QObject
static const QMetaObject staticQtMetaObject
 
- Properties inherited from QObject
QString objectName
 

Member Typedef Documentation

typedef QByteArray(* EncoderFn) (const QString &fileName)

Definition at line 123 of file qfile.h.

typedef QString(* DecoderFn) (const QByteArray &localfileName)

Definition at line 124 of file qfile.h.

Member Enumeration Documentation

enum FileError
Enumerator
NoError 
ReadError 
WriteError 
FatalError 
ResourceError 
OpenError 
AbortError 
TimeOutError 
UnspecifiedError 
RemoveError 
RenameError 
PositionError 
ResizeError 
PermissionsError 
CopyError 

Definition at line 74 of file qfile.h.

74  {
75  NoError = 0,
76  ReadError = 1,
77  WriteError = 2,
78  FatalError = 3,
79  ResourceError = 4,
80  OpenError = 5,
81  AbortError = 6,
82  TimeOutError = 7,
83  UnspecifiedError = 8,
84  RemoveError = 9,
85  RenameError = 10,
86  PositionError = 11,
87  ResizeError = 12,
88  PermissionsError = 13,
89  CopyError = 14
90 #ifdef QT3_SUPPORT
91  , ConnectError = 30
92 #endif
93  };
enum Permission
Enumerator
ReadOwner 
WriteOwner 
ExeOwner 
ReadUser 
WriteUser 
ExeUser 
ReadGroup 
WriteGroup 
ExeGroup 
ReadOther 
WriteOther 
ExeOther 

Definition at line 95 of file qfile.h.

95  {
96  ReadOwner = 0x4000, WriteOwner = 0x2000, ExeOwner = 0x1000,
97  ReadUser = 0x0400, WriteUser = 0x0200, ExeUser = 0x0100,
98  ReadGroup = 0x0040, WriteGroup = 0x0020, ExeGroup = 0x0010,
99  ReadOther = 0x0004, WriteOther = 0x0002, ExeOther = 0x0001
100  };
enum FileHandleFlag
Enumerator
AutoCloseHandle 
DontCloseHandle 

Definition at line 103 of file qfile.h.

103  {
104  AutoCloseHandle = 0x0001,
105  DontCloseHandle = 0
106  };
enum MemoryMapFlags
Enumerator
NoOptions 

Definition at line 180 of file qfile.h.

180  {
181  NoOptions = 0
182  };

Constructor & Destructor Documentation

QFile ( )
QFile ( const QString &  name)
QFile ( QObject *  parent)
explicit
QFile ( const QString &  name,
QObject *  parent 
)
~QFile ( )
QFile ( QFilePrivate &  dd,
QObject *  parent = 0 
)
protected

Member Function Documentation

FileError error ( ) const
void unsetError ( )
QString fileName ( ) const
void setFileName ( const QString &  name)
static QByteArray encodeName ( const QString &  fileName)
static
+ Examples:
static QString decodeName ( const QByteArray &  localFileName)
static
static QString decodeName ( const char *  localFileName)
inlinestatic

Definition at line 127 of file qfile.h.

128  { return decodeName(QByteArray(localFileName)); }
QFile::decodeName
static QString decodeName(const QByteArray &localFileName)
static void setEncodingFunction ( EncoderFn  )
static
static void setDecodingFunction ( DecoderFn  )
static
bool exists ( ) const
static bool exists ( const QString &  fileName)
static
QString readLink ( ) const
static QString readLink ( const QString &  fileName)
static
QString symLinkTarget ( ) const
inline

Definition at line 137 of file qfile.h.

137 { return readLink(); }
QFile::readLink
QString readLink() const
static QString symLinkTarget ( const QString &  fileName)
inlinestatic

Definition at line 138 of file qfile.h.

138 { return readLink(fileName); }
QFile::readLink
QString readLink() const
bool remove ( )
static bool remove ( const QString &  fileName)
static
bool rename ( const QString &  newName)
static bool rename ( const QString &  oldName,
const QString &  newName 
)
static
bool link ( const QString &  newName)
static bool link ( const QString &  oldname,
const QString &  newName 
)
static
bool copy ( const QString &  newName)
static bool copy ( const QString &  fileName,
const QString &  newName 
)
static
bool isSequential ( ) const
virtual

Reimplemented from QIODevice.

bool open ( OpenMode  flags)
virtual

Reimplemented from QIODevice.

Reimplemented in QTemporaryFile.

+ Examples:
bool open ( FILE *  f,
OpenMode  flags 
)
bool open ( int  fd,
OpenMode  flags 
)
bool open ( FILE *  f,
OpenMode  ioFlags,
FileHandleFlags  handleFlags 
)
bool open ( int  fd,
OpenMode  ioFlags,
FileHandleFlags  handleFlags 
)
virtual void close ( )
virtual

Reimplemented from QIODevice.

+ Examples:
qint64 size ( ) const
virtual

Reimplemented from QIODevice.

+ Examples:
qint64 pos ( ) const
virtual

Reimplemented from QIODevice.

bool seek ( qint64  offset)
virtual

Reimplemented from QIODevice.

bool atEnd ( ) const
virtual

Reimplemented from QIODevice.

bool flush ( )
bool resize ( qint64  sz)
static bool resize ( const QString &  filename,
qint64  sz 
)
static
Permissions permissions ( ) const
static Permissions permissions ( const QString &  filename)
static
bool setPermissions ( Permissions  permissionSpec)
static bool setPermissions ( const QString &  filename,
Permissions  permissionSpec 
)
static
int handle ( ) const
uchar* map ( qint64  offset,
qint64  size,
MemoryMapFlags  flags = NoOptions 
)
bool unmap ( uchar *  address)
virtual QAbstractFileEngine* fileEngine ( ) const
virtual

Reimplemented in QTemporaryFile.

qint64 readData ( char *  data,
qint64  maxlen 
)
protectedvirtual

Implements QIODevice.

qint64 writeData ( const char *  data,
qint64  len 
)
protectedvirtual

Implements QIODevice.

qint64 readLineData ( char *  data,
qint64  maxlen 
)
protectedvirtual

Reimplemented from QIODevice.

The documentation for this class was generated from the following file:
Please send us your comment about this page