Newer
Older
Leandro Melo
committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/
#include "helpitem.h"
#include <coreplugin/helpmanager.h>
#include <utils/htmldocextractor.h>
#include <QtCore/QUrl>
#include <QtCore/QByteArray>
#include <QtCore/QMap>
using namespace TextEditor;
HelpItem::HelpItem()
{}
HelpItem::HelpItem(const QString &helpId, Category category) :
m_helpId(helpId), m_docMark(helpId), m_category(category)
{}
HelpItem::HelpItem(const QString &helpId, const QString &docMark, Category category) :
m_helpId(helpId), m_docMark(docMark), m_category(category)
{}
HelpItem::~HelpItem()
{}
void HelpItem::setHelpId(const QString &id)
{ m_helpId = id; }
const QString &HelpItem::helpId() const
{ return m_helpId; }
void HelpItem::setDocMark(const QString &mark)
{ m_docMark = mark; }
const QString &HelpItem::docMark() const
{ return m_docMark; }
void HelpItem::setCategory(Category cat)
{ m_category = cat; }
HelpItem::Category HelpItem::category() const
{ return m_category; }
bool HelpItem::isValid() const
{
if (!Core::HelpManager::instance()->linksForIdentifier(m_helpId).isEmpty())
return true;
return false;
}
QString HelpItem::extractContent(bool extended) const
{
Utils::HtmlDocExtractor htmlExtractor;
if (extended)
htmlExtractor.setMode(Utils::HtmlDocExtractor::Extended);
Leandro Melo
committed
else
htmlExtractor.setMode(Utils::HtmlDocExtractor::FirstParagraph);
Leandro Melo
committed
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
QString contents;
QMap<QString, QUrl> helpLinks = Core::HelpManager::instance()->linksForIdentifier(m_helpId);
foreach (const QUrl &url, helpLinks) {
const QByteArray &html = Core::HelpManager::instance()->fileData(url);
switch (m_category) {
case Brief:
contents = htmlExtractor.getClassOrNamespaceBrief(html, m_docMark);
break;
case ClassOrNamespace:
contents = htmlExtractor.getClassOrNamespaceDescription(html, m_docMark);
break;
case Function:
contents = htmlExtractor.getFunctionDescription(html, m_docMark);
break;
case Enum:
contents = htmlExtractor.getEnumDescription(html, m_docMark);
break;
case Typedef:
contents = htmlExtractor.getTypedefDescription(html, m_docMark);
break;
case Macro:
contents = htmlExtractor.getMacroDescription(html, m_docMark);
break;
case QML:
contents = htmlExtractor.getQMLItemDescription(html, m_docMark);
break;
default:
break;
}
if (!contents.isEmpty())
break;
}
return contents;
}