io.qt.help.QHelpEngine 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 contents and indices of the help engine
 * Java wrapper for Qt class QHelpEngine
 */
public class QHelpEngine extends io.qt.help.QHelpEngineCore
{
    /**
     * This variable stores the meta-object for the class.
     */
    public static final io.qt.core.@NonNull QMetaObject staticMetaObject = io.qt.core.QMetaObject.forType(QHelpEngine.class);
    
    
    /**
     * See QHelpEngine::QHelpEngine(QString,QObject*)
     */
    public QHelpEngine(java.lang.@NonNull String collectionFile, io.qt.core.@Nullable QObject parent){
        super((QPrivateConstructor)null);
        initialize_native(this, collectionFile, parent);
        if (parent != null) QtJambi_LibraryUtilities.internal.setCppOwnership(this);
    }
    
    private native static void initialize_native(QHelpEngine instance, java.lang.String collectionFile, io.qt.core.QObject parent);
    
    /**
     * See QHelpEngine::contentModel()const
     */
    @QtUninvokable
    public final io.qt.help.@Nullable QHelpContentModel contentModel(){
        return contentModel_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.help.QHelpContentModel contentModel_native_constfct(long __this__nativeId);
    
    /**
     * See QHelpEngine::contentWidget()
     */
    @QtUninvokable
    public final io.qt.help.@Nullable QHelpContentWidget contentWidget(){
        return contentWidget_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.help.QHelpContentWidget contentWidget_native(long __this__nativeId);
    
    /**
     * See QHelpEngine::indexModel()const
     */
    @QtUninvokable
    public final io.qt.help.@Nullable QHelpIndexModel indexModel(){
        return indexModel_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.help.QHelpIndexModel indexModel_native_constfct(long __this__nativeId);
    
    /**
     * See QHelpEngine::indexWidget()
     */
    @QtUninvokable
    public final io.qt.help.@Nullable QHelpIndexWidget indexWidget(){
        return indexWidget_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.help.QHelpIndexWidget indexWidget_native(long __this__nativeId);
    
    /**
     * See QHelpEngine::searchEngine()
     */
    @QtUninvokable
    public final io.qt.help.@Nullable QHelpSearchEngine searchEngine(){
        return searchEngine_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.help.QHelpSearchEngine searchEngine_native(long __this__nativeId);
    
    /**
     * Constructor for internal use only.
     * @param p expected to be null.
     * @hidden
     */
    @NativeAccess
    protected QHelpEngine(QPrivateConstructor p) { super(p); } 
    
    
    /**
     * Overloaded constructor for {@link #QHelpEngine(java.lang.String, io.qt.core.QObject)}
     *  with parent = null.
     */
    public QHelpEngine(java.lang.@NonNull String collectionFile) {
        this(collectionFile, (io.qt.core.QObject)null);
    }
}