ZFileInfo.h

Go to the documentation of this file.

/*
 * Zuble - A run-time system for QML/Javascript applications
 * Copyright (C) 2013, 2014  Bob Dinitto
 *
 * ZFileInfo.h
 *
 *     Project: bitumen
 *     Created: Jan 13, 2012
 *      Author: Bob Dinitto
 *
 * Zuble is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */

#ifndef ZFILEINFO_H_
#define ZFILEINFO_H_

#include "zblcore_global.h"
#include "zglobal.h"
#include "ZblException.h"

#include <QObject>
#include <QFileInfo>
#include <QVariant>

namespace Zbl
{

class ZBLCORESHARED_EXPORT ZFileInfo: public QObject
{
    friend class ZDir;

   Q_OBJECT

public:
    explicit ZFileInfo(QObject *parent = 0);
    virtual ~ZFileInfo();

    void setInfoList(QFileInfoList infoList);

    // properties that affect the whole list

    Q_PROPERTY(int count READ count)
    Q_PROPERTY(int index READ getIndex WRITE setIndex)

    int count();
    int getIndex();
    void setIndex(int index);

    // properties that affect only the currently selected QFileInfo object

    Z_PROPGET_DEF(absoluteFilePath, QString)
    Z_PROPGET_DEF(canonicalFilePath, QString)
    Z_PROPGET_DEF(baseName, QString)
    Z_PROPGET_DEF(completeBaseName, QString)
    Z_PROPGET_DEF(suffix, QString)
    Z_PROPGET_DEF(bundleName, QString)
    Z_PROPGET_DEF(completeSuffix, QString)
    Z_PROPGET_DEF(path, QString)
    Z_PROPGET_DEF(absolutePath, QString)
    Z_PROPGET_DEF(canonicalPath, QString)
    Z_PROPGET_DEF(filePath, QString)
    Z_PROPGET_DEF(fileName, QString)
    Z_PROPGET_DEF(exists, bool)
    Z_PROPGET_DEF(isReadable, bool)
    Z_PROPGET_DEF(isWritable, bool)
    Z_PROPGET_DEF(isExecutable, bool)
    Z_PROPGET_DEF(isNativePath, bool)
    Z_PROPGET_DEF(isRelative, bool)
    Z_PROPGET_DEF(isAbsolute, bool)
    Z_PROPGET_DEF(isFile, bool)
    Z_PROPGET_DEF(isDir, bool)
    Z_PROPGET_DEF(isSymLink, bool)
    Z_PROPGET_DEF(isBundle, bool)
    Z_PROPGET_DEF(isHidden, bool)
    Z_PROPGET_DEF(isRoot, bool)
    Z_PROPGET_DEF(readLink, QString)
    Z_PROPGET_DEF(symLinkTarget, QString)
    Z_PROPGET_DEF(owner, QString)
    Z_PROPGET_DEF(ownerId, uint)
    Z_PROPGET_DEF(group, QString)
    Z_PROPGET_DEF(groupId, uint)

    Q_PROPERTY(bool caching READ getCaching WRITE setCaching)
    Q_PROPERTY(QVariant size READ size)
    Q_PROPERTY(QVariant created READ created)
    Q_PROPERTY(QVariant lastModified READ lastModified)
    Q_PROPERTY(QVariant lastRead READ lastRead)
    Q_PROPERTY(int permissions READ permissions)

    bool getCaching();
    void setCaching(bool on);
    QVariant size() const;
    QVariant created() const;
    QVariant lastModified() const;
    QVariant lastRead() const;
    int permissions() const;


    Q_INVOKABLE int inc(); // tbd: change name to "inc" and add "dec";
    Q_INVOKABLE void setFile(const QString &file);
    Q_INVOKABLE void refresh();
    Q_INVOKABLE bool makeAbsolute();
    Q_INVOKABLE QObject* dir() const;
    Q_INVOKABLE QObject* absoluteDir() const;
    Q_INVOKABLE bool permission(int permissions) const;

protected:

    void checkIndex() const;

    QFileInfoList m_fi;
    int m_i;
};

inline void ZFileInfo::checkIndex() const
{
    if(m_i >= m_fi.count())
        throw ZblException("Index out of range");

}




} // Zbl

#endif /* ZFILEINFO_H_ */