1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the Qt Assistant of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    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 **

    34 **

    35 **

    36 **

    37 **

    38 ** $QT_END_LICENSE$

    39 **

    40 ****************************************************************************/

    41 

    42 #ifndef QHELPDATAINTERFACE_H

    43 #define QHELPDATAINTERFACE_H

    44 

    45 //

    46 //  W A R N I N G

    47 //  -------------

    48 //

    49 // This file is not part of the Qt API. It exists for the convenience

    50 // of the help generator tools. This header file may change from version

    51 // to version without notice, or even be removed.

    52 //

    53 // We mean it.

    54 //

    55 

    56 #include "qhelp_global.h"

    57 

    58 #include <QtCore/QStringList>

    59 #include <QtCore/QSharedData>

    60 

    61 QT_BEGIN_HEADER

    62 

    63 QT_BEGIN_NAMESPACE

    64 

    65 class QHELP_EXPORT QHelpDataContentItem

    66 {

    67 public:

    68     QHelpDataContentItem(QHelpDataContentItem *parent, const QString &title,

    69         const QString &reference);

    70     ~QHelpDataContentItem();

    71 

    72     QString title() const;

    73     QString reference() const;

    74     QList<QHelpDataContentItem*> children() const;

    75 

    76 private:

    77     QString m_title;

    78     QString m_reference;

    79     QList<QHelpDataContentItem*> m_children;

    80 };

    81 

    82 struct QHELP_EXPORT QHelpDataIndexItem {

    83     QHelpDataIndexItem() {}

    84     QHelpDataIndexItem(const QString &n, const QString &id, const QString &r)

    85         : name(n), identifier(id), reference(r) {}

    86 

    87     QString name;

    88     QString identifier;

    89     QString reference;

    90     

    91     bool operator==(const QHelpDataIndexItem & other) const;

    92 };

    93 

    94 class QHelpDataFilterSectionData : public QSharedData

    95 {

    96 public:

    97     ~QHelpDataFilterSectionData()

    98     {

    99         qDeleteAll(contents);

   100     }

   101 

   102     QStringList filterAttributes;

   103     QList<QHelpDataIndexItem> indices;

   104     QList<QHelpDataContentItem*> contents;

   105     QStringList files;

   106 };

   107 

   108 class QHELP_EXPORT QHelpDataFilterSection

   109 {

   110 public:

   111     QHelpDataFilterSection();

   112 

   113     void addFilterAttribute(const QString &filter);

   114     QStringList filterAttributes() const;

   115 

   116     void addIndex(const QHelpDataIndexItem &index);

   117     void setIndices(const QList<QHelpDataIndexItem> &indices);

   118     QList<QHelpDataIndexItem> indices() const;

   119 

   120     void addContent(QHelpDataContentItem *content);

   121     void setContents(const QList<QHelpDataContentItem*> &contents);

   122     QList<QHelpDataContentItem*> contents() const;

   123 

   124     void addFile(const QString &file);

   125     void setFiles(const QStringList &files);

   126     QStringList files() const;

   127 

   128 private:

   129     QSharedDataPointer<QHelpDataFilterSectionData> d;

   130 };

   131 

   132 struct QHELP_EXPORT QHelpDataCustomFilter {

   133     QStringList filterAttributes;

   134     QString name;

   135 };

   136 

   137 class QHELP_EXPORT QHelpDataInterface

   138 {

   139 public:

   140     QHelpDataInterface() {}

   141     virtual ~QHelpDataInterface() {}

   142 

   143     virtual QString namespaceName() const = 0;

   144     virtual QString virtualFolder() const = 0;

   145     virtual QList<QHelpDataCustomFilter> customFilters() const = 0;

   146     virtual QList<QHelpDataFilterSection> filterSections() const = 0;

   147     virtual QMap<QString, QVariant> metaData() const = 0;

   148     virtual QString rootPath() const = 0;

   149 };

   150 

   151 QT_END_NAMESPACE

   152 

   153 QT_END_HEADER

   154 

   155 #endif // QHELPDATAINTERFACE_H