Module qtjambi.help

Package io.qt.help

Class QHelpEngineCore

java.lang.Object

io.qt.internal.QtJambiObject

io.qt.QtObject

io.qt.core.QObject

io.qt.help.QHelpEngineCore

All Implemented Interfaces:

QtObjectInterface, QtSignalBlockerInterface, QtSignalEmitterInterface, QtThreadAffineInterface

Direct Known Subclasses:

QHelpEngine

public class QHelpEngineCore
extends QObject

The core functionality of the help system

Java wrapper for Qt class QHelpEngineCore

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.Signal1<String>	currentFilterChanged	See QHelpEngineCore::currentFilterChanged(const QString & newFilter)
QObject.Signal0	readersAboutToBeInvalidated	See QHelpEngineCore::readersAboutToBeInvalidated()
QObject.Signal0	setupFinished	See QHelpEngineCore::setupFinished()
QObject.Signal0	setupStarted	See QHelpEngineCore::setupStarted()
static QMetaObject	staticMetaObject	This variable stores the meta-object for the class.
QObject.Signal1<String>	warning	See QHelpEngineCore::warning(const QString & msg)

Fields inherited from class io.qt.core.QObject

destroyed, objectNameChanged

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	QHelpEngineCore(QtObject.QPrivateConstructor p)	Constructor for internal use only.
	QHelpEngineCore(String collectionFile)	Overloaded constructor for QHelpEngineCore(java.lang.String, io.qt.core.QObject) with parent = null.
	QHelpEngineCore(String collectionFile, QObject parent)	See QHelpEngineCore::QHelpEngineCore(const QString & collectionFile, QObject * parent)

Method Summary

Modifier and Type	Method	Description
boolean	addCustomFilter(String filterName, Collection<String> attributes)	See QHelpEngineCore::addCustomFilter(const QString & filterName, const QStringList & attributes)
boolean	autoSaveFilter()	See QHelpEngineCore::autoSaveFilter() const
String	collectionFile()	See QHelpEngineCore::collectionFile() const
boolean	copyCollectionFile(String fileName)	See QHelpEngineCore::copyCollectionFile(const QString & fileName)
String	currentFilter()	See QHelpEngineCore::currentFilter() const
List<String>	customFilters()	See QHelpEngineCore::customFilters() const
Object	customValue(String key)	Overloaded function for customValue(java.lang.String, java.lang.Object) with defaultValue = null.
Object	customValue(String key, Object defaultValue)	See QHelpEngineCore::customValue(const QString & key, const QVariant & defaultValue) const
String	documentationFileName(String namespaceName)	See QHelpEngineCore::documentationFileName(const QString & namespaceName)
List<QHelpLink>	documentsForIdentifier(String id)	See QHelpEngineCore::documentsForIdentifier(const QString & id) const
List<QHelpLink>	documentsForIdentifier(String id, String filterName)	See QHelpEngineCore::documentsForIdentifier(const QString & id, const QString & filterName) const
List<QHelpLink>	documentsForKeyword(String keyword)	See QHelpEngineCore::documentsForKeyword(const QString & keyword) const
List<QHelpLink>	documentsForKeyword(String keyword, String filterName)	See QHelpEngineCore::documentsForKeyword(const QString & keyword, const QString & filterName) const
String	error()	See QHelpEngineCore::error() const
QByteArray	fileData(QUrl url)	See QHelpEngineCore::fileData(const QUrl & url) const
List<QUrl>	files(String namespaceName, String filterName)	Overloaded function for files(java.lang.String, java.lang.String, java.lang.String) with extensionFilter = "".
List<QUrl>	files(String namespaceName, String filterName, String extensionFilter)	See QHelpEngineCore::files(const QString namespaceName, const QString & filterName, const QString & extensionFilter)
List<QUrl>	files(String namespaceName, Collection<String> filterAttributes)	Overloaded function for files(java.lang.String, java.util.Collection, java.lang.String) with extensionFilter = "".
List<QUrl>	files(String namespaceName, Collection<String> filterAttributes, String extensionFilter)	See QHelpEngineCore::files(const QString namespaceName, const QStringList & filterAttributes, const QString & extensionFilter)
List<String>	filterAttributes()	See QHelpEngineCore::filterAttributes() const
List<String>	filterAttributes(String filterName)	See QHelpEngineCore::filterAttributes(const QString & filterName) const
List<List<String>>	filterAttributeSets(String namespaceName)	See QHelpEngineCore::filterAttributeSets(const QString & namespaceName) const
QHelpFilterEngine	filterEngine()	See QHelpEngineCore::filterEngine() const
QUrl	findFile(QUrl url)	See QHelpEngineCore::findFile(const QUrl & url) const
NavigableMap<String,QUrl>	linksForIdentifier(String id)	Deprecated. Use documentsForIdentifier(java.lang.String) instead
NavigableMap<String,QUrl>	linksForKeyword(String keyword)	Deprecated. Use documentsForKeyword(java.lang.String) instead
static Object	metaData(String documentationFileName, String name)	See QHelpEngineCore::metaData(const QString & documentationFileName, const QString & name)
static String	namespaceName(String documentationFileName)	See QHelpEngineCore::namespaceName(const QString & documentationFileName)
boolean	registerDocumentation(String documentationFileName)	See QHelpEngineCore::registerDocumentation(const QString & documentationFileName)
List<String>	registeredDocumentations()	See QHelpEngineCore::registeredDocumentations() const
boolean	removeCustomFilter(String filterName)	See QHelpEngineCore::removeCustomFilter(const QString & filterName)
boolean	removeCustomValue(String key)	See QHelpEngineCore::removeCustomValue(const QString & key)
void	setAutoSaveFilter(boolean save)	See QHelpEngineCore::setAutoSaveFilter(bool save)
void	setCollectionFile(String fileName)	See QHelpEngineCore::setCollectionFile(const QString & fileName)
void	setCurrentFilter(String filterName)	See QHelpEngineCore::setCurrentFilter(const QString & filterName)
boolean	setCustomValue(String key, Object value)	See QHelpEngineCore::setCustomValue(const QString & key, const QVariant & value)
boolean	setupData()	See QHelpEngineCore::setupData()
void	setUsesFilterEngine(boolean uses)	See QHelpEngineCore::setUsesFilterEngine(bool uses)
boolean	unregisterDocumentation(String namespaceName)	See QHelpEngineCore::unregisterDocumentation(const QString & namespaceName)
boolean	usesFilterEngine()	See QHelpEngineCore::usesFilterEngine() 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.

