helpwidget.h 4.31 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
Eike Ziller's avatar
Eike Ziller committed
13 14
** conditions see http://www.qt.io/licensing.  For further information
** use the contact form at http://www.qt.io/contact-us.
15 16 17
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18 19 20 21 22 23
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#ifndef HELPWIDGET_H
#define HELPWIDGET_H

#include <coreplugin/icontext.h>

#include <qglobal.h>
#include <QWidget>

QT_BEGIN_NAMESPACE
40
class QAction;
41 42
class QComboBox;
class QFont;
43
class QMenu;
44 45
class QPrinter;
class QStackedWidget;
46 47
QT_END_NAMESPACE

48 49 50 51 52
namespace Core {
class MiniSplitter;
class SideBar;
}

53 54 55 56 57 58 59 60 61
namespace Help {
namespace Internal {

class HelpViewer;

class HelpWidget : public QWidget
{
    Q_OBJECT
public:
62
    enum WidgetStyle {
63
        ModeWidget,
64 65 66 67 68 69
        SideBarWidget,
        ExternalWindow
    };

    HelpWidget(const Core::Context &context, WidgetStyle style, QWidget *parent = 0);
    ~HelpWidget();
70 71

    HelpViewer *currentViewer() const;
72 73 74 75 76 77 78 79 80 81 82
    void setCurrentViewer(HelpViewer *viewer);
    int currentIndex() const;
    void addViewer(HelpViewer *viewer, bool highlightSearchTerms = false);
    void removeViewerAt(int index);

    void setViewerFont(const QFont &font);

    // so central widget can save the state
    int viewerCount() const;
    HelpViewer *viewerAt(int index) const;

83
    void open(const QUrl &url, bool newPage = false);
84
    void openFromSearch(const QUrl &url, bool newPage = false);
85 86
    void showTopicChooser(const QMap<QString, QUrl> &links, const QString &key,
                          bool newPage = false);
87
    void activateSideBarItem(const QString &id);
88

89 90 91
public slots:
    void setSource(const QUrl &url);
    void updateCloseButton();
92

93 94 95
protected:
    void closeEvent(QCloseEvent *);

96 97
signals:
    void openHelpMode(const QUrl &url);
98 99
    void closeButtonClicked();
    void aboutToClose();
100 101
    void sourceChanged(const QUrl &url);
    void filterActivated(const QString &name);
102 103 104 105

private slots:
    void updateBackMenu();
    void updateForwardMenu();
106
    void updateWindowTitle();
107
    void helpModeButtonClicked();
108 109

private:
110 111
    void goHome();
    void addBookmark();
112 113 114 115 116 117 118 119
    void copy();
    void forward();
    void backward();
    void scaleUp();
    void scaleDown();
    void resetScale();
    void print(HelpViewer *viewer);
    void highlightSearchTerms();
120
    void addSideBar();
121
    QString sideBarSettingsKey() const;
122

123
    Core::IContext *m_context;
124
    WidgetStyle m_style;
125
    QAction *m_toggleSideBarAction;
126
    QAction *m_switchToHelp;
127
    QAction *m_homeAction;
128 129
    QMenu *m_backMenu;
    QMenu *m_forwardMenu;
130 131
    QAction *m_backAction;
    QAction *m_forwardAction;
132
    QAction *m_addBookmarkAction;
133 134
    QComboBox *m_filterComboBox;
    QAction *m_closeAction;
135 136 137
    QAction *m_scaleUp;
    QAction *m_scaleDown;
    QAction *m_resetScale;
138
    QAction *m_printAction;
139
    QAction *m_copy;
140

141 142
    QStackedWidget *m_viewerStack;
    QPrinter *m_printer;
143 144 145

    Core::MiniSplitter *m_sideBarSplitter;
    Core::SideBar *m_sideBar;
146
    QAction *m_contentsAction;
147
    QAction *m_indexAction;
Eike Ziller's avatar
Eike Ziller committed
148
    QAction *m_bookmarkAction;
149
    QAction *m_searchAction;
150
    QAction *m_openPagesAction;
151 152 153 154 155 156
};

} // Internal
} // Help

#endif // HELPWIDGET_H