#include <qhelpcollectionhandler_p.h>

Inheritance diagram for QHelpCollectionHandler:

Collaboration diagram for QHelpCollectionHandler:

Classes
struct	ContentsData
struct	FileInfo
struct	TimeStamp

Public Types
typedef QList< FileInfo >	FileInfoList

Signals
void	error (const QString &msg)
Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QHelpCollectionHandler (const QString &collectionFile, QObject *parent=nullptr)
	~QHelpCollectionHandler ()
QString	collectionFile () const
bool	openCollectionFile ()
bool	copyCollectionFile (const QString &fileName)
QStringList	customFilters () const
bool	removeCustomFilter (const QString &filterName)
bool	addCustomFilter (const QString &filterName, const QStringList &attributes)
QStringList	files (const QString &namespaceName, const QStringList &filterAttributes, const QString &extensionFilter) const
QString	namespaceForFile (const QUrl &url, const QStringList &filterAttributes) const
QUrl	findFile (const QUrl &url, const QStringList &filterAttributes) const
QStringList	indicesForFilter (const QStringList &filterAttributes) const
QList< ContentsData >	contentsForFilter (const QStringList &filterAttributes) const
QStringList	filterAttributes () const
QStringList	filterAttributes (const QString &filterName) const
QList< QStringList >	filterAttributeSets (const QString &namespaceName) const
QStringList	filters () const
QStringList	availableComponents () const
QList< QVersionNumber >	availableVersions () const
QMap< QString, QString >	namespaceToComponent () const
QMap< QString, QVersionNumber >	namespaceToVersion () const
QHelpFilterData	filterData (const QString &filterName) const
bool	setFilterData (const QString &filterName, const QHelpFilterData &filterData)
bool	removeFilter (const QString &filterName)
FileInfo	registeredDocumentation (const QString &namespaceName) const
FileInfoList	registeredDocumentations () const
bool	registerDocumentation (const QString &fileName)
bool	unregisterDocumentation (const QString &namespaceName)
bool	fileExists (const QUrl &url) const
QStringList	files (const QString &namespaceName, const QString &filterName, const QString &extensionFilter) const
QString	namespaceForFile (const QUrl &url, const QString &filterName) const
QUrl	findFile (const QUrl &url, const QString &filterName) const
QByteArray	fileData (const QUrl &url) const
QStringList	indicesForFilter (const QString &filterName) const
QList< ContentsData >	contentsForFilter (const QString &filterName) const
bool	removeCustomValue (const QString &key)
QVariant	customValue (const QString &key, const QVariant &defaultValue) const
bool	setCustomValue (const QString &key, const QVariant &value)
int	registerNamespace (const QString &nspace, const QString &fileName)
int	registerVirtualFolder (const QString &folderName, int namespaceId)
int	registerComponent (const QString &componentName, int namespaceId)
bool	registerVersion (const QString &version, int namespaceId)
QList< QHelpLink >	documentsForIdentifier (const QString &id, const QString &filterName) const
QList< QHelpLink >	documentsForKeyword (const QString &keyword, const QString &filterName) const
QList< QHelpLink >	documentsForIdentifier (const QString &id, const QStringList &filterAttributes) const
QList< QHelpLink >	documentsForKeyword (const QString &keyword, const QStringList &filterAttributes) const
QStringList	namespacesForFilter (const QString &filterName) const
void	setReadOnly (bool readOnly)
Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.
virtual	~QObject ()
	Destroys the object, deleting all its child objects.
virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.
QString	objectName () const
Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.
void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString >	bindableObjectName ()
bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.
bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.
bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.
bool	isQmlObjectType () const
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.
bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread *	thread () const
	Returns the thread in which the object lives.
bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.
int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
	Kills the timer with timer identifier, id.
void	killTimer (Qt::TimerId id)
template<typename T>
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList &	children () const
	Returns a list of child objects.
void	setParent (QObject *parent)
	Makes the object a child of parent.
void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.
void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.
QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const
bool	disconnect (const QObject receiver, const char member=nullptr) const
void	dumpObjectTree () const
	Dumps a tree of children to the debug output.
void	dumpObjectInfo () const
	Dumps information about signal connections, etc.
bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.
bool	setProperty (const char *name, QVariant &&value)
QVariant	property (const char *name) const
	Returns the value of the object's name property.
QList< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () const
	Returns a pointer to the parent object.
bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Static Public Member Functions
static QUrl	buildQUrl (const QString &ns, const QString &folder, const QString &relFileName, const QString &anchor)
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe
static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe
static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)
static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.
template<typename Func1, typename Func2>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)
template<typename Func1>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int	senderSignalIndex () const
int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.
bool	isSignalConnected (const QMetaMethod &signal) const
virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.
virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	disconnectNotify (const QMetaMethod &signal)
	QObject (QObjectPrivate &dd, QObject *parent=nullptr)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Properties inherited from QObject