currentFilterChanged

public final QObject.Signal1<String> currentFilterChanged

See QHelpEngineCore::currentFilterChanged(const QString & newFilter)

readersAboutToBeInvalidated

public final QObject.Signal0 readersAboutToBeInvalidated

See QHelpEngineCore::readersAboutToBeInvalidated()

setupFinished

public final QObject.Signal0 setupFinished

See QHelpEngineCore::setupFinished()

setupStarted

public final QObject.Signal0 setupStarted

See QHelpEngineCore::setupStarted()

warning

public final QObject.Signal1<String> warning

See QHelpEngineCore::warning(const QString & msg)

Constructor Details

QHelpEngineCore

public QHelpEngineCore(String collectionFile)

Overloaded constructor for QHelpEngineCore(java.lang.String, io.qt.core.QObject) with parent = null.

QHelpEngineCore

public QHelpEngineCore(String collectionFile, QObject parent)

See QHelpEngineCore::QHelpEngineCore(const QString & collectionFile, QObject * parent)

QHelpEngineCore

protected QHelpEngineCore(QtObject.QPrivateConstructor p)

Constructor for internal use only.

Parameters:

p - expected to be null.

Method Details

addCustomFilter

@QtUninvokable public final boolean addCustomFilter(String filterName, Collection<String> attributes)

See QHelpEngineCore::addCustomFilter(const QString & filterName, const QStringList & attributes)

autoSaveFilter

@QtUninvokable public final boolean autoSaveFilter()

See QHelpEngineCore::autoSaveFilter() const

collectionFile

@QtUninvokable public final String collectionFile()

See QHelpEngineCore::collectionFile() const

copyCollectionFile

@QtUninvokable public final boolean copyCollectionFile(String fileName)

See QHelpEngineCore::copyCollectionFile(const QString & fileName)

currentFilter

@QtUninvokable public final String currentFilter()

See QHelpEngineCore::currentFilter() const

customFilters

@QtUninvokable public final List<String> customFilters()

See QHelpEngineCore::customFilters() const

customValue

@QtUninvokable public final Object customValue(String key)

Overloaded function for customValue(java.lang.String, java.lang.Object) with defaultValue = null.

customValue

@QtUninvokable public final Object customValue(String key, Object defaultValue)

See QHelpEngineCore::customValue(const QString & key, const QVariant & defaultValue) const

documentationFileName

@QtUninvokable public final String documentationFileName(String namespaceName)

See QHelpEngineCore::documentationFileName(const QString & namespaceName)

documentsForIdentifier

@QtUninvokable public final List<QHelpLink> documentsForIdentifier(String id)

See QHelpEngineCore::documentsForIdentifier(const QString & id) const

documentsForIdentifier

@QtUninvokable public final List<QHelpLink> documentsForIdentifier(String id, String filterName)

See QHelpEngineCore::documentsForIdentifier(const QString & id, const QString & filterName) const

documentsForKeyword

@QtUninvokable public final List<QHelpLink> documentsForKeyword(String keyword)

