QDir.h

Go to the documentation of this file.

/********************************************************************************
*                                                                               *
*                        Information about a directory                          *
*                                                                               *
*********************************************************************************
*        Copyright (C) 2003 by Niall Douglas.   All Rights Reserved.            *
*       NOTE THAT I DO NOT PERMIT ANY OF MY CODE TO BE PROMOTED TO THE GPL      *
*********************************************************************************
* This code is free software; you can redistribute it and/or modify it under    *
* the terms of the GNU Library General Public License v2.1 as published by the  *
* Free Software Foundation EXCEPT that clause 3 does not apply ie; you may not  *
* "upgrade" this code to the GPL without my prior written permission.           *
* Please consult the file "License_Addendum2.txt" accompanying this file.       *
*                                                                               *
* This code 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.                          *
*********************************************************************************
* $Id:                                                                          *
********************************************************************************/

#ifndef QDIR_H
#define QDIR_H

#include "FXString.h"
#include "qstringlist.h"
#undef mkdir

namespace FX {

class QFileInfo;
typedef QValueList<QFileInfo> QFileInfoList;

struct FXDirPrivate;
class FXAPIR QDir
{
    FXDirPrivate *p;
public:
    enum FilterSpec {
        Dirs      =0x001,   
        Files     =0x002,   
        //Drives    =0x004, //!< Include drives
        NoSymLinks=0x008,   
        All       =0x007,   
        TypeMask  =0x00f,

        Readable  =0x010,   
        Writeable =0x020,   
        Writable  =0x020,
        Executable=0x040,   
        RWEMask   =0x070,

        //Modified  =0x080,
        Hidden    =0x100,   
        //System    =0x200,
        AccessMask=0x3f0,

        DefaultFilter=0xffffffff
    };
    enum SortSpec
    {
        Name      =0x00,    
        Time      =0x01,    
        Size      =0x02,    
        Unsorted  =0x03,    
        SortByMask=0x03,

        DirsFirst =0x04,    
        Reversed  =0x08,    
        IgnoreCase=0x10,    

        DefaultSort=0xffffffff
    };
    QDir();
    QDir(const FXString &path, const FXString &regex=FXString::nullStr(), int sortBy=Name|IgnoreCase, int filter=All);
    QDir(const QDir &o);
    QDir &operator=(const QDir &o);
    QDir &operator=(const FXString &path);
    ~QDir();
    bool operator==(const QDir &o) const;
    bool operator!=(const QDir &o) const;

    void setPath(const FXString &path);
    const FXString &path() const;
    FXString absPath() const;
    FXString canonicalPath() const;
    FXString dirName() const;
    FXString filePath(const FXString &file, bool acceptAbs=true) const;
    FXString absFilePath(const FXString &file, bool acceptAbs=true) const;
    static FXString convertSeparators(const FXString &path);
    bool cd(const FXString &name, bool acceptAbs=true);
    bool cdUp();

    const FXString &nameFilter() const;
    void setNameFilter(const FXString &regex);
    FilterSpec filter() const;
    void setFilter(int filter);
    SortSpec sorting() const;
    void setSorting(int sorting);
    bool matchAllDirs() const;
    void setMatchAllDirs(bool matchAll);

    FXuint count() const;
    const FXString &operator[](int idx) const;
    QStringList entryList(const FXString &regex, int filter=DefaultFilter, int sorting=DefaultSort);
    QStringList entryList(int filter=DefaultFilter, int sorting=DefaultSort) { return entryList(FXString::nullStr(), filter, sorting); }
    const QFileInfoList *entryInfoList(const FXString &regex, int filter=DefaultFilter, int sorting=DefaultSort);
    const QFileInfoList *entryInfoList(int filter=DefaultFilter, int sorting=DefaultSort) { return entryInfoList(FXString::nullStr(), filter, sorting); }
    static QStringList drives();
    void refresh();

    bool mkdir(const FXString &leaf, bool acceptAbs=true);
    bool rmdir(const FXString &leaf, bool acceptAbs=true);
    bool remove(const FXString &leaf, bool acceptAbs=true);
    bool rename(const FXString &src, const FXString &dest, bool acceptAbs=true);
    bool exists(const FXString &leaf, bool acceptAbs=true);

    bool isReadable() const;
    bool exists() const;
    bool isRoot() const;
    bool isRelative() const;
    void convertToAbs();

    static FXString separator();
    static QDir current();
    static QDir home();
    static QDir root();
    static FXString currentDirPath();
    static FXString homeDirPath();
    static FXString rootDirPath();
    static bool match(const FXString &filter, const FXString &filename);
    static FXString cleanDirPath(const FXString &path);
    static bool isRelativePath(const FXString &path);
    static QStringList extractChanges(const QDir &A, const QDir &B);
};

} // namespace

#endif

---

(C) 2002-2009 Niall Douglas. Some parts (C) to assorted authors.