1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the Assistant module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #ifndef OPENPAGESMANAGER_H
43 #define OPENPAGESMANAGER_H
44 
45 #include <QtCore/QObject>
46 
47 QT_BEGIN_NAMESPACE
48 
49 class QAbstractItemView;
50 class QModelIndex;
51 class QUrl;
52 
53 class HelpViewer;
54 class OpenPagesModel;
55 class OpenPagesSwitcher;
56 class OpenPagesWidget;
57 
58 class OpenPagesManager : public QObject
59 {
60     Q_OBJECT
61 public:
62     static OpenPagesManager *createInstance(QObject *parent,
63         bool defaultCollection, const QUrl &cmdLineUrl);
64     static OpenPagesManager *instance();
65 
66     bool pagesOpenForNamespace(const QString &nameSpace) const;
67     void closePages(const QString &nameSpace);
68     void reloadPages(const QString &nameSpace);
69 
70     QAbstractItemView* openPagesWidget() const;
71 
72     int pageCount() const;
73     void setCurrentPage(int index);
74 
75 public slots:
76     HelpViewer *createPage(const QUrl &url, bool fromSearch = false);
77     HelpViewer *createNewPageFromSearch(const QUrl &url);
78     HelpViewer *createPage();
79     void closeCurrentPage();
80 
81     void nextPage();
82     void nextPageWithSwitcher();
83     void previousPage();
84     void previousPageWithSwitcher();
85 
86     void closePage(HelpViewer *page);
87     void setCurrentPage(HelpViewer *page);
88 
89 private slots:
90     void setCurrentPage(const QModelIndex &index);
91     void closePage(const QModelIndex &index);
92     void closePagesExcept(const QModelIndex &index);
93 
94 private:
95     OpenPagesManager(QObject *parent, bool defaultCollection,
96         const QUrl &cmdLineUrl);
97     ~OpenPagesManager();
98 
99     void setupInitialPages(bool defaultCollection, const QUrl &cmdLineUrl);
100     void closeOrReloadPages(const QString &nameSpace, bool tryReload);
101     void removePage(int index);
102 
103     void nextOrPreviousPage(int offset);
104     void showSwitcherOrSelectPage() const;
105 
106     OpenPagesModel *m_model;
107     OpenPagesWidget *m_openPagesWidget;
108     OpenPagesSwitcher *m_openPagesSwitcher;
109 
110     static OpenPagesManager *m_instance;
111 };
112 
113 QT_END_NAMESPACE
114 
115 #endif // OPENPAGESMANAGER_H
116