HelpItem Class

(Core::HelpItem)

Public Types

enum Category { ClassOrNamespace, Enum, Typedef, Macro, ..., Unknown }
typedef Link
typedef Links

Public Functions

HelpItem()
HelpItem(const char *helpId)
HelpItem(const QString &helpId)
HelpItem(const QString &helpId, const QString &docMark, Core::HelpItem::Category category)
HelpItem(const QStringList &helpIds, const QString &docMark, Core::HelpItem::Category category)
HelpItem(const QUrl &url)
HelpItem(const QUrl &url, const QString &docMark, Core::HelpItem::Category category)
const Core::HelpItem::Links bestLinks() const
Core::HelpItem::Category category() const
const QString &docMark() const
QString firstParagraph() const
const QStringList &helpIds() const
const QUrl &helpUrl() const
bool isEmpty() const
bool isFuzzyMatch() const
bool isValid() const
const QString keyword() const
const Core::HelpItem::Links &links() const
void setCategory(Core::HelpItem::Category cat)
void setDocMark(const QString &mark)
void setHelpIds(const QStringList &ids)
void setHelpUrl(const QUrl &url)

Member Type Documentation

enum HelpItem::Category

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, Core::HelpItem::Category category)

Default constructs an instance of HelpItem.

HelpItem::HelpItem(const QStringList &helpIds, const QString &docMark, Core::HelpItem::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, Core::HelpItem::Category category)

Default constructs an instance of HelpItem.

Core::HelpItem::Category HelpItem::category() const

See also setCategory().

const QString &HelpItem::docMark() const

See also setDocMark().

QString HelpItem::firstParagraph() 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

void HelpItem::setCategory(Core::HelpItem::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().