HelpClient Class Reference

#include <helpclient.h>

Inheritance diagram for HelpClient:

Collaboration diagram for HelpClient:

Public Member Functions
	HelpClient () noexcept=default
virtual	~HelpClient ()=default
virtual bool	showPage (const QString &path, QString *errorMessage)=0
virtual bool	activateIdentifier (const QString &identifier, QString *errorMessage)=0
virtual QString	documentUrl (const QString &module) const =0
QString	designerManualUrl () const

Static Public Member Functions
static std::unique_ptr< HelpClient >	create (HelpClientType type)

Detailed Description

Definition at line 18 of file helpclient.h.

Constructor & Destructor Documentation

HelpClient()

HelpClient::HelpClient ( )

defaultnoexcept

~HelpClient()

virtual HelpClient::~HelpClient ( )

virtualdefault

Member Function Documentation

activateIdentifier()

virtual bool HelpClient::activateIdentifier ( const QString & identifier, QString * errorMessage )

pure virtual

Implemented in AssistantClient, PythonWebHelpClient, and WebHelpClient.

create()

std::unique_ptr< HelpClient > HelpClient::create ( HelpClientType type )

static

Definition at line 24 of file helpclient.cpp.

References Assistant, Python, and Web.

designerManualUrl()

QString HelpClient::designerManualUrl

(

)

const

Definition at line 19 of file helpclient.cpp.

References documentUrl().

Here is the call graph for this function:

documentUrl()

virtual QString HelpClient::documentUrl ( const QString & module ) const

pure virtual

Implemented in AssistantClient, and WebHelpClient.

Referenced by designerManualUrl().

Here is the caller graph for this function:

showPage()

virtual bool HelpClient::showPage ( const QString & path, QString * errorMessage )

pure virtual

Implemented in AssistantClient, and WebHelpClient.

---

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

• qttools/src/shared/helpclient/helpclient.h (3f8313c98ce73ba00c70a7b0bb2d0fd9572be3bf)
• qttools/src/shared/helpclient/helpclient.cpp (3f8313c98ce73ba00c70a7b0bb2d0fd9572be3bf)