src/plugins/texteditor/helpitem.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 (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  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 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #ifndef TEXTEDITORHELPITEM_H
  35 #define TEXTEDITORHELPITEM_H
  36
  37 #include "texteditor_global.h"
  38
  39 #include <QtCore/QString>
  40
  41 namespace TextEditor {
  42
  43 class TEXTEDITOR_EXPORT HelpItem
  44 {
  45 public:
  46     enum Category {
  47         ClassOrNamespace,
  48         Enum,
  49         Typedef,
  50         Macro,
  51         Brief,
  52         Function,
  53         QmlComponent,
  54         QmlProperty,
  55         Unknown
  56     };
  57
  58     HelpItem();
  59     HelpItem(const QString &helpId, Category category);
  60     HelpItem(const QString &helpId, const QString &docMark, Category category);
  61     ~HelpItem();
  62
  63     void setHelpId(const QString &id);
  64     const QString &helpId() const;
  65
  66     void setDocMark(const QString &mark);
  67     const QString &docMark() const;
  68
  69     void setCategory(Category cat);
  70     Category category() const;
  71
  72     bool isValid() const;
  73
  74     QString extractContent(bool extended) const;
  75
  76 private:
  77     QString m_helpId;
  78     QString m_docMark;
  79     Category m_category;
  80 };
  81
  82 } // namespace TextEditor
  83
  84 #endif // TEXTEDITORHELPITEM_H