forked from qt-creator/qt-creator
04e50438eb
Since we are now requiring macOS 10.14 we can remove our local implementation of optional and use std::optional for macOS too. Change-Id: I2bd018261b68da64f7f031a812045dd7784697e1 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: <github-actions-qt-creator@cristianadam.eu> Reviewed-by: Marco Bubke <marco.bubke@qt.io>
81 lines
1.9 KiB
C++
81 lines
1.9 KiB
C++
// Copyright (C) 2016 The Qt Company Ltd.
|
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0+ OR GPL-3.0 WITH Qt-GPL-exception-1.0
|
|
|
|
#pragma once
|
|
|
|
#include "core_global.h"
|
|
|
|
#include <QString>
|
|
#include <QUrl>
|
|
#include <QVariant>
|
|
|
|
#include <optional>
|
|
#include <vector>
|
|
|
|
namespace Core {
|
|
|
|
class CORE_EXPORT HelpItem
|
|
{
|
|
public:
|
|
using Link = std::pair<QString, QUrl>;
|
|
using Links = std::vector<Link>;
|
|
|
|
enum Category {
|
|
ClassOrNamespace,
|
|
Enum,
|
|
Typedef,
|
|
Macro,
|
|
Brief,
|
|
Function,
|
|
QmlComponent,
|
|
QmlProperty,
|
|
QMakeVariableOfFunction,
|
|
Unknown
|
|
};
|
|
|
|
HelpItem();
|
|
HelpItem(const char *helpId);
|
|
HelpItem(const QString &helpId);
|
|
HelpItem(const QString &helpId, const QString &docMark, Category category);
|
|
HelpItem(const QStringList &helpIds, const QString &docMark, Category category);
|
|
explicit HelpItem(const QUrl &url);
|
|
HelpItem(const QUrl &url, const QString &docMark, Category category);
|
|
|
|
void setHelpUrl(const QUrl &url);
|
|
const QUrl &helpUrl() const;
|
|
|
|
void setHelpIds(const QStringList &ids);
|
|
const QStringList &helpIds() const;
|
|
|
|
void setDocMark(const QString &mark);
|
|
const QString &docMark() const;
|
|
|
|
void setCategory(Category cat);
|
|
Category category() const;
|
|
|
|
bool isEmpty() const;
|
|
bool isValid() const;
|
|
|
|
QString firstParagraph() const;
|
|
const Links &links() const;
|
|
const Links bestLinks() const;
|
|
const QString keyword() const;
|
|
bool isFuzzyMatch() const;
|
|
|
|
private:
|
|
QString extractContent(bool extended) const;
|
|
|
|
QUrl m_helpUrl;
|
|
QStringList m_helpIds;
|
|
QString m_docMark;
|
|
Category m_category = Unknown;
|
|
mutable std::optional<Links> m_helpLinks; // cached help links
|
|
mutable std::optional<QString> m_firstParagraph;
|
|
mutable QString m_keyword;
|
|
mutable bool m_isFuzzyMatch = false;
|
|
};
|
|
|
|
} // namespace Core
|
|
|
|
Q_DECLARE_METATYPE(Core::HelpItem)
|