src/plugins/qmldesigner/designercore/include/import.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 IMPORT_H
  34 #define IMPORT_H
  35
  36 #include <QtCore/QString>
  37 #include <QStringList>
  38
  39 #include "corelib_global.h"
  40
  41 namespace QmlDesigner {
  42
  43 class CORESHARED_EXPORT Import
  44 {
  45 public:
  46     static Import createLibraryImport(const QString &url, const QString &version = QString(), const QString &alias = QString(), const QStringList &importPaths = QStringList());
  47     static Import createFileImport(const QString &file, const QString &version = QString(), const QString &alias = QString(), const QStringList &importPaths = QStringList());
  48     static Import empty();
  49
  50     bool isEmpty() const { return m_url.isEmpty() && m_file.isEmpty(); }
  51     bool isFileImport() const { return m_url.isEmpty() && !m_file.isEmpty(); }
  52     bool isLibraryImport() const { return !m_url.isEmpty() && m_file.isEmpty(); }
  53     bool hasVersion() const { return !m_version.isEmpty(); }
  54     bool hasAlias() const { return !m_alias.isEmpty(); }
  55
  56     QString url() const { return m_url; }
  57     QString file() const { return m_file; }
  58     QString version() const { return m_version; }
  59     QString alias() const { return m_alias; }
  60     QStringList importPaths() const { return m_importPathList; }
  61
  62     QString toString(bool addSemicolon = false) const;
  63
  64     bool operator==(const Import &other) const;
  65
  66 private:
  67     Import(const QString &url, const QString &file, const QString &version, const QString &alias, const QStringList &importPaths);
  68
  69 private:
  70     QString m_url;
  71     QString m_file;
  72     QString m_version;
  73     QString m_alias;
  74     QStringList m_importPathList;
  75 };
  76
  77 CORESHARED_EXPORT uint qHash(const Import &import);
  78
  79 } // namespace QmlDesigner
  80
  81 #endif // IMPORT_H