Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qhelpfilterdata.h
Go to the documentation of this file.
1// Copyright (C) 2018 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3
4#ifndef QHELPFILTERDATA_H
5#define QHELPFILTERDATA_H
6
7#include <QtHelp/qhelp_global.h>
8
9#include <QtCore/qshareddata.h>
10
12
13class QVersionNumber;
15
16class QHELP_EXPORT QHelpFilterData final
17{
18public:
19 QHelpFilterData();
20 QHelpFilterData(const QHelpFilterData &other);
21 QHelpFilterData(QHelpFilterData &&other);
22 ~QHelpFilterData();
23
24 QHelpFilterData &operator=(const QHelpFilterData &other);
25 QHelpFilterData &operator=(QHelpFilterData &&other);
26 bool operator==(const QHelpFilterData &other) const;
27
28 void swap(QHelpFilterData &other) Q_DECL_NOTHROW
29 { d.swap(other.d); }
30
31 void setComponents(const QStringList &components);
32 void setVersions(const QList<QVersionNumber> &versions);
33
34 QStringList components() const;
35 QList<QVersionNumber> versions() const;
36private:
37 QSharedDataPointer<QHelpFilterDataPrivate> d;
38};
39
40QT_END_NAMESPACE
41
42#endif // QHELPFILTERDATA_H
bool unregisterDocumentation(const QString &namespaceName)
QStringList filterAttributes(const QString &filterName) const
QList< QHelpLink > documentsForKeyword(const QString &keyword, const QString &filterName) const
bool removeCustomFilter(const QString &filterName)
QUrl findFile(const QUrl &url, const QStringList &filterAttributes) const
bool setFilterData(const QString &filterName, const QHelpFilterData &filterData)
bool removeFilter(const QString &filterName)
FileInfo registeredDocumentation(const QString &namespaceName) const
QByteArray fileData(const QUrl &url) const
QStringList files(const QString &namespaceName, const QStringList &filterAttributes, const QString &extensionFilter) const
FileInfoList registeredDocumentations() const
QList< ContentsData > contentsForFilter(const QStringList &filterAttributes) const
QMap< QString, QVersionNumber > namespaceToVersion() const
bool removeCustomValue(const QString &key)
QList< QVersionNumber > availableVersions() const
QString namespaceForFile(const QUrl &url, const QStringList &filterAttributes) const
int registerComponent(const QString &componentName, int namespaceId)
bool addCustomFilter(const QString &filterName, const QStringList &attributes)
QMap< QString, QString > namespaceToComponent() const
static QUrl buildQUrl(const QString &ns, const QString &folder, const QString &relFileName, const QString &anchor)
QHelpFilterData filterData(const QString &filterName) const
int registerVirtualFolder(const QString &folderName, int namespaceId)
QStringList availableComponents() const
QVariant customValue(const QString &key, const QVariant &defaultValue) const
bool registerVersion(const QString &version, int namespaceId)
QStringList indicesForFilter(const QStringList &filterAttributes) const
bool fileExists(const QUrl &url) const
bool copyCollectionFile(const QString &fileName)
QStringList namespacesForFilter(const QString &filterName) const
int registerNamespace(const QString &nspace, const QString &fileName)
QHelpCollectionHandler(const QString &collectionFile, QObject *parent=nullptr)
bool registerDocumentation(const QString &fileName)
QList< QStringList > filterAttributeSets(const QString &namespaceName) const
bool setCustomValue(const QString &key, const QVariant &value)
QList< QHelpLink > documentsForIdentifier(const QString &id, const QString &filterName) const
\inmodule QtCore
Transaction(const QString &connectionName)
Combined button and popup list for selecting options.
#define QHELP_EXPORT
static QString getTitle(const QByteArray &contents)
static QHelpCollectionHandler::FileInfo extractFileInfo(const QUrl &url)
static QString prepareFilterQuery(int attributesCount, const QString &idTableName, const QString &idColumnName, const QString &filterTableName, const QString &filterColumnName)
static void bindFilterQuery(QSqlQuery *query, int bindStart, const QString &filterName)
static void bindFilterQuery(QSqlQuery *query, int startingBindPos, const QStringList &filterAttributes)
static QString prepareFilterQuery(const QString &filterName)