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
QQmlLSHelpProviderBase Class Referenceabstract

#include <qqmllshelpplugininterface_p.h>

Inheritance diagram for QQmlLSHelpProviderBase:
Collaboration diagram for QQmlLSHelpProviderBase:

Classes

Public Member Functions

virtual ~QQmlLSHelpProviderBase ()=default
virtual bool registerDocumentation (const QString &documentationFileName)=0
virtual QByteArray fileData (const QUrl &url) const =0
virtual std::vector< DocumentLinkdocumentsForIdentifier (const QString &id) const =0
virtual std::vector< DocumentLinkdocumentsForIdentifier (const QString &id, const QString &filterName) const =0
virtual std::vector< DocumentLinkdocumentsForKeyword (const QString &keyword) const =0
virtual std::vector< DocumentLinkdocumentsForKeyword (const QString &keyword, const QString &filterName) const =0
virtual QStringList registeredNamespaces () const =0
virtual QString error () const =0

Detailed Description

Definition at line 26 of file qqmllshelpplugininterface_p.h.

Constructor & Destructor Documentation

◆ ~QQmlLSHelpProviderBase()

virtual QQmlLSHelpProviderBase::~QQmlLSHelpProviderBase ( )
virtualdefault

Member Function Documentation

◆ documentsForIdentifier() [1/2]

virtual std::vector< DocumentLink > QQmlLSHelpProviderBase::documentsForIdentifier ( const QString & id) const
nodiscardpure virtual

Implemented in QQmlLSHelpProvider.

◆ documentsForIdentifier() [2/2]

virtual std::vector< DocumentLink > QQmlLSHelpProviderBase::documentsForIdentifier ( const QString & id,
const QString & filterName ) const
nodiscardpure virtual

Implemented in QQmlLSHelpProvider.

◆ documentsForKeyword() [1/2]

virtual std::vector< DocumentLink > QQmlLSHelpProviderBase::documentsForKeyword ( const QString & keyword) const
nodiscardpure virtual

Implemented in QQmlLSHelpProvider.

◆ documentsForKeyword() [2/2]

virtual std::vector< DocumentLink > QQmlLSHelpProviderBase::documentsForKeyword ( const QString & keyword,
const QString & filterName ) const
nodiscardpure virtual

Implemented in QQmlLSHelpProvider.

◆ error()

virtual QString QQmlLSHelpProviderBase::error ( ) const
nodiscardpure virtual

Implemented in QQmlLSHelpProvider.

◆ fileData()

virtual QByteArray QQmlLSHelpProviderBase::fileData ( const QUrl & url) const
nodiscardpure virtual

Implemented in QQmlLSHelpProvider.

◆ registerDocumentation()

virtual bool QQmlLSHelpProviderBase::registerDocumentation ( const QString & documentationFileName)
pure virtual

Implemented in QQmlLSHelpProvider.

◆ registeredNamespaces()

virtual QStringList QQmlLSHelpProviderBase::registeredNamespaces ( ) const
nodiscardpure virtual

Implemented in QQmlLSHelpProvider.


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