 |
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 QHelpEngine class provides access to contents and indices of the help engine. More...
#include <qhelpengine.h>
Inheritance diagram for QHelpEngine: Collaboration diagram for QHelpEngine:Public Member Functions | |
| QHelpEngine (const QString &collectionFile, QObject *parent=nullptr) | |
| Constructs a new help engine with the given parent. | |
| ~QHelpEngine () | |
| Destroys the help engine object. | |
| QHelpContentModel * | contentModel () const |
| Returns the content model. | |
| QHelpIndexModel * | indexModel () const |
| Returns the index model. | |
| QHelpContentWidget * | contentWidget () |
| Returns the content widget. | |
| QHelpIndexWidget * | indexWidget () |
| Returns the index widget. | |
| QHelpSearchEngine * | searchEngine () |
| Returns the default search engine. | |
| Public Member Functions inherited from QHelpEngineCore | |
| QHelpEngineCore (const QString &collectionFile, QObject *parent=nullptr) | |
| Constructs a new core help engine with a parent. | |
| virtual | ~QHelpEngineCore () |
| Destructs the help engine. | |
| bool | isReadOnly () const |
| void | setReadOnly (bool enable) |
| QHelpFilterEngine * | filterEngine () const |
| bool | setupData () |
| Sets up the help engine by processing the information found in the collection file and returns true if successful; otherwise returns false. | |
| QString | collectionFile () const |
| void | setCollectionFile (const QString &fileName) |
| bool | copyCollectionFile (const QString &fileName) |
| Creates the file fileName and copies all contents from the current collection file into the newly created file, and returns true if successful; otherwise returns false. | |
| bool | registerDocumentation (const QString &documentationFileName) |
| Registers the Qt compressed help file (.qch) contained in the file documentationFileName. | |
| bool | unregisterDocumentation (const QString &namespaceName) |
| Unregisters the Qt compressed help file (.qch) identified by its namespaceName from the help collection. | |
| QString | documentationFileName (const QString &namespaceName) |
| Returns the absolute file name of the Qt compressed help file (.qch) identified by the namespaceName. | |
| QStringList | registeredDocumentations () const |
| Returns a list of all registered Qt compressed help files of the current collection file. | |
| QByteArray | fileData (const QUrl &url) const |
| Returns the data of the file specified by url. | |
| QStringList | customFilters () const |
| bool | removeCustomFilter (const QString &filterName) |
| bool | addCustomFilter (const QString &filterName, const QStringList &attributes) |
| QStringList | filterAttributes () const |
| QStringList | filterAttributes (const QString &filterName) const |
| QString | currentFilter () const |
| the name of the custom filter currently applied. | |
| void | setCurrentFilter (const QString &filterName) |
| QList< QStringList > | filterAttributeSets (const QString &namespaceName) const |
| QList< QUrl > | files (const QString namespaceName, const QStringList &filterAttributes, const QString &extensionFilter={}) |
| QList< QUrl > | files (const QString namespaceName, const QString &filterName, const QString &extensionFilter={}) |
| Returns a list of files contained in the Qt compressed help file for namespaceName. | |
| QUrl | findFile (const QUrl &url) const |
| Returns the corrected URL for the url that may refer to a different namespace defined by the virtual folder defined as a part of the url. | |
| QList< QHelpLink > | documentsForIdentifier (const QString &id) const |
| QList< QHelpLink > | documentsForIdentifier (const QString &id, const QString &filterName) const |
| QList< QHelpLink > | documentsForKeyword (const QString &keyword) const |
| QList< QHelpLink > | documentsForKeyword (const QString &keyword, const QString &filterName) const |
| bool | removeCustomValue (const QString &key) |
| Removes the key from the settings section in the collection file. | |
| QVariant | customValue (const QString &key, const QVariant &defaultValue={}) const |
| Returns the value assigned to the key. | |
| bool | setCustomValue (const QString &key, const QVariant &value) |
| Save the value under the key. | |
| QString | error () const |
| Returns a description of the last error that occurred. | |
| void | setAutoSaveFilter (bool save) |
| bool | autoSaveFilter () const |
| void | setUsesFilterEngine (bool uses) |
| bool | usesFilterEngine () 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. | |
Friends | |
| class | HelpEngineWrapper |
Additional Inherited Members | |
| Public Slots inherited from QObject | |
| void | deleteLater () |
| \threadsafe | |
| Signals inherited from QHelpEngineCore | |
| void | setupStarted () |
| This signal is emitted when setup is started. | |
| void | setupFinished () |
| This signal is emitted when the setup is complete. | |
| void | warning (const QString &msg) |
| This signal is emitted when a non critical error occurs. | |
| void | currentFilterChanged (const QString &newFilter) |
| void | readersAboutToBeInvalidated () |
| 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. | |
| Static Public Member Functions inherited from QHelpEngineCore | |
| static QString | namespaceName (const QString &documentationFileName) |
| Returns the namespace name defined for the Qt compressed help file (.qch) specified by its documentationFileName. | |
| static QVariant | metaData (const QString &documentationFileName, const QString &name) |
| Returns the meta data for the Qt compressed help file documentationFileName. | |
| 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 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) | |
| Protected Attributes inherited from QObject | |
| QScopedPointer< QObjectData > | d_ptr |
| Properties inherited from QHelpEngineCore | |
| bool | autoSaveFilter |
| whether QHelpEngineCore is in auto save filter mode or not. | |
| QString | collectionFile |
| the absolute file name of the collection file currently used. | |
| bool | readOnly |
| whether the help engine is read-only. | |
| 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 QHelpEngine class provides access to contents and indices of the help engine.
Definition at line 18 of file qhelpengine.h.
Constructs a new help engine with the given parent.
The help engine uses the information stored in the collectionFile for providing help. If the collection file does not already exist, it will be created.
Definition at line 78 of file qhelpengine.cpp.
| QHelpEngine::~QHelpEngine | ( | ) |
Destroys the help engine object.
Definition at line 86 of file qhelpengine.cpp.
| QHelpContentModel * QHelpEngine::contentModel | ( | ) | const |
Returns the content model.
Definition at line 94 of file qhelpengine.cpp.
| QHelpContentWidget * QHelpEngine::contentWidget | ( | ) |
Returns the content widget.
Definition at line 110 of file qhelpengine.cpp.
| QHelpIndexModel * QHelpEngine::indexModel | ( | ) | const |
Returns the index model.
Definition at line 102 of file qhelpengine.cpp.
| QHelpIndexWidget * QHelpEngine::indexWidget | ( | ) |
Returns the index widget.
Definition at line 130 of file qhelpengine.cpp.
| QHelpSearchEngine * QHelpEngine::searchEngine | ( | ) |
Returns the default search engine.
Definition at line 150 of file qhelpengine.cpp.
|
friend |
Definition at line 37 of file qhelpengine.h.
1.12.0