Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QQmlLSHelpProvider Class Reference

#include <qhelpengineplugin.h>

+ Inheritance diagram for QQmlLSHelpProvider:
+ Collaboration diagram for QQmlLSHelpProvider:

Public Member Functions

 QQmlLSHelpProvider (const QString &qhcFile, QObject *parent=nullptr)
 
bool registerDocumentation (const QString &documentationFileName) override
 
QByteArray fileData (const QUrl &url) const override
 
std::vector< DocumentLink > documentsForIdentifier (const QString &id) const override
 
std::vector< DocumentLink > documentsForIdentifier (const QString &id, const QString &filterName) const override
 
std::vector< DocumentLink > documentsForKeyword (const QString &keyword) const override
 
std::vector< DocumentLink > documentsForKeyword (const QString &keyword, const QString &filterName) const override
 
QStringList registeredNamespaces () const override
 
QString error () const override
 
- Public Member Functions inherited from QQmlLSHelpProviderBase
virtual ~QQmlLSHelpProviderBase ()=default
 

Detailed Description

Definition at line 33 of file qhelpengineplugin.h.

Constructor & Destructor Documentation

◆ QQmlLSHelpProvider()

QQmlLSHelpProvider::QQmlLSHelpProvider ( const QString & qhcFile,
QObject * parent = nullptr )

Definition at line 26 of file qhelpengineplugin.cpp.

Member Function Documentation

◆ documentsForIdentifier() [1/2]

std::vector< QQmlLSHelpProvider::DocumentLink > QQmlLSHelpProvider::documentsForIdentifier ( const QString & id) const
nodiscardoverridevirtual

Implements QQmlLSHelpProviderBase.

Definition at line 46 of file qhelpengineplugin.cpp.

◆ documentsForIdentifier() [2/2]

std::vector< QQmlLSHelpProvider::DocumentLink > QQmlLSHelpProvider::documentsForIdentifier ( const QString & id,
const QString & filterName ) const
nodiscardoverridevirtual

Implements QQmlLSHelpProviderBase.

Definition at line 53 of file qhelpengineplugin.cpp.

◆ documentsForKeyword() [1/2]

std::vector< QQmlLSHelpProvider::DocumentLink > QQmlLSHelpProvider::documentsForKeyword ( const QString & keyword) const
nodiscardoverridevirtual

Implements QQmlLSHelpProviderBase.

Definition at line 60 of file qhelpengineplugin.cpp.

◆ documentsForKeyword() [2/2]

std::vector< QQmlLSHelpProvider::DocumentLink > QQmlLSHelpProvider::documentsForKeyword ( const QString & keyword,
const QString & filterName ) const
nodiscardoverridevirtual

Implements QQmlLSHelpProviderBase.

Definition at line 67 of file qhelpengineplugin.cpp.

◆ error()

QString QQmlLSHelpProvider::error ( ) const
nodiscardoverridevirtual

Implements QQmlLSHelpProviderBase.

Definition at line 79 of file qhelpengineplugin.cpp.

◆ fileData()

QByteArray QQmlLSHelpProvider::fileData ( const QUrl & url) const
nodiscardoverridevirtual

Implements QQmlLSHelpProviderBase.

Definition at line 39 of file qhelpengineplugin.cpp.

◆ registerDocumentation()

bool QQmlLSHelpProvider::registerDocumentation ( const QString & documentationFileName)
overridevirtual

Implements QQmlLSHelpProviderBase.

Definition at line 33 of file qhelpengineplugin.cpp.

◆ registeredNamespaces()

QStringList QQmlLSHelpProvider::registeredNamespaces ( ) const
nodiscardoverridevirtual

Implements QQmlLSHelpProviderBase.

Definition at line 73 of file qhelpengineplugin.cpp.

The documentation for this class was generated from the following files: