4#ifndef QHELPCOLLECTIONHANDLER_H
5#define QHELPCOLLECTIONHANDLER_H
21#include <QtCore/qdatetime.h>
22#include <QtCore/qobject.h>
23#include <QtCore/qstringlist.h>
79 bool addCustomFilter(
const QString &filterName,
const QStringList &attributes);
83 const QStringList &filterAttributes,
84 const QString &extensionFilter)
const;
90 QUrl findFile(
const QUrl &url,
const QStringList &filterAttributes)
const;
115 QHelpFilterData
filterData(
const QString &filterName)
const;
116 bool setFilterData(
const QString &filterName,
const QHelpFilterData &filterData);
126 const QString &filterName,
127 const QString &extensionFilter)
const;
129 QUrl findFile(
const QUrl &url,
const QString &filterName)
const;
136 QVariant
customValue(
const QString &key,
const QVariant &defaultValue)
const;
147 const QStringList &filterAttributes)
const;
149 const QStringList &filterAttributes)
const;
155 static QUrl buildQUrl(
const QString &ns,
const QString &folder,
156 const QString &relFileName,
const QString &anchor);
163 QList<QHelpLink> documentsForField(
const QString &fieldName,
164 const QString &fieldValue,
165 const QStringList &filterAttributes)
const;
167 QString namespaceVersion(
const QString &namespaceName)
const;
168 QMultiMap<QString, QUrl> linksForField(
const QString &fieldName,
const QString &fieldValue,
169 const QString &filterName)
const;
170 QList<QHelpLink> documentsForField(
const QString &fieldName,
171 const QString &fieldValue,
172 const QString &filterName)
const;
174 bool isDBOpened()
const;
175 bool createTables(QSqlQuery *query);
177 bool recreateIndexAndNamespaceFilterTables(QSqlQuery *query);
178 bool registerIndexAndNamespaceFilterTables(
const QString &nameSpace,
179 bool createDefaultVersionFilter =
false);
180 void createVersionFilter(
const QString &version);
181 bool registerFilterAttributes(
const QList<QStringList> &attributeSets,
int nsId);
182 bool registerFileAttributeSets(
const QList<QStringList> &attributeSets,
int nsId);
184 int nsId,
int vfId,
const QString &fileName);
185 bool unregisterIndexTable(
int nsId,
int vfId);
186 QString absoluteDocPath(
const QString &fileName)
const;
187 bool isTimeStampCorrect(
const TimeStamp &timeStamp)
const;
188 bool hasTimeStampInfo(
const QString &nameSpace)
const;
189 void scheduleVacuum();
192 QString m_collectionFile;
193 QString m_connectionName;
194 std::unique_ptr<QSqlQuery> m_query;
195 bool m_vacuumScheduled =
false;
196 bool m_readOnly =
true;
bool unregisterDocumentation(const QString &namespaceName)
QStringList filterAttributes(const QString &filterName) const
QStringList filters() 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
QList< FileInfo > FileInfoList
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
QStringList customFilters() const
FileInfoList registeredDocumentations() const
QList< ContentsData > contentsForFilter(const QStringList &filterAttributes) const
~QHelpCollectionHandler()
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)
QStringList filterAttributes() const
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)
QString collectionFile() const
QStringList indicesForFilter(const QStringList &filterAttributes) const
bool fileExists(const QUrl &url) const
bool copyCollectionFile(const QString &fileName)
void setReadOnly(bool readOnly)
bool openCollectionFile()
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
Transaction(const QString &connectionName)
Combined button and popup list for selecting options.
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)
QList< QByteArray > contentsList