Module qtjambi.help

Package io.qt.help

Class QHelpSearchEngine

java.lang.Object

io.qt.internal.QtJambiObject

io.qt.QtObject

io.qt.core.QObject

io.qt.help.QHelpSearchEngine

All Implemented Interfaces:

QtObjectInterface, QtSignalBlockerInterface, QtSignalEmitterInterface, QtThreadAffineInterface

public class QHelpSearchEngine
extends QObject

Access to widgets reusable to integrate fulltext search as well as to index and search documentation

Java wrapper for Qt class QHelpSearchEngine

Nested Class Summary

Nested classes/interfaces inherited from class io.qt.core.QObject

QObject.MultiSignal, QObject.PrivateSignal0, QObject.PrivateSignal1<A>, QObject.PrivateSignal2<A,B>, QObject.PrivateSignal3<A,B,C>, QObject.PrivateSignal4<A,B,C,D>, QObject.PrivateSignal5<A,B,C,D,E>, QObject.PrivateSignal6<A,B,C,D,E,F>, QObject.PrivateSignal7<A,B,C,D,E,F,G>, QObject.PrivateSignal8<A,B,C,D,E,F,G,H>, QObject.PrivateSignal9<A,B,C,D,E,F,G,H,I>, QObject.QDeclarativeConstructor, QObject.Signal0, QObject.Signal1<A>, QObject.Signal1Default1<A>, QObject.Signal2<A,B>, QObject.Signal2Default1<A,B>, QObject.Signal2Default2<A,B>, QObject.Signal3<A,B,C>, QObject.Signal3Default1<A,B,C>, QObject.Signal3Default2<A,B,C>, QObject.Signal3Default3<A,B,C>, QObject.Signal4<A,B,C,D>, QObject.Signal4Default1<A,B,C,D>, QObject.Signal4Default2<A,B,C,D>, QObject.Signal4Default3<A,B,C,D>, QObject.Signal4Default4<A,B,C,D>, QObject.Signal5<A,B,C,D,E>, QObject.Signal5Default1<A,B,C,D,E>, QObject.Signal5Default2<A,B,C,D,E>, QObject.Signal5Default3<A,B,C,D,E>, QObject.Signal5Default4<A,B,C,D,E>, QObject.Signal5Default5<A,B,C,D,E>, QObject.Signal6<A,B,C,D,E,F>, QObject.Signal6Default1<A,B,C,D,E,F>, QObject.Signal6Default2<A,B,C,D,E,F>, QObject.Signal6Default3<A,B,C,D,E,F>, QObject.Signal6Default4<A,B,C,D,E,F>, QObject.Signal6Default5<A,B,C,D,E,F>, QObject.Signal6Default6<A,B,C,D,E,F>, QObject.Signal7<A,B,C,D,E,F,G>, QObject.Signal7Default1<A,B,C,D,E,F,G>, QObject.Signal7Default2<A,B,C,D,E,F,G>, QObject.Signal7Default3<A,B,C,D,E,F,G>, QObject.Signal7Default4<A,B,C,D,E,F,G>, QObject.Signal7Default5<A,B,C,D,E,F,G>, QObject.Signal7Default6<A,B,C,D,E,F,G>, QObject.Signal7Default7<A,B,C,D,E,F,G>, QObject.Signal8<A,B,C,D,E,F,G,H>, QObject.Signal8Default1<A,B,C,D,E,F,G,H>, QObject.Signal8Default2<A,B,C,D,E,F,G,H>, QObject.Signal8Default3<A,B,C,D,E,F,G,H>, QObject.Signal8Default4<A,B,C,D,E,F,G,H>, QObject.Signal8Default5<A,B,C,D,E,F,G,H>, QObject.Signal8Default6<A,B,C,D,E,F,G,H>, QObject.Signal8Default7<A,B,C,D,E,F,G,H>, QObject.Signal8Default8<A,B,C,D,E,F,G,H>, QObject.Signal9<A,B,C,D,E,F,G,H,I>, QObject.Signal9Default1<A,B,C,D,E,F,G,H,I>, QObject.Signal9Default2<A,B,C,D,E,F,G,H,I>, QObject.Signal9Default3<A,B,C,D,E,F,G,H,I>, QObject.Signal9Default4<A,B,C,D,E,F,G,H,I>, QObject.Signal9Default5<A,B,C,D,E,F,G,H,I>, QObject.Signal9Default6<A,B,C,D,E,F,G,H,I>, QObject.Signal9Default7<A,B,C,D,E,F,G,H,I>, QObject.Signal9Default8<A,B,C,D,E,F,G,H,I>, QObject.Signal9Default9<A,B,C,D,E,F,G,H,I>, QObject.SignalConfiguration

Nested classes/interfaces inherited from class io.qt.QtObject

QtObject.QPrivateConstructor

Field Summary

Fields

Modifier and Type	Field	Description
QObject.Signal0	indexingFinished	See QHelpSearchEngine::indexingFinished()
QObject.Signal0	indexingStarted	See QHelpSearchEngine::indexingStarted()
QObject.Signal1<@QtPrimitiveType Integer>	searchingFinished	See QHelpSearchEngine::searchingFinished(int searchResultCount)
QObject.Signal0	searchingStarted	See QHelpSearchEngine::searchingStarted()
static QMetaObject	staticMetaObject	This variable stores the meta-object for the class.

Fields inherited from class io.qt.core.QObject

destroyed, objectNameChanged

Constructor Summary

Constructors

