Newer
Older
/***************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
**
** Non-Open Source Usage
**
** Licensees may use this file in accordance with the Qt Beta Version
** License Agreement, Agreement version 2.2 provided with the Software or,
** alternatively, in accordance with the terms contained in a written
** agreement between you and Nokia.
**
** GNU General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU General
** Public License versions 2.0 or 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the packaging
** of this file. Please review the following information to ensure GNU
** General Public Licensing requirements will be met:
**
** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
** http://www.gnu.org/copyleft/gpl.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt GPL Exception
** version 1.3, included in the file GPL_EXCEPTION.txt in this package.
**
***************************************************************************/
#ifndef HELPPLUGIN_H
#define HELPPLUGIN_H
#include "help_global.h"
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
#include <extensionsystem/iplugin.h>
#include <QtCore/QMap>
QT_BEGIN_NAMESPACE
class QAction;
class QComboBox;
class QHelpEngineCore;
class QHelpEngine;
class QShortcut;
class QToolBar;
class QUrl;
class IndexWindow;
class ContentWindow;
class BookmarkManager;
class BookmarkWidget;
class CentralWidget;
class HelpViewer;
QT_END_NAMESPACE
namespace Core {
class ICore;
class IMode;
class SideBar;
class SideBarItem;
}
namespace Help {
namespace Constants {
const char * const HELPVIEWER_KIND = "Qt Help Viewer";
const char * const C_MODE_HELP = "Help Mode";
const int P_MODE_HELP = 70;
const char * const ID_MODE_HELP = "Help.HelpMode";
}
class HELP_EXPORT HelpManager : public QObject
{
Q_OBJECT
public:
HelpManager(QHelpEngine *helpEngine);
void registerDocumentation(const QStringList &fileNames);
private:
QHelpEngine *m_helpEngine;
};
namespace Internal {
class HelpMode;
class HelpPluginEditorFactory;
class DocSettingsPage;
class FilterSettingsPage;
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();
// Necessary to get the unfiltered list in the help index filter
void setIndexFilter(const QString &filter);
QString indexFilter() const;
private slots:
void modeChanged(Core::IMode *mode);
void activateContext();
void activateIndex();
void activateContents();
void activateSearch();
void checkForHelpChanges();
void updateFilterComboBox();
void filterDocumentation(const QString &customFilter);
void addBookmark();
void addNewBookmark(const QString &title, const QString &url);
void rightPaneBackward();
void rightPaneForward();
void switchToHelpMode();
void switchToHelpMode(const QUrl &source);
void switchToHelpMode(const QMap<QString, QUrl> &urls, const QString &keyword);
void slotHideRightPane();
void openGettingStarted();
private:
QToolBar *createToolBar();
void createRightPaneSideBar();
Core::ICore *m_core;
QHelpEngine *m_helpEngine;
QHelpEngineCore *m_contextHelpEngine;
ContentWindow *m_contentWidget;
IndexWindow *m_indexWidget;
BookmarkWidget *m_bookmarkWidget;
BookmarkManager *m_bookmarkManager;
SearchWidget *m_searchWidget;
CentralWidget *m_centralWidget;
HelpViewer *m_helpViewerForSideBar;
HelpMode *m_mode;
bool m_shownLastPages;
Core::SideBarItem *m_contentItem;
Core::SideBarItem *m_indexItem;
Core::SideBarItem *m_searchItem;
Core::SideBarItem *m_bookmarkItem;
DocSettingsPage *m_docSettingsPage;
FilterSettingsPage *m_filterSettingsPage;
QComboBox *m_filterComboBox;
Core::SideBar *m_sideBar;
QWidget *m_rightPaneSideBar;
QAction *m_rightPaneBackwardAction;
QAction *m_rightPaneForwardAction;
};
} // namespace Internal
} // namespace Help
#endif // HELPPLUGIN_H