Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
openpagesmanager.h
Go to the documentation of this file.
1// Copyright (C) 2016 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
3
4#ifndef OPENPAGESMANAGER_H
5#define OPENPAGESMANAGER_H
6
7#include <QtCore/QObject>
8#include <QtCore/QPointer>
9
11
12class QAbstractItemView;
13class QModelIndex;
14class QUrl;
15
16class HelpViewer;
17class OpenPagesModel;
19class OpenPagesWidget;
20
22{
24public:
26 bool defaultCollection, const QUrl &cmdLineUrl);
27 static OpenPagesManager *instance();
28
29 bool pagesOpenForNamespace(const QString &nameSpace) const;
30 void closePages(const QString &nameSpace);
31 void reloadPages(const QString &nameSpace);
32
33 QAbstractItemView* openPagesWidget() const;
34
35 int pageCount() const;
36 void setCurrentPage(int index);
37
38 void resetHelpPage();
39
40public slots:
41 HelpViewer *createPage(const QUrl &url, bool fromSearch = false);
42 HelpViewer *createNewPageFromSearch(const QUrl &url);
44 void closeCurrentPage();
45
46 void nextPage();
48 void previousPage();
50
51 void closePage(HelpViewer *page);
52 void setCurrentPage(HelpViewer *page);
53
56 void pageAdded(int index);
57
58 void pageClosed();
59 void aboutToClosePage(int index);
60
61private slots:
62 void setCurrentPage(const QModelIndex &index);
63 void closePage(const QModelIndex &index);
64 void closePagesExcept(const QModelIndex &index);
65
66private:
67 OpenPagesManager(QObject *parent, bool defaultCollection,
68 const QUrl &cmdLineUrl);
69 ~OpenPagesManager();
70
71 void setupInitialPages(bool defaultCollection, const QUrl &cmdLineUrl);
72 void closeOrReloadPages(const QString &nameSpace, bool tryReload);
73 void removePage(int index);
74
75 void nextOrPreviousPage(int offset);
76 void showSwitcherOrSelectPage() const;
77
78 OpenPagesModel *m_model;
79 OpenPagesWidget *m_openPagesWidget = nullptr;
80 OpenPagesSwitcher *m_openPagesSwitcher = nullptr;
81
82 QPointer<HelpViewer> m_helpPageViewer;
83
84 static OpenPagesManager *m_instance;
85};
86
87QT_END_NAMESPACE
88
89#endif // OPENPAGESMANAGER_H
QString documentTitle() const
void setText(const QString &text, const QByteArray &resources)
void setPixmap(const QPixmap &pixmap)
QSize minimumSizeHint() const override
QVariant loadResource(int type, const QUrl &name) override
This function is called when the document is loaded and for each image in the document.
void doSetSource(const QUrl &name, QTextDocument::ResourceType type) override
Attempts to load the document at the given url with the specified type.
void setText(const QString &text, const QByteArray &resources)
void subclassKeyPressEvent(QKeyEvent *event)
void focusInEvent(QFocusEvent *event) override
This event handler can be reimplemented in a subclass to receive keyboard focus events (focus receive...
void setBookmarksToolbar(QToolBar *toolBar)
void setSource(const QUrl &url)
void setSourceInNewTab(const QUrl &url)
QWidget * bookmarkDockWidget() const
~BookmarkManager() override
static void destroy()
bool eventFilter(QObject *object, QEvent *event) override
Filters events if this object has been installed as an event filter for the watched object.
void sourceChanged(const QUrl &url)
QString currentTitle() const
void backwardAvailable(bool available)
bool isBackwardAvailable() const
HelpViewer * viewerAt(int index) const
int currentIndex() const
static CentralWidget * instance()
void forwardAvailable(bool available)
bool hasSelection() const
CentralWidget(QWidget *parent=nullptr)
void keyPressEvent(QKeyEvent *) override
This event handler, for event event, can be reimplemented in a subclass to receive key press events f...
void setSourceFromSearch(const QUrl &url)
bool eventFilter(QObject *object, QEvent *e) override
Filters events if this object has been installed as an event filter for the watched object.
QUrl currentSource() const
void highlighted(const QUrl &link)
void setSource(const QUrl &url)
HelpViewer * currentHelpViewer() const
void focusInEvent(QFocusEvent *event) override
This event handler can be reimplemented in a subclass to receive keyboard focus events (focus receive...
void updateUserInterface()
~CentralWidget() override
bool isForwardAvailable() const
ShowState index() const
ShowState contents() const
ShowState bookmarks() const
bool enableRemoteControl() const
bool collectionFileGiven() const
ShowState search() const
bool syncToContent(const QUrl &url)
void focusInEvent(QFocusEvent *e) override
This event handler can be reimplemented in a subclass to receive keyboard focus events (focus receive...
void escapePressed()
void expandToDepth(int depth)
bool eventFilter(QObject *o, QEvent *e) override
Filters events if this object has been installed as an event filter for the watched object.
~ContentWindow() override
QAction * findAction() const
QAction * zoomInAction() const
QAction * nextAction() const
QList< QAction * > actionList() const
QAction * homeAction() const
QAction * backAction() const
QAction * printAction() const
QAction * zoomOutAction() const
QHelpFilterEngine * filterEngine() const
QHelpSearchEngine * searchEngine() const
static HelpEngineWrapper & instance()
bool addressBarEnabled() const
bool addressBarVisible() const
void setUseBrowserFont(bool useBrowserFont)
QHelpIndexModel * indexModel() const
bool filterFunctionalityEnabled() const
bool filterToolbarVisible() const
void setUseAppFont(bool useAppFont)
QHelpContentModel * contentModel() const
void focusInEvent(QFocusEvent *e) override
This event handler can be reimplemented in a subclass to receive keyboard focus events (focus receive...
void documentsActivated(const QList< QHelpLink > &documents, const QString &keyword)
void escapePressed()
void setSearchLineEditText(const QString &text)
bool eventFilter(QObject *obj, QEvent *e) override
Filters events if this object has been installed as an event filter for the watched object.
~IndexWindow() override
QString searchLineEditText() const
Definition indexwindow.h:27
void closeEvent(QCloseEvent *event) override
[21]
void setIndexString(const QString &str)
~MainWindow() override
void syncContents()
void setBookmarksVisible(bool visible)
static void activateCurrentBrowser()
void activateCurrentCentralWidgetTab()
void expandTOC(int depth)
void setIndexVisible(bool visible)
void setSearchVisible(bool visible)
void currentFilterChanged(const QString &filter)
bool usesDefaultCollection() const
QAbstractItemView * openPagesWidget() const
void setCurrentPage(HelpViewer *page)
bool pagesOpenForNamespace(const QString &nameSpace) const
HelpViewer * createNewPageFromSearch(const QUrl &url)
void pageAdded(int index)
void closePage(HelpViewer *page)
void reloadPages(const QString &nameSpace)
HelpViewer * createBlankPage()
static OpenPagesManager * instance()
void setCurrentPage(int index)
void closePages(const QString &nameSpace)
void aboutToClosePage(int index)
void updateApplicationFont()
void updateUserInterface()
\inmodule QtCore
void docsInstalled(bool newDocsInstalled)
void setCurrent(HelpViewer *viewer)
void removeTabAt(HelpViewer *viewer)
QUrl link() const
Combined button and popup list for selecting options.
@ warnAboutMissingModules
static const char * docs[]
static QStringList newQtDocumentation()
#define TRACE_OBJ
Definition tracer.h:34