HelpItem Class
(Core::HelpItem)Public Types
enum | Category { ClassOrNamespace, Enum, Typedef, Macro, ..., Unknown } |
Public Functions
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) | |
HelpItem(const QUrl &url) | |
HelpItem(const QUrl &url, const QString &docMark, Category category) | |
const Links | bestLinks() const |
Category | category() const |
const QString & | docMark() const |
QString | extractContent(bool extended) const |
const QStringList & | helpIds() const |
const QUrl & | helpUrl() const |
bool | isEmpty() const |
bool | isFuzzyMatch() const |
bool | isValid() const |
const QString | keyword() const |
const Links & | links() const |
void | setCategory(Category cat) |
void | setDocMark(const QString &mark) |
void | setHelpIds(const QStringList &ids) |
void | setHelpUrl(const QUrl &url) |
Member Function Documentation
HelpItem::HelpItem()
Default constructs an instance of HelpItem.
HelpItem::HelpItem(const char *helpId)
Default constructs an instance of HelpItem.
HelpItem::HelpItem(const QString &helpId)
Default constructs an instance of HelpItem.
HelpItem::HelpItem(const QString &helpId, const QString &docMark, Category category)
Default constructs an instance of HelpItem.
HelpItem::HelpItem(const QStringList &helpIds, const QString &docMark, Category category)
Default constructs an instance of HelpItem.
HelpItem::HelpItem(const QUrl &url)
Default constructs an instance of HelpItem.
HelpItem::HelpItem(const QUrl &url, const QString &docMark, Category category)
Default constructs an instance of HelpItem.
const Links HelpItem::bestLinks() const
Category HelpItem::category() const
See also setCategory().
const QString &HelpItem::docMark() const
See also setDocMark().
QString HelpItem::extractContent(bool extended) const
const QStringList &HelpItem::helpIds() const
See also setHelpIds().
const QUrl &HelpItem::helpUrl() const
See also setHelpUrl().
bool HelpItem::isEmpty() const
bool HelpItem::isFuzzyMatch() const
bool HelpItem::isValid() const
const QString HelpItem::keyword() const
const Links &HelpItem::links() const
void HelpItem::setCategory(Category cat)
See also category().
void HelpItem::setDocMark(const QString &mark)
See also docMark().
void HelpItem::setHelpIds(const QStringList &ids)
See also helpIds().
void HelpItem::setHelpUrl(const QUrl &url)
See also helpUrl().