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:

io.qt.QtObjectInterface, io.qt.QtSignalBlockerInterface, io.qt.QtSignalEmitterInterface, io.qt.QtThreadAffineInterface

Direct Known Subclasses:

QHelpEngine

public class QHelpEngineCore
extends io.qt.core.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

io.qt.core.QObject.MultiSignal, io.qt.core.QObject.PrivateSignal0, io.qt.core.QObject.PrivateSignal1<A>, io.qt.core.QObject.PrivateSignal2<A,B>, io.qt.core.QObject.PrivateSignal3<A,B,C>, io.qt.core.QObject.PrivateSignal4<A,B,C,D>, io.qt.core.QObject.PrivateSignal5<A,B,C,D,E>, io.qt.core.QObject.PrivateSignal6<A,B,C,D,E,F>, io.qt.core.QObject.PrivateSignal7<A,B,C,D,E,F,G>, io.qt.core.QObject.PrivateSignal8<A,B,C,D,E,F,G,H>, io.qt.core.QObject.PrivateSignal9<A,B,C,D,E,F,G,H,I>, io.qt.core.QObject.QBooleanProperty, io.qt.core.QObject.QByteProperty, io.qt.core.QObject.QCharProperty, io.qt.core.QObject.QComputedBooleanProperty, io.qt.core.QObject.QComputedByteProperty, io.qt.core.QObject.QComputedCharProperty, io.qt.core.QObject.QComputedDoubleProperty, io.qt.core.QObject.QComputedFloatProperty, io.qt.core.QObject.QComputedIntProperty, io.qt.core.QObject.QComputedLongProperty, io.qt.core.QObject.QComputedProperty<T>, io.qt.core.QObject.QComputedShortProperty, io.qt.core.QObject.QDeclarativeConstructor, io.qt.core.QObject.QDoubleProperty, io.qt.core.QObject.QFloatProperty, io.qt.core.QObject.QIntProperty, io.qt.core.QObject.QLongProperty, io.qt.core.QObject.QProperty<T>, io.qt.core.QObject.QShortProperty, io.qt.core.QObject.Signal0, io.qt.core.QObject.Signal1<A>, io.qt.core.QObject.Signal1Default1<A>, io.qt.core.QObject.Signal2<A,B>, io.qt.core.QObject.Signal2Default1<A,B>, io.qt.core.QObject.Signal2Default2<A,B>, io.qt.core.QObject.Signal3<A,B,C>, io.qt.core.QObject.Signal3Default1<A,B,C>, io.qt.core.QObject.Signal3Default2<A,B,C>, io.qt.core.QObject.Signal3Default3<A,B,C>, io.qt.core.QObject.Signal4<A,B,C,D>, io.qt.core.QObject.Signal4Default1<A,B,C,D>, io.qt.core.QObject.Signal4Default2<A,B,C,D>, io.qt.core.QObject.Signal4Default3<A,B,C,D>, io.qt.core.QObject.Signal4Default4<A,B,C,D>, io.qt.core.QObject.Signal5<A,B,C,D,E>, io.qt.core.QObject.Signal5Default1<A,B,C,D,E>, io.qt.core.QObject.Signal5Default2<A,B,C,D,E>, io.qt.core.QObject.Signal5Default3<A,B,C,D,E>, io.qt.core.QObject.Signal5Default4<A,B,C,D,E>, io.qt.core.QObject.Signal5Default5<A,B,C,D,E>, io.qt.core.QObject.Signal6<A,B,C,D,E,F>, io.qt.core.QObject.Signal6Default1<A,B,C,D,E,F>, io.qt.core.QObject.Signal6Default2<A,B,C,D,E,F>, io.qt.core.QObject.Signal6Default3<A,B,C,D,E,F>, io.qt.core.QObject.Signal6Default4<A,B,C,D,E,F>, io.qt.core.QObject.Signal6Default5<A,B,C,D,E,F>, io.qt.core.QObject.Signal6Default6<A,B,C,D,E,F>, io.qt.core.QObject.Signal7<A,B,C,D,E,F,G>, io.qt.core.QObject.Signal7Default1<A,B,C,D,E,F,G>, io.qt.core.QObject.Signal7Default2<A,B,C,D,E,F,G>, io.qt.core.QObject.Signal7Default3<A,B,C,D,E,F,G>, io.qt.core.QObject.Signal7Default4<A,B,C,D,E,F,G>, io.qt.core.QObject.Signal7Default5<A,B,C,D,E,F,G>, io.qt.core.QObject.Signal7Default6<A,B,C,D,E,F,G>, io.qt.core.QObject.Signal7Default7<A,B,C,D,E,F,G>, io.qt.core.QObject.Signal8<A,B,C,D,E,F,G,H>, io.qt.core.QObject.Signal8Default1<A,B,C,D,E,F,G,H>, io.qt.core.QObject.Signal8Default2<A,B,C,D,E,F,G,H>, io.qt.core.QObject.Signal8Default3<A,B,C,D,E,F,G,H>, io.qt.core.QObject.Signal8Default4<A,B,C,D,E,F,G,H>, io.qt.core.QObject.Signal8Default5<A,B,C,D,E,F,G,H>, io.qt.core.QObject.Signal8Default6<A,B,C,D,E,F,G,H>, io.qt.core.QObject.Signal8Default7<A,B,C,D,E,F,G,H>, io.qt.core.QObject.Signal8Default8<A,B,C,D,E,F,G,H>, io.qt.core.QObject.Signal9<A,B,C,D,E,F,G,H,I>, io.qt.core.QObject.Signal9Default1<A,B,C,D,E,F,G,H,I>, io.qt.core.QObject.Signal9Default2<A,B,C,D,E,F,G,H,I>, io.qt.core.QObject.Signal9Default3<A,B,C,D,E,F,G,H,I>, io.qt.core.QObject.Signal9Default4<A,B,C,D,E,F,G,H,I>, io.qt.core.QObject.Signal9Default5<A,B,C,D,E,F,G,H,I>, io.qt.core.QObject.Signal9Default6<A,B,C,D,E,F,G,H,I>, io.qt.core.QObject.Signal9Default7<A,B,C,D,E,F,G,H,I>, io.qt.core.QObject.Signal9Default8<A,B,C,D,E,F,G,H,I>, io.qt.core.QObject.Signal9Default9<A,B,C,D,E,F,G,H,I>

