 |
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
|
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
The QHelpFilterEngine class provides a filtered view of the help contents. More...
#include <qhelpfilterengine.h>
Inheritance diagram for QHelpFilterEngine: Collaboration diagram for QHelpFilterEngine:Signals | |
| void | filterActivated (const QString &newFilter) |
| This signal is emitted when the active filter is set. | |
| 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 | |
| QMap< QString, QString > | namespaceToComponent () const |
| Returns the map of all the available namespaces as keys together with their associated components as values. | |
| QMap< QString, QVersionNumber > | namespaceToVersion () const |
| Returns the map of all the available namespaces as keys together with their associated versions as values. | |
| QStringList | filters () const |
| Returns the list of all filter names defined inside the filter engine. | |
| QString | activeFilter () const |
| Returns the name of the currently active filter. | |
| bool | setActiveFilter (const QString &filterName) |
| Changes the currently active filter to filterName. | |
| QStringList | availableComponents () const |
| Returns the list of all available components defined in all registered documentation files. | |
| QList< QVersionNumber > | availableVersions () const |
| QHelpFilterData | filterData (const QString &filterName) const |
| Returns the filter details associated with filterName. | |
| bool | setFilterData (const QString &filterName, const QHelpFilterData &filterData) |
| Changes the existing filter details of the filter identified by filterName to filterData. | |
| bool | removeFilter (const QString &filterName) |
| Removes the filter identified by filterName. | |
| QStringList | namespacesForFilter (const QString &filterName) const |
| Returns the list of all registered documentation namespaces that match the filter identified by filterName. | |
| QStringList | indices () const |
| QStringList | indices (const QString &filterName) const |
| 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< QString > | bindableObjectName () |
| 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). | |
| QThread * | thread () 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 > | |
| 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 > | |
| 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 QObjectList & | children () 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< QByteArray > | dynamicPropertyNames () const |
| QBindingStorage * | bindingStorage () |
| const QBindingStorage * | bindingStorage () const |
| QObject * | parent () 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. | |
Protected Member Functions | |
| QHelpFilterEngine (QHelpEngineCore *helpEngine) | |
| virtual | ~QHelpFilterEngine () |
| Protected Member Functions inherited from QObject | |
| QObject * | sender () 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) | |
Friends | |
| class | QHelpEngineCorePrivate |
Additional Inherited Members | |
| Public Slots inherited from QObject | |
| void | deleteLater () |
| \threadsafe | |
| 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) |
| Protected Attributes inherited from QObject | |
| QScopedPointer< QObjectData > | d_ptr |
| Properties inherited from QObject | |
| QString | objectName |
| the name of this object | |
| Related Symbols inherited from QObject | |
| template< class T > T | qobject_cast (const QObject *object) |
| Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr. | |
| template< typename T > T | qFindChildqFindChildren (const QObject *obj, const QString &name)() |
| template< typename T > QList< T > | qFindChildrenqFindChildren (const QObject *obj, const QString &name)() |
| QObjectList | |
| \macro Q_CLASSINFO(Name, Value) | |
The QHelpFilterEngine class provides a filtered view of the help contents.
The filter engine allows the management of filters associated with a QHelpEngineCore instance. The help engine internally creates an instance of the filter engine, which can be accessed by calling QHelpEngineCore::filterEngine(). Therefore, the public constructor of this class is disabled.
The filters are identified by a filter name string. Filter details are described by the \l QHelpFilterData class.
The filter engine allows for adding new filters and changing the existing filters' data through the setFilterData() method. An existing filter can be removed through the removeFilter() method.
Out of the registered filters one can be marked as the active one. The active filter will be used by the associated help engine for returning filtered results of many different functions, such as content, index, or search results. If no filter is marked active, the help engine returns the full results list available.
The active filter is returned by activeFilter() and it can be changed by setActiveFilter().
Definition at line 21 of file qhelpfilterengine.h.
|
explicitprotected |
Constructs the filter engine for helpEngine.
Definition at line 102 of file qhelpfilterengine.cpp.
|
protectedvirtual |
Destroys the existing filter engine.
Definition at line 114 of file qhelpfilterengine.cpp.
| QString QHelpFilterEngine::activeFilter | ( | ) | const |
Returns the name of the currently active filter.
Definition at line 226 of file qhelpfilterengine.cpp.
| QStringList QHelpFilterEngine::availableComponents | ( | ) | const |
Returns the list of all available components defined in all registered documentation files.
Definition at line 166 of file qhelpfilterengine.cpp.
| QList< QVersionNumber > QHelpFilterEngine::availableVersions | ( | ) | const |
Returns the list of all available versions defined in all registered documentation files.
Definition at line 179 of file qhelpfilterengine.cpp.
This signal is emitted when the active filter is set.
newFilter specifies the name of the filter.
| QHelpFilterData QHelpFilterEngine::filterData | ( | const QString & | filterName | ) | const |
Returns the filter details associated with filterName.
Definition at line 189 of file qhelpfilterengine.cpp.
| QStringList QHelpFilterEngine::filters | ( | ) | const |
Returns the list of all filter names defined inside the filter engine.
Definition at line 155 of file qhelpfilterengine.cpp.
| QStringList QHelpFilterEngine::indices | ( | ) | const |
Returns a sorted list of available indices. The returned list contents depend on the active filter, and therefore only the indices registered for the active filter will be returned.
Definition at line 274 of file qhelpfilterengine.cpp.
| QStringList QHelpFilterEngine::indices | ( | const QString & | filterName | ) | const |
Returns a sorted list of available indices, filtered by filterName. The returned list contents depend on the passed filter, and therefore only the indices registered for this filter will be returned. If you want to get all available indices unfiltered, pass empty string as filterName.
Definition at line 288 of file qhelpfilterengine.cpp.
| QStringList QHelpFilterEngine::namespacesForFilter | ( | const QString & | filterName | ) | const |
Returns the list of all registered documentation namespaces that match the filter identified by filterName.
Definition at line 260 of file qhelpfilterengine.cpp.
Returns the map of all the available namespaces as keys together with their associated components as values.
Definition at line 134 of file qhelpfilterengine.cpp.
| QMap< QString, QVersionNumber > QHelpFilterEngine::namespaceToVersion | ( | ) | const |
Returns the map of all the available namespaces as keys together with their associated versions as values.
Definition at line 145 of file qhelpfilterengine.cpp.
| bool QHelpFilterEngine::removeFilter | ( | const QString & | filterName | ) |
Removes the filter identified by filterName.
Returns true if removing the filter succeeded, otherwise returns false.
Definition at line 216 of file qhelpfilterengine.cpp.
| bool QHelpFilterEngine::setActiveFilter | ( | const QString & | filterName | ) |
Changes the currently active filter to filterName.
Returns true if changing the filter succeeded, otherwise returns false.
Definition at line 239 of file qhelpfilterengine.cpp.
| bool QHelpFilterEngine::setFilterData | ( | const QString & | filterName, |
| const QHelpFilterData & | filterData ) |
Changes the existing filter details of the filter identified by filterName to filterData.
If the filter does not exist, a new filter is created.
Returns true if setting the filter succeeded, otherwise returns false.
Definition at line 203 of file qhelpfilterengine.cpp.
|
friend |
Definition at line 57 of file qhelpfilterengine.h.
1.12.0