src/plugins/qmlprojectmanager/fileformat/qmlprojectitem.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **************************************************************************/
  32
  33 #ifndef QMLPROJECTITEM_H
  34 #define QMLPROJECTITEM_H
  35
  36 #include <QtCore/QObject>
  37 #include <QtCore/QStringList>
  38 #include <QtDeclarative/qdeclarative.h>
  39
  40 namespace QmlProjectManager {
  41
  42 class QmlProjectContentItem : public QObject {
  43     // base class for all elements that should be direct children of Project element
  44     Q_OBJECT
  45
  46 public:
  47     QmlProjectContentItem(QObject *parent = 0) : QObject(parent) {}
  48 };
  49
  50 class QmlProjectItemPrivate;
  51
  52 class QmlProjectItem : public QObject {
  53     Q_OBJECT
  54     Q_DECLARE_PRIVATE(QmlProjectItem)
  55     Q_DISABLE_COPY(QmlProjectItem)
  56
  57     Q_PROPERTY(QDeclarativeListProperty<QmlProjectManager::QmlProjectContentItem> content READ content DESIGNABLE false)
  58     Q_PROPERTY(QString sourceDirectory READ sourceDirectory NOTIFY sourceDirectoryChanged)
  59     Q_PROPERTY(QStringList importPaths READ importPaths WRITE setImportPaths NOTIFY importPathsChanged)
  60     Q_PROPERTY(QString mainFile READ mainFile WRITE setMainFile NOTIFY mainFileChanged)
  61
  62     Q_CLASSINFO("DefaultProperty", "content")
  63
  64 public:
  65     QmlProjectItem(QObject *parent = 0);
  66     ~QmlProjectItem();
  67
  68     QDeclarativeListProperty<QmlProjectContentItem> content();
  69
  70     QString sourceDirectory() const;
  71     void setSourceDirectory(const QString &directoryPath);
  72
  73     QStringList importPaths() const;
  74     void setImportPaths(const QStringList &paths);
  75
  76     QStringList files() const;
  77     bool matchesFile(const QString &filePath) const;
  78
  79     QString mainFile() const;
  80     void setMainFile(const QString &mainFilePath);
  81
  82
  83 signals:
  84     void qmlFilesChanged(const QSet<QString> &, const QSet<QString> &);
  85     void sourceDirectoryChanged();
  86     void importPathsChanged();
  87     void mainFileChanged();
  88
  89 protected:
  90     QmlProjectItemPrivate *d_ptr;
  91 };
  92
  93 } // namespace QmlProjectManager
  94
  95 QML_DECLARE_TYPE(QmlProjectManager::QmlProjectItem)
  96 QML_DECLARE_TYPE(QmlProjectManager::QmlProjectContentItem)
  97 Q_DECLARE_METATYPE(QList<QmlProjectManager::QmlProjectContentItem *>)
  98
  99 #endif // QMLPROJECTITEM_H