io.qt.help.QHelpIndexModel 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.*;


/**
 * Model that supplies index keywords to views
 * Java wrapper for Qt class QHelpIndexModel
 */
public final class QHelpIndexModel extends io.qt.core.QStringListModel
{
    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(QHelpIndexModel.class);
    

    /**
     * See QHelpIndexModel::indexCreated()
     */
    public final @NonNull Signal0 indexCreated = new Signal0();

    /**
     * See QHelpIndexModel::indexCreationStarted()
     */
    public final @NonNull Signal0 indexCreationStarted = new Signal0();
    
    /**
     * See QHelpIndexModel::createIndex(QString)
     */
    @QtUninvokable
    public final void createIndex(java.lang.@NonNull String customFilterName){
        createIndex_native_cref_QString(QtJambi_LibraryUtilities.internal.nativeId(this), customFilterName);
    }
    
    @QtUninvokable
    private native void createIndex_native_cref_QString(long __this__nativeId, java.lang.String customFilterName);
    
    /**
     * See QHelpIndexModel::filter(QString,QString)
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QModelIndex filter(java.lang.@NonNull String filter, java.lang.@NonNull String wildcard){
        return filter_native_cref_QString_cref_QString(QtJambi_LibraryUtilities.internal.nativeId(this), filter, wildcard);
    }
    
    @QtUninvokable
    private native io.qt.core.QModelIndex filter_native_cref_QString_cref_QString(long __this__nativeId, java.lang.String filter, java.lang.String wildcard);
    
    /**
     * See QHelpIndexModel::helpEngine()const
     */
    @QtUninvokable
    public final io.qt.help.@Nullable QHelpEngineCore helpEngine(){
        return helpEngine_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.help.QHelpEngineCore helpEngine_native_constfct(long __this__nativeId);
    
    /**
     * See QHelpIndexModel::isCreatingIndex()const
     */
    @QtUninvokable
    public final boolean isCreatingIndex(){
        return isCreatingIndex_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native boolean isCreatingIndex_native_constfct(long __this__nativeId);
    
    /**
     * See QHelpIndexModel::linksForKeyword(QString)const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QMap linksForKeyword(java.lang.@NonNull String keyword){
        return linksForKeyword_native_cref_QString_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), keyword);
    }
    
    @QtUninvokable
    private native io.qt.core.QMap linksForKeyword_native_cref_QString_constfct(long __this__nativeId, java.lang.String keyword);
    
    /**
     * Constructor for internal use only.
     * @param p expected to be null.
     * @hidden
     */
    @NativeAccess
    protected QHelpIndexModel(QPrivateConstructor p) { super(p); } 
    
    
    /**
     * Overloaded function for {@link #filter(java.lang.String, java.lang.String)}
     *  with wildcard = (String)null.
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QModelIndex filter(java.lang.@NonNull String filter) {
        return filter(filter, (String)null);
    }
}