27 Q_PROPERTY(
bool autoSaveFilter READ autoSaveFilter WRITE setAutoSaveFilter)
28 Q_PROPERTY(QString collectionFile READ collectionFile WRITE setCollectionFile)
29 Q_PROPERTY(
bool readOnly READ isReadOnly WRITE setReadOnly)
30#if QT_DEPRECATED_SINCE(5
, 15
)
31 Q_PROPERTY(QString currentFilter READ currentFilter WRITE setCurrentFilter)
35 explicit QHelpEngineCore(
const QString &collectionFile, QObject *parent =
nullptr);
36 virtual ~QHelpEngineCore();
38 bool isReadOnly()
const;
39 void setReadOnly(
bool enable);
41 QHelpFilterEngine *filterEngine()
const;
45 QString collectionFile()
const;
46 void setCollectionFile(
const QString &fileName);
48 bool copyCollectionFile(
const QString &fileName);
50 static QString namespaceName(
const QString &documentationFileName);
51 bool registerDocumentation(
const QString &documentationFileName);
52 bool unregisterDocumentation(
const QString &namespaceName);
53 QString documentationFileName(
const QString &namespaceName);
54 QStringList registeredDocumentations()
const;
55 QByteArray fileData(
const QUrl &url)
const;
58 QStringList customFilters()
const;
59 bool removeCustomFilter(
const QString &filterName);
60 bool addCustomFilter(
const QString &filterName,
61 const QStringList &attributes);
63 QStringList filterAttributes()
const;
64 QStringList filterAttributes(
const QString &filterName)
const;
66 QString currentFilter()
const;
67 void setCurrentFilter(
const QString &filterName);
69 QList<QStringList> filterAttributeSets(
const QString &namespaceName)
const;
70 QList<QUrl> files(
const QString namespaceName,
const QStringList &filterAttributes,
71 const QString &extensionFilter = {});
74 QList<QUrl> files(
const QString namespaceName,
const QString &filterName,
75 const QString &extensionFilter = {});
76 QUrl findFile(
const QUrl &url)
const;
78 QList<QHelpLink> documentsForIdentifier(
const QString &id)
const;
79 QList<QHelpLink> documentsForIdentifier(
const QString &id,
const QString &filterName)
const;
80 QList<QHelpLink> documentsForKeyword(
const QString &keyword)
const;
81 QList<QHelpLink> documentsForKeyword(
const QString &keyword,
const QString &filterName)
const;
83 bool removeCustomValue(
const QString &key);
84 QVariant customValue(
const QString &key,
const QVariant &defaultValue = {})
const;
85 bool setCustomValue(
const QString &key,
const QVariant &value);
87 static QVariant metaData(
const QString &documentationFileName,
const QString &name);
89 QString error()
const;
91 void setAutoSaveFilter(
bool save);
92 bool autoSaveFilter()
const;
94 void setUsesFilterEngine(
bool uses);
95 bool usesFilterEngine()
const;
98 QFuture<std::shared_ptr<QHelpContentItem>> requestContentForCurrentFilter()
const;
99 QFuture<std::shared_ptr<QHelpContentItem>> requestContent(
const QString &filter)
const;
101 QFuture<QStringList> requestIndexForCurrentFilter()
const;
102 QFuture<QStringList> requestIndex(
const QString &filter)
const;
107 void setupFinished();
108 void warning(
const QString &msg);
111 void currentFilterChanged(
const QString &newFilter);
112 void readersAboutToBeInvalidated();
116#if QT_DEPRECATED_SINCE(6
, 8
)
117 QHelpEngineCore(QHelpEngineCorePrivate *helpEngineCorePrivate, QObject *parent);
121 QHelpEngineCorePrivate *d;
std::shared_ptr< QHelpContentItem > rootItem
QHelpEngineCore * helpEngine