Nested classes/interfaces inherited from class io.qt.QtObject

io.qt.QtObject.QPrivateConstructor

Field Summary

Fields

Modifier and Type	Field	Description
final io.qt.core.QObject.Signal1<String>	currentFilterChanged
final io.qt.core.QObject.Signal0	readersAboutToBeInvalidated
final io.qt.core.QObject.Signal0	setupFinished	See QHelpEngineCore::setupFinished()
final io.qt.core.QObject.Signal0	setupStarted	See QHelpEngineCore::setupStarted()
static final io.qt.core.QMetaObject	staticMetaObject	This variable stores the meta-object for the class.
final io.qt.core.QObject.Signal1<String>	warning	See QHelpEngineCore::warning(QString)

Fields inherited from class io.qt.core.QObject

destroyed, objectNameChanged

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	QHelpEngineCore(io.qt.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, io.qt.core.QObject parent)	See QHelpEngineCore::QHelpEngineCore(QString,QObject*)

Method Summary

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

Methods inherited from class io.qt.core.QObject

bindableObjectName, 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, 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, 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, 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 io.qt.core.QMetaObject staticMetaObject

This variable stores the meta-object for the class.

currentFilterChanged

public final io.qt.core.QObject.Signal1<String> currentFilterChanged

readersAboutToBeInvalidated

public final io.qt.core.QObject.Signal0 readersAboutToBeInvalidated

setupFinished

public final io.qt.core.QObject.Signal0 setupFinished

See QHelpEngineCore::setupFinished()

setupStarted

public final io.qt.core.QObject.Signal0 setupStarted

See QHelpEngineCore::setupStarted()

warning

public final io.qt.core.QObject.Signal1<String> warning

See QHelpEngineCore::warning(QString)

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,
 io.qt.core.QObject parent)

See QHelpEngineCore::QHelpEngineCore(QString,QObject*)

QHelpEngineCore

protected QHelpEngineCore(io.qt.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)

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(QString)

currentFilter

@QtUninvokable
public final String currentFilter()

See QHelpEngineCore::currentFilter()const

customFilters

@QtUninvokable
public final io.qt.core.QStringList customFilters()

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(QString,QVariant)const

documentationFileName

@QtUninvokable
public final String documentationFileName(String namespaceName)

See QHelpEngineCore::documentationFileName(QString)

documentsForIdentifier

