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 PROFILE_H

    43 #define PROFILE_H

    44 

    45 #include <QFileInfo>

    46 #include <QString>

    47 #include <QStringList>

    48 #include <QMap>

    49 

    50 QT_BEGIN_NAMESPACE

    51 

    52 class DocuParser;

    53 

    54 class Profile

    55 {

    56 public:

    57     enum ProfileType { DefaultProfile, UserProfile };

    58     Profile();

    59 

    60     bool isValid() const;

    61 

    62     void addDCF( const QString &docfile );

    63     void addDCFIcon( const QString title, const QString &icon );

    64     void addDCFIndexPage( const QString title, const QString &indexPage );

    65     void addDCFImageDir( const QString title, const QString &imgDir );

    66     void addDCFTitle( const QString &dcf, const QString &title );

    67     void addProperty( const QString &name, const QString &value );

    68     bool hasDocFile( const QString &docFile );

    69     void removeDocFileEntry( const QString &title );

    70 

    71     ProfileType profileType() const { return type; }

    72     void setProfileType( ProfileType t ) { type = t; }

    73 

    74     DocuParser *docuParser() const { return dparser; }

    75     void setDocuParser( DocuParser *dp ) { dparser = dp; }

    76 

    77     static Profile* createDefaultProfile(const QString &docPath = QString());

    78     static QString makeRelativePath(const QString &base, const QString &path);

    79     static QString storableFilePath(const QString &fileName);

    80     static QString loadableFilePath(const QString &fileName);

    81 

    82     uint valid:1;

    83     ProfileType type;

    84     DocuParser *dparser;

    85     QMap<QString,QString> props;

    86     QMap<QString,QString> icons;

    87     QMap<QString,QString> indexPages;

    88     QMap<QString,QString> imageDirs;

    89     QMap<QString,QString> dcfTitles;

    90     QStringList docs;

    91 };

    92 

    93 QT_END_NAMESPACE

    94 

    95 #endif // PROFILE_H