blob: c0425012cc3138480db9e4b3e8b17358850c7acc (
plain)
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
84
85
86
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
/**************************************************************************
**
** 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.
**
**************************************************************************/
#ifndef HELPPLUGIN_H
#define HELPPLUGIN_H
#include <extensionsystem/iplugin.h>
#include <QtCore/QMap>
#include <QtCore/QStringList>
QT_BEGIN_NAMESPACE
class QAction;
class QComboBox;
class QToolBar;
class QUrl;
QT_END_NAMESPACE
class HelpViewer;
namespace Core {
class ICore;
class IMode;
class MiniSplitter;
class SideBar;
class SideBarItem;
} // Core
namespace Help {
class HelpManager;
namespace Internal {
class CentralWidget;
class DocSettingsPage;
class FilterSettingsPage;
class HelpMode;
class GeneralSettingsPage;
class SearchWidget;
class HelpPlugin : public ExtensionSystem::IPlugin
{
Q_OBJECT
public:
HelpPlugin();
virtual ~HelpPlugin();
bool initialize(const QStringList &arguments, QString *error_message);
void extensionsInitialized();
void shutdown();
public slots:
void handleHelpRequest(const QString &url);
private slots:
void modeChanged(Core::IMode *mode);
void activateContext();
void activateIndex();
void activateContents();
void activateSearch();
void updateFilterComboBox();
void filterDocumentation(const QString &customFilter);
void addBookmark();
void addNewBookmark(const QString &title, const QString &url);
void switchToHelpMode();
void switchToHelpMode(const QUrl &source);
void switchToHelpMode(const QMap<QString, QUrl> &urls, const QString &keyword);
void slotHideRightPane();
void updateSideBarSource();
void updateSideBarSource(const QUrl &newUrl);
void fontChanged();
void setupHelpEngineIfNeeded();
void rebuildViewerComboBox();
void removeViewerFromComboBox(int index);
void updateViewerComboBoxIndex(int index);
private:
void setupUi();
void resetFilter();
void activateHelpMode();
QToolBar *createToolBar();
void connectCentralWidget();
HelpViewer* viewerForContextMode();
void createRightPaneContextViewer();
private:
HelpMode *m_mode;
Core::ICore *m_core;
QWidget *m_mainWidget;
CentralWidget *m_centralWidget;
HelpViewer *m_helpViewerForSideBar;
Core::SideBarItem *m_contentItem;
Core::SideBarItem *m_indexItem;
Core::SideBarItem *m_searchItem;
Core::SideBarItem *m_bookmarkItem;
DocSettingsPage *m_docSettingsPage;
FilterSettingsPage *m_filterSettingsPage;
GeneralSettingsPage *m_generalSettingsPage;
QComboBox *m_documentsCombo;
QComboBox *m_filterComboBox;
Core::SideBar *m_sideBar;
bool m_firstModeChange;
HelpManager *m_helpManager;
Core::MiniSplitter *m_splitter;
};
} // namespace Internal
} // namespace Help
#endif // HELPPLUGIN_H
|