Modifier	Constructor	Description
	QHelpSearchEngine(QHelpEngineCore helpEngine)	Overloaded constructor for QHelpSearchEngine(io.qt.help.QHelpEngineCore, io.qt.core.QObject) with parent = null.
	QHelpSearchEngine(QHelpEngineCore helpEngine, QObject parent)	See QHelpSearchEngine::QHelpSearchEngine(QHelpEngineCore*,QObject*)
protected	QHelpSearchEngine(QtObject.QPrivateConstructor p)	Constructor for internal use only.

Method Summary

Modifier and Type	Method	Description
void	cancelIndexing()	See QHelpSearchEngine::cancelIndexing()
void	cancelSearching()	See QHelpSearchEngine::cancelSearching()
int	hitCount()	Deprecated.
QList<QPair<String,String>>	hits(int start, int end)	Deprecated.
int	hitsCount()	Deprecated.
QList<QHelpSearchQuery>	query()	Deprecated.
QHelpSearchQueryWidget	queryWidget()	See QHelpSearchEngine::queryWidget()
void	reindexDocumentation()	See QHelpSearchEngine::reindexDocumentation()
QHelpSearchResultWidget	resultWidget()	See QHelpSearchEngine::resultWidget()
void	scheduleIndexDocumentation()
void	search(String searchInput)	See QHelpSearchEngine::search(QString)
void	search(Collection<QHelpSearchQuery> queryList)	Deprecated.
String	searchInput()	See QHelpSearchEngine::searchInput()const
int	searchResultCount()	See QHelpSearchEngine::searchResultCount()const
QVector<QHelpSearchResult>	searchResults(int start, int end)	See QHelpSearchEngine::searchResults(int,int)const

Methods inherited from class io.qt.core.QObject

blockSignals, childEvent, children, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connectNotify, customEvent, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnectNotify, disposeLater, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, event, eventFilter, findChild, findChild, findChild, findChild, findChild, findChildren, findChildren, findChildren, findChildren, findChildren, findChildren, findChildren, findChildren, findChildren, findChildren, findChildren, inherits, inherits, installEventFilter, isSignalConnected, isWidgetType, isWindowType, killTimer, metaObject, moveToThread, objectName, parent, property, qt_metacast, receivers, receivers, removeEventFilter, sender, senderSignalIndex, setObjectName, setParent, setProperty, signalsBlocked, startTimer, startTimer, thread, timerEvent, toString, tr, tr, tr

Methods inherited from class io.qt.QtObject

dispose, equals, isDisposed

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.qt.QtObjectInterface

dispose, isDisposed

Field Details

staticMetaObject

public static final QMetaObject staticMetaObject

This variable stores the meta-object for the class.

indexingFinished

public final QObject.Signal0 indexingFinished

See QHelpSearchEngine::indexingFinished()

indexingStarted

public final QObject.Signal0 indexingStarted

See QHelpSearchEngine::indexingStarted()

searchingFinished

public final QObject.Signal1<@QtPrimitiveType Integer> searchingFinished

See QHelpSearchEngine::searchingFinished(int searchResultCount)

searchingStarted

public final QObject.Signal0 searchingStarted

See QHelpSearchEngine::searchingStarted()

Constructor Details

QHelpSearchEngine

public QHelpSearchEngine(QHelpEngineCore helpEngine)

Overloaded constructor for QHelpSearchEngine(io.qt.help.QHelpEngineCore, io.qt.core.QObject) with parent = null.

QHelpSearchEngine

public QHelpSearchEngine(QHelpEngineCore helpEngine, QObject parent)

See QHelpSearchEngine::QHelpSearchEngine(QHelpEngineCore*,QObject*)

QHelpSearchEngine

protected QHelpSearchEngine(QtObject.QPrivateConstructor p)

Constructor for internal use only.

Parameters:

p - expected to be null.

Method Details

cancelIndexing

public final void cancelIndexing()

See QHelpSearchEngine::cancelIndexing()

cancelSearching

public final void cancelSearching()

See QHelpSearchEngine::cancelSearching()

hitCount

@Deprecated @QtUninvokable public final int hitCount()

Deprecated.

See QHelpSearchEngine::hitCount()const

hits

@Deprecated @QtUninvokable public final QList<QPair<String,String>> hits(int start, int end)

Deprecated.

See QHelpSearchEngine::hits(int,int)const

hitsCount

@Deprecated @QtUninvokable public final int hitsCount()

Deprecated.

See QHelpSearchEngine::hitsCount()const

query

@Deprecated @QtUninvokable public final QList<QHelpSearchQuery> query()

Deprecated.

See QHelpSearchEngine::query()const

queryWidget

@QtUninvokable public final QHelpSearchQueryWidget queryWidget()

See QHelpSearchEngine::queryWidget()

reindexDocumentation

public final void reindexDocumentation()

See QHelpSearchEngine::reindexDocumentation()

resultWidget

@QtUninvokable public final QHelpSearchResultWidget resultWidget()

See QHelpSearchEngine::resultWidget()

scheduleIndexDocumentation

public final void scheduleIndexDocumentation()

search

@Deprecated public final void search(Collection<QHelpSearchQuery> queryList)

Deprecated.

See QHelpSearchEngine::search(QList<QHelpSearchQuery>)

search

public final void search(String searchInput)

See QHelpSearchEngine::search(QString)

searchInput

@QtUninvokable public final String searchInput()

See QHelpSearchEngine::searchInput()const

searchResultCount

@QtUninvokable public final int searchResultCount()

See QHelpSearchEngine::searchResultCount()const

searchResults

@QtUninvokable public final QVector<QHelpSearchResult> searchResults(int start, int end)

See QHelpSearchEngine::searchResults(int,int)const