qfileinfo.h

Go to the documentation of this file.

/****************************************************************************
** 
**
** Definition of QFileInfo class
**
** Created : 950628
**
** Copyright (C) 1992-2000 Trolltech AS.  All rights reserved.
**
** This file is part of the tools module of the Qt GUI Toolkit.
**
** This file may be distributed under the terms of the Q Public License
** as defined by Trolltech AS of Norway and appearing in the file
** LICENSE.QPL included in the packaging of this file.
**
** This file may be distributed and/or modified under the terms of the
** GNU General Public License version 2 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.
**
** Licensees holding valid Qt Enterprise Edition or Qt Professional Edition
** licenses may use this file in accordance with the Qt Commercial License
** Agreement provided with the Software.
**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
** See http://www.trolltech.com/pricing.html or email sales@trolltech.com for
**   information about Qt Commercial License Agreements.
** See http://www.trolltech.com/qpl/ for QPL licensing information.
** See http://www.trolltech.com/gpl/ for GPL licensing information.
**
** Contact info@trolltech.com if any conditions of this licensing are
** not clear to you.
**
**********************************************************************/

#ifndef QFILEINFO_H
#define QFILEINFO_H

#ifndef QT_H
#include "qfile.h"
#include "qdatetime.h"
#endif // QT_H


class QDir;
struct QFileInfoCache;


class Q_EXPORT QFileInfo                                   // file information class
{
public:
    enum PermissionSpec {
        ReadUser  = 0400, WriteUser  = 0200, ExeUser  = 0100,
        ReadGroup = 0040, WriteGroup = 0020, ExeGroup = 0010,
        ReadOther = 0004, WriteOther = 0002, ExeOther = 0001 };

    QFileInfo();
    QFileInfo( const QString &file );
    QFileInfo( const QFile & );
#ifndef QT_NO_DIR
    QFileInfo( const QDir &, const QString &fileName );
#endif
    QFileInfo( const QFileInfo & );
   ~QFileInfo();

    QFileInfo  &operator=( const QFileInfo & );

    void        setFile( const QString &file );
    void        setFile( const QFile & );
#ifndef QT_NO_DIR
    void        setFile( const QDir &, const QString &fileName );
#endif
    bool        exists()        const;
    void        refresh()       const;
    bool        caching()       const;
    void        setCaching( bool );

    QString     filePath()      const;
    QString     fileName()      const;
#ifndef QT_NO_DIR //###
    QString     absFilePath()   const;
#endif
    QString     baseName()      const;
    QString     extension( bool complete = TRUE ) const;

#ifndef QT_NO_DIR //###
    QString     dirPath( bool absPath = FALSE ) const;
#endif
#ifndef QT_NO_DIR
    QDir        dir( bool absPath = FALSE )     const;
#endif
    bool        isReadable()    const;
    bool        isWritable()    const;
    bool        isExecutable()  const;

#ifndef QT_NO_DIR //###
    bool        isRelative()    const;
    bool        convertToAbs();
#endif

    bool        isFile()        const;
    bool        isDir()         const;
    bool        isSymLink()     const;

    QString     readLink()      const;

    QString     owner()         const;
    uint        ownerId()       const;
    QString     group()         const;
    uint        groupId()       const;

    bool        permission( int permissionSpec ) const;

    uint        size()          const;

    QDateTime   lastModified()  const;
    QDateTime   lastRead()      const;

private:
    void        doStat() const;
    static void slashify( QString & );
    static void makeAbs( QString & );
    
    QString     fn;
    QFileInfoCache *fic;
    bool        cache;
};


inline bool QFileInfo::caching() const
{
    return cache;
}


#endif // QFILEINFO_H