See QHelpEngineCore::documentsForKeyword(const QString & keyword) const

documentsForKeyword

@QtUninvokable public final List<QHelpLink> documentsForKeyword(String keyword, String filterName)

See QHelpEngineCore::documentsForKeyword(const QString & keyword, const QString & filterName) const

error

@QtUninvokable public final String error()

See QHelpEngineCore::error() const

fileData

@QtUninvokable public final QByteArray fileData(QUrl url)

See QHelpEngineCore::fileData(const QUrl & url) const

files

@QtUninvokable public final List<QUrl> files(String namespaceName, String filterName)

Overloaded function for files(java.lang.String, java.lang.String, java.lang.String) with extensionFilter = "".

files

@QtUninvokable public final List<QUrl> files(String namespaceName, String filterName, String extensionFilter)

See QHelpEngineCore::files(const QString namespaceName, const QString & filterName, const QString & extensionFilter)

files

@QtUninvokable public final List<QUrl> files(String namespaceName, Collection<String> filterAttributes)

Overloaded function for files(java.lang.String, java.util.Collection, java.lang.String) with extensionFilter = "".

files

@QtUninvokable public final List<QUrl> files(String namespaceName, Collection<String> filterAttributes, String extensionFilter)

See QHelpEngineCore::files(const QString namespaceName, const QStringList & filterAttributes, const QString & extensionFilter)

filterAttributeSets

@QtUninvokable public final List<List<String>> filterAttributeSets(String namespaceName)

See QHelpEngineCore::filterAttributeSets(const QString & namespaceName) const

filterAttributes

@QtUninvokable public final List<String> filterAttributes()

See QHelpEngineCore::filterAttributes() const

filterAttributes

@QtUninvokable public final List<String> filterAttributes(String filterName)

See QHelpEngineCore::filterAttributes(const QString & filterName) const

filterEngine

@QtUninvokable public final QHelpFilterEngine filterEngine()

See QHelpEngineCore::filterEngine() const

findFile

@QtUninvokable public final QUrl findFile(QUrl url)

See QHelpEngineCore::findFile(const QUrl & url) const

linksForIdentifier

@Deprecated @QtUninvokable public final NavigableMap<String,QUrl> linksForIdentifier(String id)

Deprecated.

Use documentsForIdentifier(java.lang.String) instead

See QHelpEngineCore::linksForIdentifier(const QString & id) const

linksForKeyword

@Deprecated @QtUninvokable public final NavigableMap<String,QUrl> linksForKeyword(String keyword)

Deprecated.

Use documentsForKeyword(java.lang.String) instead

See QHelpEngineCore::linksForKeyword(const QString & keyword) const

registerDocumentation

@QtUninvokable public final boolean registerDocumentation(String documentationFileName)

See QHelpEngineCore::registerDocumentation(const QString & documentationFileName)

registeredDocumentations

@QtUninvokable public final List<String> registeredDocumentations()

See QHelpEngineCore::registeredDocumentations() const

removeCustomFilter

@QtUninvokable public final boolean removeCustomFilter(String filterName)

See QHelpEngineCore::removeCustomFilter(const QString & filterName)

removeCustomValue

@QtUninvokable public final boolean removeCustomValue(String key)

See QHelpEngineCore::removeCustomValue(const QString & key)

setAutoSaveFilter

@QtUninvokable public final void setAutoSaveFilter(boolean save)

See QHelpEngineCore::setAutoSaveFilter(bool save)

setCollectionFile

@QtUninvokable public final void setCollectionFile(String fileName)

See QHelpEngineCore::setCollectionFile(const QString & fileName)

setCurrentFilter

@QtUninvokable public final void setCurrentFilter(String filterName)

See QHelpEngineCore::setCurrentFilter(const QString & filterName)

setCustomValue

@QtUninvokable public final boolean setCustomValue(String key, Object value)

See QHelpEngineCore::setCustomValue(const QString & key, const QVariant & value)

setUsesFilterEngine

@QtUninvokable public final void setUsesFilterEngine(boolean uses)

See QHelpEngineCore::setUsesFilterEngine(bool uses)

setupData

@QtUninvokable public final boolean setupData()

See QHelpEngineCore::setupData()

unregisterDocumentation

@QtUninvokable public final boolean unregisterDocumentation(String namespaceName)

See QHelpEngineCore::unregisterDocumentation(const QString & namespaceName)

usesFilterEngine

@QtUninvokable public final boolean usesFilterEngine()

See QHelpEngineCore::usesFilterEngine() const

metaData

public static Object metaData(String documentationFileName, String name)

See QHelpEngineCore::metaData(const QString & documentationFileName, const QString & name)

namespaceName

public static String namespaceName(String documentationFileName)

See QHelpEngineCore::namespaceName(const QString & documentationFileName)