The QHelpSearchEngine class provides access to widgets reusable to integrate fulltext search as well as to index and search documentation. More...

#include <qhelpsearchengine.h>

Inheritance diagram for QHelpSearchEngine:

Collaboration diagram for QHelpSearchEngine:

Public Slots
void	reindexDocumentation ()
	Forces the search engine to reindex all documentation files.

void	cancelIndexing ()
	Stops the indexing process.

void	search (const QString &searchInput)

void	cancelSearching ()
	Stops the search process.

void	scheduleIndexDocumentation ()

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	indexingStarted ()
	This signal is emitted when indexing process is started.

void	indexingFinished ()
	This signal is emitted when the indexing process is complete.

void	searchingStarted ()
	This signal is emitted when the search process is started.

void	searchingFinished (int searchResultCount)
	This signal is emitted when the search process is complete.

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
	QHelpSearchEngine (QHelpEngineCore helpEngine, QObject parent=nullptr)
	Constructs a new search engine with the given parent.

	~QHelpSearchEngine ()
	Destructs the search engine.

QHelpSearchQueryWidget *	queryWidget ()
	Returns a widget to use as input widget.

QHelpSearchResultWidget *	resultWidget ()
	Returns a widget that can hold and display the search results.

int	searchResultCount () const

QList< QHelpSearchResult >	searchResults (int start, int end) const

QString	searchInput () 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`.

Additional Inherited Members
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 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)

Detailed Description

The QHelpSearchEngine class provides access to widgets reusable to integrate fulltext search as well as to index and search documentation.

Since: 4.4 \inmodule QtHelp

Before the search engine can be used, one has to instantiate at least a QHelpEngineCore object that needs to be passed to the search engines constructor. This is required as the search engine needs to be connected to the help engines setupFinished() signal to know when it can start to index documentation.

After starting the indexing process the signal indexingStarted() is emitted and on the end of the indexing process the indexingFinished() is emitted. To stop the indexing one can call cancelIndexing().

When the indexing process has finished, the search engine can be used to search through the index for a given term using the search() function. When the search input is passed to the search engine, the searchingStarted() signal is emitted. When the search finishes, the searchingFinished() signal is emitted. The search process can be stopped by calling cancelSearching().

If the search succeeds, searchingFinished() is called with the search result count to fetch the search results from the search engine. Calling the searchResults() function with a range returns a list of QHelpSearchResult objects within the range. The results consist of the document title and URL, as well as a snippet from the document that contains the best match for the search input.

To display the given search results use the QHelpSearchResultWidget or build up your own one if you need more advanced functionality. Note that the QHelpSearchResultWidget can not be instantiated directly, you must retrieve the widget from the search engine in use as all connections will be established for you by the widget itself.

Definition at line 39 of file qhelpsearchengine.h.

Constructor & Destructor Documentation

◆ QHelpSearchEngine()

QHelpSearchEngine::QHelpSearchEngine	(	QHelpEngineCore *	helpEngine,
		QObject *	parent = nullptr )

explicit

Constructs a new search engine with the given parent.

The search engine uses the given helpEngine to access the documentation that needs to be indexed. The QHelpEngine's setupFinished() signal is automatically connected to the QHelpSearchEngine's indexing function, so that new documentation will be indexed after the signal is emitted.

Definition at line 133 of file qhelpsearchengine.cpp.

◆ ~QHelpSearchEngine()

QHelpSearchEngine::~QHelpSearchEngine ( )

Destructs the search engine.

Definition at line 150 of file qhelpsearchengine.cpp.

Member Function Documentation

◆ cancelIndexing

void QHelpSearchEngine::cancelIndexing ( )

slot

Stops the indexing process.

Definition at line 277 of file qhelpsearchengine.cpp.

◆ cancelSearching

void QHelpSearchEngine::cancelSearching ( )

slot

Stops the search process.

Definition at line 285 of file qhelpsearchengine.cpp.

◆ indexingFinished

void QHelpSearchEngine::indexingFinished ( )

signal

This signal is emitted when the indexing process is complete.

◆ indexingStarted

void QHelpSearchEngine::indexingStarted ( )

signal

This signal is emitted when indexing process is started.

◆ queryWidget()

QHelpSearchQueryWidget * QHelpSearchEngine::queryWidget ( )

Returns a widget to use as input widget.

Depending on your search engine configuration you will get a different widget with more or less subwidgets.

Definition at line 159 of file qhelpsearchengine.cpp.

◆ reindexDocumentation

void QHelpSearchEngine::reindexDocumentation ( )

slot

Forces the search engine to reindex all documentation files.

Definition at line 269 of file qhelpsearchengine.cpp.

◆ resultWidget()

QHelpSearchResultWidget * QHelpSearchEngine::resultWidget ( )

Returns a widget that can hold and display the search results.

Definition at line 169 of file qhelpsearchengine.cpp.

◆ scheduleIndexDocumentation

void QHelpSearchEngine::scheduleIndexDocumentation ( )

slot

Definition at line 329 of file qhelpsearchengine.cpp.

◆ search

void QHelpSearchEngine::search ( const QString & searchInput )

slot

Since: 5.9 Starts the search process using the given search phrase searchInput.

The phrase may consist of several words. By default, the search engine returns the list of documents that contain all the specified words. The phrase may contain any combination of the logical operators AND, OR, and NOT. The operator must be written in all capital letters, otherwise it will be considered a part of the search phrase.

If double quotation marks are used to group the words, the search engine will search for an exact match of the quoted phrase.

For more information about the text query syntax, see \l {https://sqlite.org/fts5.html#full_text_query_syntax} {SQLite FTS5 Extension}.

Definition at line 307 of file qhelpsearchengine.cpp.

◆ searchingFinished

void QHelpSearchEngine::searchingFinished ( int searchResultCount )

signal

This signal is emitted when the search process is complete.

The search result count is stored in searchResultCount.

◆ searchingStarted

void QHelpSearchEngine::searchingStarted ( )

signal

This signal is emitted when the search process is started.

◆ searchInput()

QString QHelpSearchEngine::searchInput ( ) const

Since: 5.9 Returns the phrase that was last searched for.

Definition at line 246 of file qhelpsearchengine.cpp.

◆ searchResultCount()

int QHelpSearchEngine::searchResultCount ( ) const

Since: 5.9 Returns the number of results the search engine found.

Definition at line 201 of file qhelpsearchengine.cpp.

◆ searchResults()

QList< QHelpSearchResult > QHelpSearchEngine::searchResults	(	int	start,
		int	end ) const

Since: 5.9 Returns a list of search results within the range from the index specified by start to the index specified by end.

Definition at line 237 of file qhelpsearchengine.cpp.

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

qttools/src/assistant/help/qhelpsearchengine.h (82440a59b3c0e465ab3114a1dd8a46fd2e6a74cb)
qttools/src/assistant/help/qhelpsearchengine.cpp (cc7f4655325b5d2662cc1d32282b538b4273b94e)

Public Slots

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QHelpSearchEngine()

◆ ~QHelpSearchEngine()

Member Function Documentation

◆ cancelIndexing

◆ cancelSearching

◆ indexingFinished

◆ indexingStarted

◆ queryWidget()

◆ reindexDocumentation

◆ resultWidget()

◆ scheduleIndexDocumentation

◆ search

◆ searchingFinished

◆ searchingStarted

◆ searchInput()

◆ searchResultCount()

◆ searchResults()