drn::auxilium::HelpBrowser Class Reference

This provides a user-friendly interface for displaying help documentation. More...

#include <HelpBrowser.hpp>

Inheritance diagram for drn::auxilium::HelpBrowser:

Collaboration diagram for drn::auxilium::HelpBrowser:

Public Slots
void	displayContent (const QUrl &link)
	Displays help content in the browser by using the provided link as the source.
void	displayIndex (const QHelpLink &document, const QString &keyword)
	Displays the index document related to the provided keyword in the help browser.

Public Member Functions
	HelpBrowser (const foundation::QtPtr<::QWidget > &parent)
	Partial initialisation constructor.
void	iniitalise (const foundation::QtPtr<::QHelpEngine > &helpEngine, const QUrl &page)
	Initialises the widget with the provided help engine and sets the specified start page.

Static Public Attributes
static constexpr ::QLatin1StringView	Scheme_ {"qthelp"}
	Represents the custom scheme utilised for processing internal help system links.

Detailed Description

This provides a user-friendly interface for displaying help documentation.

It is used to display help-related content in a structured and navigable format within the graphical application. It provides users with the ability to browse, search, and interact with help documentation to assist in understanding the application or its features.

Constructor & Destructor Documentation

HelpBrowser()

drn::auxilium::HelpBrowser::HelpBrowser ( const foundation::QtPtr<::QWidget > & parent )

explicit

Partial initialisation constructor.

It ensures proper integration into the graphical interface’s hierarchy and sets up the browser for displaying help-related content. N.B. nothing can be displayed until the object's initialise member function is invoked.

Parameters

parent

The GUI item to contain the help browser that will mange the lifetime of the object.

Member Function Documentation

displayContent

void drn::auxilium::HelpBrowser::displayContent ( const QUrl & link )

slot

Displays help content in the browser by using the provided link as the source.

Exceptions

Error

Thrown if the help document cannot be loaded successfully.

Parameters

link	The URL pointing to the content resource to be displayed.

Postcondition

The internal state of the help browser is updated to point to the newly set source.

displayIndex

void drn::auxilium::HelpBrowser::displayIndex ( const QHelpLink & document, const QString & keyword )

slot

Displays the index document related to the provided keyword in the help browser.

It loads the specified document in the help browser and associates it with the given keyword.

Exceptions

Error

Thrown if the help document cannot be loaded successfully.

Parameters

document	An object containing a URL resource pointing to a specific help document.
keyword	A string used to identify the association between the resource and the keyword.

Postcondition

The content of the help browser will be updated to display the linked document specified.

iniitalise()

void drn::auxilium::HelpBrowser::iniitalise	(	const foundation::QtPtr<::QHelpEngine > &	helpEngine,
		const QUrl &	page )

Initialises the widget with the provided help engine and sets the specified start page.

It configures the widget to display help content by associating it with the provided help engine and sets the initial page to be displayed.

Exceptions

Error

Thrown if the provided start page URL is empty or invalid.

Precondition

The help engine must not be null.

The help engine must not have any initialisation errors.

Parameters

helpEngine	The help engine which provides access to help documents and content.
page	The URL pointing to the initial page to be displayed in the help browser.

Postcondition

The internal help engine is associated with the widget’s instance.

The initial source for the browser is updated to the specified page.

Member Data Documentation

Scheme_

::QLatin1StringView drn::auxilium::HelpBrowser::Scheme_ {"qthelp"}

static

Represents the custom scheme utilised for processing internal help system links.

It provides an identifier for distinguishing links handled specifically by the internal help browser. It is used to route URLs with this scheme to the appropriate handler within the application’s context.