@QtUninvokable
public final io.qt.core.QList<QHelpLink> documentsForIdentifier(String id)

See QHelpEngineCore::documentsForIdentifier(QString)const

documentsForIdentifier

@QtUninvokable
public final io.qt.core.QList<QHelpLink> documentsForIdentifier(String id,
 String filterName)

See QHelpEngineCore::documentsForIdentifier(QString,QString)const

documentsForKeyword

@QtUninvokable
public final io.qt.core.QList<QHelpLink> documentsForKeyword(String keyword)

See QHelpEngineCore::documentsForKeyword(QString)const

documentsForKeyword

@QtUninvokable
public final io.qt.core.QList<QHelpLink> documentsForKeyword(String keyword,
 String filterName)

See QHelpEngineCore::documentsForKeyword(QString,QString)const

error

@QtUninvokable
public final String error()

See QHelpEngineCore::error()const

fileData

@QtUninvokable
public final io.qt.core.QByteArray fileData(io.qt.core.QUrl url)

See QHelpEngineCore::fileData(QUrl)const

files

@QtUninvokable
public final io.qt.core.QList<io.qt.core.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 io.qt.core.QList<io.qt.core.QUrl> files(String namespaceName,
 String filterName,
 String extensionFilter)

See QHelpEngineCore::files(QString,QString,QString)

files

@QtUninvokable
public final io.qt.core.QList<io.qt.core.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 io.qt.core.QList<io.qt.core.QUrl> files(String namespaceName,
 Collection<String> filterAttributes,
 String extensionFilter)

See QHelpEngineCore::files(QString,QStringList,QString)

filterAttributeSets

@QtUninvokable
public final io.qt.core.QList<List<String>> filterAttributeSets(String namespaceName)

filterAttributes

@QtUninvokable
public final io.qt.core.QStringList filterAttributes()

filterAttributes

@QtUninvokable
public final io.qt.core.QStringList filterAttributes(String filterName)

filterEngine

@QtUninvokable
public final QHelpFilterEngine filterEngine()

See QHelpEngineCore::filterEngine()const

findFile

@QtUninvokable
public final io.qt.core.QUrl findFile(io.qt.core.QUrl url)

See QHelpEngineCore::findFile(QUrl)const

isReadOnly

@QtUninvokable
public final boolean isReadOnly()

See QHelpEngineCore::isReadOnly()const

registerDocumentation

@QtUninvokable
public final boolean registerDocumentation(String documentationFileName)

See QHelpEngineCore::registerDocumentation(QString)

registeredDocumentations

@QtUninvokable
public final io.qt.core.QStringList registeredDocumentations()

See QHelpEngineCore::registeredDocumentations()const

removeCustomFilter

@QtUninvokable
public final boolean removeCustomFilter(String filterName)

removeCustomValue

@QtUninvokable
public final boolean removeCustomValue(String key)

See QHelpEngineCore::removeCustomValue(QString)

setAutoSaveFilter

@QtUninvokable
public final void setAutoSaveFilter(boolean save)

See QHelpEngineCore::setAutoSaveFilter(bool)

setCollectionFile

@QtUninvokable
public final void setCollectionFile(String fileName)

See QHelpEngineCore::setCollectionFile(QString)

setCurrentFilter

@QtUninvokable
public final void setCurrentFilter(String filterName)

See QHelpEngineCore::setCurrentFilter(QString)

setCustomValue

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

See QHelpEngineCore::setCustomValue(QString,QVariant)

setReadOnly

@QtUninvokable
public final void setReadOnly(boolean enable)

See QHelpEngineCore::setReadOnly(bool)

setUsesFilterEngine

@QtUninvokable
public final void setUsesFilterEngine(boolean uses)

See QHelpEngineCore::setUsesFilterEngine(bool)

setupData

@QtUninvokable
public final boolean setupData()

See QHelpEngineCore::setupData()

unregisterDocumentation

@QtUninvokable
public final boolean unregisterDocumentation(String namespaceName)

See QHelpEngineCore::unregisterDocumentation(QString)

usesFilterEngine

@QtUninvokable
public final boolean usesFilterEngine()

See QHelpEngineCore::usesFilterEngine()const

metaData

public static Object metaData(String documentationFileName,
 String name)

See QHelpEngineCore::metaData(QString,QString)

namespaceName

public static String namespaceName(String documentationFileName)

See QHelpEngineCore::namespaceName(QString)