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 Class Reference

#include <openpagesmanager.h>

+ Inheritance diagram for OpenPagesManager:
+ Collaboration diagram for OpenPagesManager:

Public Slots

HelpViewercreatePage (const QUrl &url, bool fromSearch=false)
 
HelpViewercreateNewPageFromSearch (const QUrl &url)
 
HelpViewercreateBlankPage ()
 
void closeCurrentPage ()
 
void nextPage ()
 
void nextPageWithSwitcher ()
 
void previousPage ()
 
void previousPageWithSwitcher ()
 
void closePage (HelpViewer *page)
 
void setCurrentPage (HelpViewer *page)
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void aboutToAddPage ()
 
void pageAdded (int index)
 
void pageClosed ()
 
void aboutToClosePage (int index)
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

bool pagesOpenForNamespace (const QString &nameSpace) const
 
void closePages (const QString &nameSpace)
 
void reloadPages (const QString &nameSpace)
 
QAbstractItemViewopenPagesWidget () const
 
int pageCount () const
 
void setCurrentPage (int index)
 
void resetHelpPage ()
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Static Public Member Functions

static OpenPagesManagercreateInstance (QObject *parent, bool defaultCollection, const QUrl &cmdLineUrl)
 
static OpenPagesManagerinstance ()
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 

Additional Inherited Members

- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Definition at line 21 of file openpagesmanager.h.

Member Function Documentation

◆ aboutToAddPage

void OpenPagesManager::aboutToAddPage ( )
signal

◆ aboutToClosePage

void OpenPagesManager::aboutToClosePage ( int index)
signal

◆ closeCurrentPage

void OpenPagesManager::closeCurrentPage ( )
slot

Definition at line 143 of file openpagesmanager.cpp.

References OpenPagesModel::rowCount().

+ Here is the call graph for this function:

◆ closePage

void OpenPagesManager::closePage ( HelpViewer * page)
slot

Definition at line 179 of file openpagesmanager.cpp.

References OpenPagesModel::pageAt(), and OpenPagesModel::rowCount().

+ Here is the call graph for this function:

◆ closePages()

void OpenPagesManager::closePages ( const QString & nameSpace)

Definition at line 197 of file openpagesmanager.cpp.

◆ createBlankPage

HelpViewer * OpenPagesManager::createBlankPage ( )
slot

Definition at line 137 of file openpagesmanager.cpp.

Referenced by HelpPage::createWindow().

+ Here is the caller graph for this function:

◆ createInstance()

OpenPagesManager * OpenPagesManager::createInstance ( QObject * parent,
bool defaultCollection,
const QUrl & cmdLineUrl )
static

Definition at line 24 of file openpagesmanager.cpp.

◆ createNewPageFromSearch

HelpViewer * OpenPagesManager::createNewPageFromSearch ( const QUrl & url)
slot

Definition at line 173 of file openpagesmanager.cpp.

◆ createPage

HelpViewer * OpenPagesManager::createPage ( const QUrl & url,
bool fromSearch = false )
slot

Definition at line 155 of file openpagesmanager.cpp.

References CentralWidget::instance(), OpenPagesModel::pageAt(), OpenPagesModel::rowCount(), and setCurrentPage().

+ Here is the call graph for this function:

◆ instance()

OpenPagesManager * OpenPagesManager::instance ( )
static

Definition at line 33 of file openpagesmanager.cpp.

Referenced by HelpPage::createWindow(), and ContentWindow::eventFilter().

+ Here is the caller graph for this function:

◆ nextPage

void OpenPagesManager::nextPage ( )
slot

Definition at line 296 of file openpagesmanager.cpp.

◆ nextPageWithSwitcher

void OpenPagesManager::nextPageWithSwitcher ( )
slot

Definition at line 302 of file openpagesmanager.cpp.

References OpenPagesSwitcher::gotoNextPage(), and OpenPagesSwitcher::selectCurrentPage().

+ Here is the call graph for this function:

◆ openPagesWidget()

QAbstractItemView * OpenPagesManager::openPagesWidget ( ) const

Definition at line 290 of file openpagesmanager.cpp.

Referenced by MainWindow::MainWindow().

+ Here is the caller graph for this function:

◆ pageAdded

void OpenPagesManager::pageAdded ( int index)
signal

◆ pageClosed

void OpenPagesManager::pageClosed ( )
signal

◆ pageCount()

int OpenPagesManager::pageCount ( ) const

Definition at line 71 of file openpagesmanager.cpp.

References OpenPagesModel::rowCount().

+ Here is the call graph for this function:

◆ pagesOpenForNamespace()

bool OpenPagesManager::pagesOpenForNamespace ( const QString & nameSpace) const

Definition at line 226 of file openpagesmanager.cpp.

References OpenPagesModel::pageAt(), OpenPagesModel::rowCount(), and HelpViewer::source().

+ Here is the call graph for this function:

◆ previousPage

void OpenPagesManager::previousPage ( )
slot

Definition at line 314 of file openpagesmanager.cpp.

◆ previousPageWithSwitcher

void OpenPagesManager::previousPageWithSwitcher ( )
slot

Definition at line 320 of file openpagesmanager.cpp.

References OpenPagesSwitcher::gotoPreviousPage(), and OpenPagesSwitcher::selectCurrentPage().

+ Here is the call graph for this function:

◆ reloadPages()

void OpenPagesManager::reloadPages ( const QString & nameSpace)

Definition at line 203 of file openpagesmanager.cpp.

References OpenPagesWidget::selectCurrentPage().

+ Here is the call graph for this function:

◆ resetHelpPage()

void OpenPagesManager::resetHelpPage ( )

Definition at line 248 of file openpagesmanager.cpp.

◆ setCurrentPage [1/2]

void OpenPagesManager::setCurrentPage ( HelpViewer * page)
slot

Definition at line 254 of file openpagesmanager.cpp.

References CentralWidget::instance(), and OpenPagesWidget::selectCurrentPage().

Referenced by setCurrentPage().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setCurrentPage() [2/2]

void OpenPagesManager::setCurrentPage ( int index)

Definition at line 242 of file openpagesmanager.cpp.

References OpenPagesModel::pageAt(), and setCurrentPage().

Referenced by createPage().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

The documentation for this class was generated from the following files: