io.qt.help.QHelpSearchEngine Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of qtjambi-help Show documentation
Classes for integrating documentation into applications, similar to Qt Assistant.
There is a newer version: 6.8.1
package io.qt.help;

import io.qt.*;


/**
 * Access to widgets reusable to integrate fulltext search as well as to index and search documentation
 * Java wrapper for Qt class QHelpSearchEngine
 */
public class QHelpSearchEngine extends io.qt.core.QObject
{
    static {
        QtJambi_LibraryUtilities.initialize();
    }
    
    /**
     * This variable stores the meta-object for the class.
     */
    public static final io.qt.core.@NonNull QMetaObject staticMetaObject = io.qt.core.QMetaObject.forType(QHelpSearchEngine.class);
    

    /**
     * See QHelpSearchEngine::indexingFinished()
     */
    public final @NonNull Signal0 indexingFinished = new Signal0();

    /**
     * See QHelpSearchEngine::indexingStarted()
     */
    public final @NonNull Signal0 indexingStarted = new Signal0();

    /**
     * See QHelpSearchEngine::searchingFinished(int)
     */
    public final @NonNull Signal1 searchingFinished = new Signal1<>();

    /**
     * See QHelpSearchEngine::searchingStarted()
     */
    public final @NonNull Signal0 searchingStarted = new Signal0();
    
    /**
     * See QHelpSearchEngine::QHelpSearchEngine(QHelpEngineCore*,QObject*)
     */
    public QHelpSearchEngine(io.qt.help.@Nullable QHelpEngineCore helpEngine, io.qt.core.@Nullable QObject parent){
        super((QPrivateConstructor)null);
        initialize_native(this, helpEngine, parent);
        if (parent != null) QtJambi_LibraryUtilities.internal.setCppOwnership(this);
    }
    
    private native static void initialize_native(QHelpSearchEngine instance, io.qt.help.QHelpEngineCore helpEngine, io.qt.core.QObject parent);
    
    /**
     * See QHelpSearchEngine::cancelIndexing()
     */
    public final void cancelIndexing(){
        cancelIndexing_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    private native void cancelIndexing_native(long __this__nativeId);
    
    /**
     * See QHelpSearchEngine::cancelSearching()
     */
    public final void cancelSearching(){
        cancelSearching_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    private native void cancelSearching_native(long __this__nativeId);
    
    /**
     * See QHelpSearchEngine::hitCount()const
     */
    @QtUninvokable
    public final int hitCount(){
        return hitCount_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native int hitCount_native_constfct(long __this__nativeId);
    
    /**
     * See QHelpSearchEngine::hits(int,int)const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QList> hits(int start, int end){
        return hits_native_int_int_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), start, end);
    }
    
    @QtUninvokable
    private native io.qt.core.QList> hits_native_int_int_constfct(long __this__nativeId, int start, int end);
    
    /**
     * See QHelpSearchEngine::hitsCount()const
     */
    @QtUninvokable
    public final int hitsCount(){
        return hitsCount_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native int hitsCount_native_constfct(long __this__nativeId);
    
    /**
     * See QHelpSearchEngine::query()const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QList query(){
        return query_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.core.QList query_native_constfct(long __this__nativeId);
    
    /**
     * See QHelpSearchEngine::queryWidget()
     */
    @QtUninvokable
    public final io.qt.help.@Nullable QHelpSearchQueryWidget queryWidget(){
        return queryWidget_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.help.QHelpSearchQueryWidget queryWidget_native(long __this__nativeId);
    
    /**
     * See QHelpSearchEngine::reindexDocumentation()
     */
    public final void reindexDocumentation(){
        reindexDocumentation_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    private native void reindexDocumentation_native(long __this__nativeId);
    
    /**
     * See QHelpSearchEngine::resultWidget()
     */
    @QtUninvokable
    public final io.qt.help.@Nullable QHelpSearchResultWidget resultWidget(){
        return resultWidget_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.help.QHelpSearchResultWidget resultWidget_native(long __this__nativeId);
    
    /**
     * See QHelpSearchEngine::scheduleIndexDocumentation()
     */
    public final void scheduleIndexDocumentation(){
        scheduleIndexDocumentation_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    private native void scheduleIndexDocumentation_native(long __this__nativeId);
    
    /**
     * See QHelpSearchEngine::search(QList<QHelpSearchQuery>)
     */
    public final void search(java.util.@NonNull Collection queryList){
        search_native_cref_QList(QtJambi_LibraryUtilities.internal.nativeId(this), queryList);
    }
    
    private native void search_native_cref_QList(long __this__nativeId, java.util.Collection queryList);
    
    /**
     * See QHelpSearchEngine::search(QString)
     */
    public final void search(java.lang.@NonNull String searchInput){
        search_native_cref_QString(QtJambi_LibraryUtilities.internal.nativeId(this), searchInput);
    }
    
    private native void search_native_cref_QString(long __this__nativeId, java.lang.String searchInput);
    
    /**
     * See QHelpSearchEngine::searchInput()const
     */
    @QtUninvokable
    public final java.lang.@NonNull String searchInput(){
        return searchInput_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native java.lang.String searchInput_native_constfct(long __this__nativeId);
    
    /**
     * See QHelpSearchEngine::searchResultCount()const
     */
    @QtUninvokable
    public final int searchResultCount(){
        return searchResultCount_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native int searchResultCount_native_constfct(long __this__nativeId);
    
    /**
     * See QHelpSearchEngine::searchResults(int,int)const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QVector searchResults(int start, int end){
        return searchResults_native_int_int_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), start, end);
    }
    
    @QtUninvokable
    private native io.qt.core.QVector searchResults_native_int_int_constfct(long __this__nativeId, int start, int end);
    
    /**
     * Constructor for internal use only.
     * @param p expected to be null.
     * @hidden
     */
    @NativeAccess
    protected QHelpSearchEngine(QPrivateConstructor p) { super(p); } 
    
    
    /**
     * Overloaded constructor for {@link #QHelpSearchEngine(io.qt.help.QHelpEngineCore, io.qt.core.QObject)}
     *  with parent = null.
     */
    public QHelpSearchEngine(io.qt.help.@Nullable QHelpEngineCore helpEngine) {
        this(helpEngine, (io.qt.core.QObject)null);
    }
}