QString	objectName
	the name of this object
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 32 of file qhelpcollectionhandler_p.h.

Member Typedef Documentation

◆ FileInfoList

typedef QList<FileInfo> QHelpCollectionHandler::FileInfoList

Definition at line 43 of file qhelpcollectionhandler_p.h.

Constructor & Destructor Documentation

◆ QHelpCollectionHandler()

QHelpCollectionHandler::QHelpCollectionHandler	(	const QString &	collectionFile,
		QObject *	parent = nullptr )

explicit

Definition at line 58 of file qhelpcollectionhandler.cpp.

◆ ~QHelpCollectionHandler()

QHelpCollectionHandler::~QHelpCollectionHandler ( )

Definition at line 67 of file qhelpcollectionhandler.cpp.

Member Function Documentation

◆ addCustomFilter()

bool QHelpCollectionHandler::addCustomFilter	(	const QString &	filterName,
		const QStringList &	attributes )

Definition at line 721 of file qhelpcollectionhandler.cpp.

◆ availableComponents()

QStringList QHelpCollectionHandler::availableComponents ( ) const

Definition at line 526 of file qhelpcollectionhandler.cpp.

◆ availableVersions()

QList< QVersionNumber > QHelpCollectionHandler::availableVersions ( ) const

Definition at line 537 of file qhelpcollectionhandler.cpp.

◆ buildQUrl()

QUrl QHelpCollectionHandler::buildQUrl	(	const QString &	ns,
		const QString &	folder,
		const QString &	relFileName,
		const QString &	anchor )

static

Definition at line 2209 of file qhelpcollectionhandler.cpp.

◆ collectionFile()

QString QHelpCollectionHandler::collectionFile ( ) const

inline

Definition at line 64 of file qhelpcollectionhandler_p.h.

◆ contentsForFilter() [1/2]

QList< QHelpCollectionHandler::ContentsData > QHelpCollectionHandler::contentsForFilter ( const QString & filterName ) const

Definition at line 1480 of file qhelpcollectionhandler.cpp.

◆ contentsForFilter() [2/2]

QList< QHelpCollectionHandler::ContentsData > QHelpCollectionHandler::contentsForFilter ( const QStringList & filterAttributes ) const

Definition at line 1420 of file qhelpcollectionhandler.cpp.

◆ copyCollectionFile()

bool QHelpCollectionHandler::copyCollectionFile ( const QString & fileName )

Definition at line 296 of file qhelpcollectionhandler.cpp.

◆ customFilters()

QStringList QHelpCollectionHandler::customFilters ( ) const

Definition at line 504 of file qhelpcollectionhandler.cpp.

◆ customValue()

QVariant QHelpCollectionHandler::customValue	(	const QString &	key,
		const QVariant &	defaultValue ) const

Definition at line 1547 of file qhelpcollectionhandler.cpp.

◆ documentsForIdentifier() [1/2]

QList< QHelpLink > QHelpCollectionHandler::documentsForIdentifier	(	const QString &	id,
		const QString &	filterName ) const

Definition at line 2280 of file qhelpcollectionhandler.cpp.

◆ documentsForIdentifier() [2/2]

QList< QHelpLink > QHelpCollectionHandler::documentsForIdentifier	(	const QString &	id,
		const QStringList &	filterAttributes ) const

Definition at line 2220 of file qhelpcollectionhandler.cpp.

◆ documentsForKeyword() [1/2]

QList< QHelpLink > QHelpCollectionHandler::documentsForKeyword	(	const QString &	keyword,
		const QString &	filterName ) const

Definition at line 2286 of file qhelpcollectionhandler.cpp.

◆ documentsForKeyword() [2/2]

QList< QHelpLink > QHelpCollectionHandler::documentsForKeyword	(	const QString &	keyword,
		const QStringList &	filterAttributes ) const

Definition at line 2226 of file qhelpcollectionhandler.cpp.

◆ error

void QHelpCollectionHandler::error ( const QString & msg )

signal

◆ fileData()

QByteArray QHelpCollectionHandler::fileData ( const QUrl & url ) const

Definition at line 1311 of file qhelpcollectionhandler.cpp.

References QHelpDBReader::init().

Here is the call graph for this function:

◆ fileExists()

bool QHelpCollectionHandler::fileExists ( const QUrl & url ) const

Definition at line 941 of file qhelpcollectionhandler.cpp.

◆ files() [1/2]

QStringList QHelpCollectionHandler::files	(	const QString &	namespaceName,
		const QString &	filterName,
		const QString &	extensionFilter ) const

Definition at line 1240 of file qhelpcollectionhandler.cpp.

◆ files() [2/2]

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