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


/**
 * The core functionality of the help system
 * Java wrapper for Qt class QHelpEngineCore
 */
public class QHelpEngineCore 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(QHelpEngineCore.class);
    

    /**
     * See QHelpEngineCore::currentFilterChanged(QString)
     */
    public final @NonNull Signal1 currentFilterChanged = new Signal1<>();

    /**
     * See QHelpEngineCore::readersAboutToBeInvalidated()
     */
    public final @NonNull Signal0 readersAboutToBeInvalidated = new Signal0();

    /**
     * See QHelpEngineCore::setupFinished()
     */
    public final @NonNull Signal0 setupFinished = new Signal0();

    /**
     * See QHelpEngineCore::setupStarted()
     */
    public final @NonNull Signal0 setupStarted = new Signal0();

    /**
     * See QHelpEngineCore::warning(QString)
     */
    public final @NonNull Signal1 warning = new Signal1<>();
    
    /**
     * See QHelpEngineCore::QHelpEngineCore(QString,QObject*)
     */
    public QHelpEngineCore(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(QHelpEngineCore instance, java.lang.String collectionFile, io.qt.core.QObject parent);
    
    /**
     * See QHelpEngineCore::addCustomFilter(QString,QStringList)
     */
    @QtUninvokable
    public final boolean addCustomFilter(java.lang.@NonNull String filterName, java.util.@NonNull Collection attributes){
        return addCustomFilter_native_cref_QString_cref_QStringList(QtJambi_LibraryUtilities.internal.nativeId(this), filterName, attributes);
    }
    
    @QtUninvokable
    private native boolean addCustomFilter_native_cref_QString_cref_QStringList(long __this__nativeId, java.lang.String filterName, java.util.Collection attributes);
    
    /**
     * See QHelpEngineCore::autoSaveFilter()const
     */
    @QtPropertyReader(name="autoSaveFilter")
    @QtUninvokable
    public final boolean autoSaveFilter(){
        return autoSaveFilter_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native boolean autoSaveFilter_native_constfct(long __this__nativeId);
    
    /**
     * See QHelpEngineCore::collectionFile()const
     */
    @QtPropertyReader(name="collectionFile")
    @QtUninvokable
    public final java.lang.@NonNull String collectionFile(){
        return collectionFile_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native java.lang.String collectionFile_native_constfct(long __this__nativeId);
    
    /**
     * See QHelpEngineCore::copyCollectionFile(QString)
     */
    @QtUninvokable
    public final boolean copyCollectionFile(java.lang.@NonNull String fileName){
        return copyCollectionFile_native_cref_QString(QtJambi_LibraryUtilities.internal.nativeId(this), fileName);
    }
    
    @QtUninvokable
    private native boolean copyCollectionFile_native_cref_QString(long __this__nativeId, java.lang.String fileName);
    
    /**
     * See QHelpEngineCore::currentFilter()const
     */
    @QtPropertyReader(name="currentFilter")
    @QtUninvokable
    public final java.lang.@NonNull String currentFilter(){
        return currentFilter_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native java.lang.String currentFilter_native_constfct(long __this__nativeId);
    
    /**
     * See QHelpEngineCore::customFilters()const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QStringList customFilters(){
        return customFilters_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.core.QStringList customFilters_native_constfct(long __this__nativeId);
    
    /**
     * See QHelpEngineCore::customValue(QString,QVariant)const
     */
    @QtUninvokable
    public final java.lang.Object customValue(java.lang.@NonNull String key, java.lang.Object defaultValue){
        return customValue_native_cref_QString_cref_QVariant_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), key, defaultValue);
    }
    
    @QtUninvokable
    private native java.lang.Object customValue_native_cref_QString_cref_QVariant_constfct(long __this__nativeId, java.lang.String key, java.lang.Object defaultValue);
    
    /**
     * See QHelpEngineCore::documentationFileName(QString)
     */
    @QtUninvokable
    public final java.lang.@NonNull String documentationFileName(java.lang.@NonNull String namespaceName){
        return documentationFileName_native_cref_QString(QtJambi_LibraryUtilities.internal.nativeId(this), namespaceName);
    }
    
    @QtUninvokable
    private native java.lang.String documentationFileName_native_cref_QString(long __this__nativeId, java.lang.String namespaceName);
    
    /**
     * See QHelpEngineCore::documentsForIdentifier(QString)const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QList documentsForIdentifier(java.lang.@NonNull String id){
        return documentsForIdentifier_native_cref_QString_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), id);
    }
    
    @QtUninvokable
    private native io.qt.core.QList documentsForIdentifier_native_cref_QString_constfct(long __this__nativeId, java.lang.String id);
    
    /**
     * See QHelpEngineCore::documentsForIdentifier(QString,QString)const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QList documentsForIdentifier(java.lang.@NonNull String id, java.lang.@NonNull String filterName){
        return documentsForIdentifier_native_cref_QString_cref_QString_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), id, filterName);
    }
    
    @QtUninvokable
    private native io.qt.core.QList documentsForIdentifier_native_cref_QString_cref_QString_constfct(long __this__nativeId, java.lang.String id, java.lang.String filterName);
    
    /**
     * See QHelpEngineCore::documentsForKeyword(QString)const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QList documentsForKeyword(java.lang.@NonNull String keyword){
        return documentsForKeyword_native_cref_QString_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), keyword);
    }
    
    @QtUninvokable
    private native io.qt.core.QList documentsForKeyword_native_cref_QString_constfct(long __this__nativeId, java.lang.String keyword);
    
    /**
     * See QHelpEngineCore::documentsForKeyword(QString,QString)const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QList documentsForKeyword(java.lang.@NonNull String keyword, java.lang.@NonNull String filterName){
        return documentsForKeyword_native_cref_QString_cref_QString_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), keyword, filterName);
    }
    
    @QtUninvokable
    private native io.qt.core.QList documentsForKeyword_native_cref_QString_cref_QString_constfct(long __this__nativeId, java.lang.String keyword, java.lang.String filterName);
    
    /**
     * See QHelpEngineCore::error()const
     */
    @QtUninvokable
    public final java.lang.@NonNull String error(){
        return error_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native java.lang.String error_native_constfct(long __this__nativeId);
    
    /**
     * See QHelpEngineCore::fileData(QUrl)const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QByteArray fileData(io.qt.core.@NonNull QUrl url){
        return fileData_native_cref_QUrl_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(url));
    }
    
    @QtUninvokable
    private native io.qt.core.QByteArray fileData_native_cref_QUrl_constfct(long __this__nativeId, long url);
    
    /**
     * See QHelpEngineCore::files(QString,QString,QString)
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QList files(java.lang.@NonNull String namespaceName, java.lang.@NonNull String filterName, java.lang.@NonNull String extensionFilter){
        return files_native_const_QString_cref_QString_cref_QString(QtJambi_LibraryUtilities.internal.nativeId(this), namespaceName, filterName, extensionFilter);
    }
    
    @QtUninvokable
    private native io.qt.core.QList files_native_const_QString_cref_QString_cref_QString(long __this__nativeId, java.lang.String namespaceName, java.lang.String filterName, java.lang.String extensionFilter);
    
    /**
     * See QHelpEngineCore::files(QString,QStringList,QString)
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QList files(java.lang.@NonNull String namespaceName, java.util.@NonNull Collection filterAttributes, java.lang.@NonNull String extensionFilter){
        return files_native_const_QString_cref_QStringList_cref_QString(QtJambi_LibraryUtilities.internal.nativeId(this), namespaceName, filterAttributes, extensionFilter);
    }
    
    @QtUninvokable
    private native io.qt.core.QList files_native_const_QString_cref_QStringList_cref_QString(long __this__nativeId, java.lang.String namespaceName, java.util.Collection filterAttributes, java.lang.String extensionFilter);
    
    /**
     * See QHelpEngineCore::filterAttributeSets(QString)const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QList> filterAttributeSets(java.lang.@NonNull String namespaceName){
        return filterAttributeSets_native_cref_QString_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), namespaceName);
    }
    
    @QtUninvokable
    private native io.qt.core.QList> filterAttributeSets_native_cref_QString_constfct(long __this__nativeId, java.lang.String namespaceName);
    
    /**
     * See QHelpEngineCore::filterAttributes()const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QStringList filterAttributes(){
        return filterAttributes_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.core.QStringList filterAttributes_native_constfct(long __this__nativeId);
    
    /**
     * See QHelpEngineCore::filterAttributes(QString)const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QStringList filterAttributes(java.lang.@NonNull String filterName){
        return filterAttributes_native_cref_QString_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), filterName);
    }
    
    @QtUninvokable
    private native io.qt.core.QStringList filterAttributes_native_cref_QString_constfct(long __this__nativeId, java.lang.String filterName);
    
    /**
     * See QHelpEngineCore::filterEngine()const
     */
    @QtUninvokable
    public final io.qt.help.@Nullable QHelpFilterEngine filterEngine(){
        return filterEngine_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.help.QHelpFilterEngine filterEngine_native_constfct(long __this__nativeId);
    
    /**
     * See QHelpEngineCore::findFile(QUrl)const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QUrl findFile(io.qt.core.@NonNull QUrl url){
        return findFile_native_cref_QUrl_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(url));
    }
    
    @QtUninvokable
    private native io.qt.core.QUrl findFile_native_cref_QUrl_constfct(long __this__nativeId, long url);
    
    /**
     * See QHelpEngineCore::isReadOnly()const
     */
    @QtPropertyReader(name="readOnly")
    @QtUninvokable
    public final boolean isReadOnly(){
        return isReadOnly_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native boolean isReadOnly_native_constfct(long __this__nativeId);
    
    /**
     * See QHelpEngineCore::registerDocumentation(QString)
     */
    @QtUninvokable
    public final boolean registerDocumentation(java.lang.@NonNull String documentationFileName){
        return registerDocumentation_native_cref_QString(QtJambi_LibraryUtilities.internal.nativeId(this), documentationFileName);
    }
    
    @QtUninvokable
    private native boolean registerDocumentation_native_cref_QString(long __this__nativeId, java.lang.String documentationFileName);
    
    /**
     * See QHelpEngineCore::registeredDocumentations()const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QStringList registeredDocumentations(){
        return registeredDocumentations_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.core.QStringList registeredDocumentations_native_constfct(long __this__nativeId);
    
    /**
     * See QHelpEngineCore::removeCustomFilter(QString)
     */
    @QtUninvokable
    public final boolean removeCustomFilter(java.lang.@NonNull String filterName){
        return removeCustomFilter_native_cref_QString(QtJambi_LibraryUtilities.internal.nativeId(this), filterName);
    }
    
    @QtUninvokable
    private native boolean removeCustomFilter_native_cref_QString(long __this__nativeId, java.lang.String filterName);
    
    /**
     * See QHelpEngineCore::removeCustomValue(QString)
     */
    @QtUninvokable
    public final boolean removeCustomValue(java.lang.@NonNull String key){
        return removeCustomValue_native_cref_QString(QtJambi_LibraryUtilities.internal.nativeId(this), key);
    }
    
    @QtUninvokable
    private native boolean removeCustomValue_native_cref_QString(long __this__nativeId, java.lang.String key);
    
    /**
     * See QHelpEngineCore::setAutoSaveFilter(bool)
     */
    @QtPropertyWriter(name="autoSaveFilter")
    @QtUninvokable
    public final void setAutoSaveFilter(boolean save){
        setAutoSaveFilter_native_bool(QtJambi_LibraryUtilities.internal.nativeId(this), save);
    }
    
    @QtUninvokable
    private native void setAutoSaveFilter_native_bool(long __this__nativeId, boolean save);
    
    /**
     * See QHelpEngineCore::setCollectionFile(QString)
     */
    @QtPropertyWriter(name="collectionFile")
    @QtUninvokable
    public final void setCollectionFile(java.lang.@NonNull String fileName){
        setCollectionFile_native_cref_QString(QtJambi_LibraryUtilities.internal.nativeId(this), fileName);
    }
    
    @QtUninvokable
    private native void setCollectionFile_native_cref_QString(long __this__nativeId, java.lang.String fileName);
    
    /**
     * See QHelpEngineCore::setCurrentFilter(QString)
     */
    @QtPropertyWriter(name="currentFilter")
    @QtUninvokable
    public final void setCurrentFilter(java.lang.@NonNull String filterName){
        setCurrentFilter_native_cref_QString(QtJambi_LibraryUtilities.internal.nativeId(this), filterName);
    }
    
    @QtUninvokable
    private native void setCurrentFilter_native_cref_QString(long __this__nativeId, java.lang.String filterName);
    
    /**
     * See QHelpEngineCore::setCustomValue(QString,QVariant)
     */
    @QtUninvokable
    public final boolean setCustomValue(java.lang.@NonNull String key, java.lang.Object value){
        return setCustomValue_native_cref_QString_cref_QVariant(QtJambi_LibraryUtilities.internal.nativeId(this), key, value);
    }
    
    @QtUninvokable
    private native boolean setCustomValue_native_cref_QString_cref_QVariant(long __this__nativeId, java.lang.String key, java.lang.Object value);
    
    /**
     * See QHelpEngineCore::setReadOnly(bool)
     */
    @QtPropertyWriter(name="readOnly")
    @QtUninvokable
    public final void setReadOnly(boolean enable){
        setReadOnly_native_bool(QtJambi_LibraryUtilities.internal.nativeId(this), enable);
    }
    
    @QtUninvokable
    private native void setReadOnly_native_bool(long __this__nativeId, boolean enable);
    
    /**
     * See QHelpEngineCore::setUsesFilterEngine(bool)
     */
    @QtUninvokable
    public final void setUsesFilterEngine(boolean uses){
        setUsesFilterEngine_native_bool(QtJambi_LibraryUtilities.internal.nativeId(this), uses);
    }
    
    @QtUninvokable
    private native void setUsesFilterEngine_native_bool(long __this__nativeId, boolean uses);
    
    /**
     * See QHelpEngineCore::setupData()
     */
    @QtUninvokable
    public final boolean setupData(){
        return setupData_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native boolean setupData_native(long __this__nativeId);
    
    /**
     * See QHelpEngineCore::unregisterDocumentation(QString)
     */
    @QtUninvokable
    public final boolean unregisterDocumentation(java.lang.@NonNull String namespaceName){
        return unregisterDocumentation_native_cref_QString(QtJambi_LibraryUtilities.internal.nativeId(this), namespaceName);
    }
    
    @QtUninvokable
    private native boolean unregisterDocumentation_native_cref_QString(long __this__nativeId, java.lang.String namespaceName);
    
    /**
     * See QHelpEngineCore::usesFilterEngine()const
     */
    @QtUninvokable
    public final boolean usesFilterEngine(){
        return usesFilterEngine_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native boolean usesFilterEngine_native_constfct(long __this__nativeId);
    
    /**
     * See QHelpEngineCore::metaData(QString,QString)
     */
    public native static java.lang.Object metaData(java.lang.@NonNull String documentationFileName, java.lang.@NonNull String name);
    
    /**
     * See QHelpEngineCore::namespaceName(QString)
     */
    public native static java.lang.@NonNull String namespaceName(java.lang.@NonNull String documentationFileName);
    
    /**
     * Constructor for internal use only.
     * @param p expected to be null.
     * @hidden
     */
    @NativeAccess
    protected QHelpEngineCore(QPrivateConstructor p) { super(p); } 
    
    
    /**
     * Overloaded constructor for {@link #QHelpEngineCore(java.lang.String, io.qt.core.QObject)}
     *  with parent = null.
     */
    public QHelpEngineCore(java.lang.@NonNull String collectionFile) {
        this(collectionFile, (io.qt.core.QObject)null);
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #autoSaveFilter()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final boolean getAutoSaveFilter() {
        return autoSaveFilter();
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #collectionFile()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final java.lang.@NonNull String getCollectionFile() {
        return collectionFile();
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #currentFilter()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final java.lang.@NonNull String getCurrentFilter() {
        return currentFilter();
    }
    
    /**
     * Overloaded function for {@link #customValue(java.lang.String, java.lang.Object)}
     *  with defaultValue = null.
     */
    @QtUninvokable
    public final java.lang.Object customValue(java.lang.@NonNull String key) {
        return customValue(key, (java.lang.Object)null);
    }
    
    /**
     * Overloaded function for {@link #fileData(io.qt.core.QUrl)}.
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QByteArray fileData(java.lang.@NonNull String url) {
        return fileData(new io.qt.core.QUrl(url));
    }
    
    /**
     * Overloaded function for {@link #files(java.lang.String, java.lang.String, java.lang.String)}
     *  with extensionFilter = (String)null.
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QList files(java.lang.@NonNull String namespaceName, java.lang.@NonNull String filterName) {
        return files(namespaceName, filterName, (String)null);
    }
    
    /**
     * Overloaded function for {@link #files(java.lang.String, java.util.Collection, java.lang.String)}
     *  with extensionFilter = (String)null.
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QList files(java.lang.@NonNull String namespaceName, java.util.@NonNull Collection filterAttributes) {
        return files(namespaceName, filterAttributes, (String)null);
    }
    
    /**
     * Overloaded function for {@link #findFile(io.qt.core.QUrl)}.
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QUrl findFile(java.lang.@NonNull String url) {
        return findFile(new io.qt.core.QUrl(url));
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #isReadOnly()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final boolean getReadOnly() {
        return isReadOnly();
    }
}