A widget designed to provide user-assistance and contextual help. More...

#include <HelpWidget.hpp>

Inheritance diagram for drn::auxilium::HelpWidget:

Collaboration diagram for drn::auxilium::HelpWidget:

Public Member Functions
	HelpWidget (const foundation::QtPtr<::QWidget > &parent)
	Full initialisation constructor. The GUI elements for navigation and document viewing are set up and connected to the help engine’s content and index widgets. The start page for the display area is also configured and shown.
void	displayStartPage ()
	Displays the introductory start page in the help widget.
void	displayWizardPage ()
	Displays the wizard page in the help widget.

Detailed Description

A widget designed to provide user-assistance and contextual help.

It is used to create and manage a GUI element that displays help information or guidelines to users. It ensures that assistance is accessible in a consistent format and can include dynamic or contextual content.

Constructor & Destructor Documentation

◆ HelpWidget()

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

explicit

Full initialisation constructor. The GUI elements for navigation and document viewing are set up and connected to the help engine’s content and index widgets. The start page for the display area is also configured and shown.

Exceptions

Error Thrown if the help engine data setup fails. The error message contains details.

Parameters

parent The parent GUI element. If null, the widget will have no parent.

Member Function Documentation

◆ displayStartPage()

void drn::auxilium::HelpWidget::displayStartPage ( )

Displays the introductory start page in the help widget.

It is responsible for ensuring that the start page of the help handbook is loaded and displayed within the help viewer’s display area. The start page is a predefined introductory document meant to guide users when they first access the help widget.

Postcondition: The start page content is loaded into the internal text browser GUI element. Additionally, the content widget's index is updated to reflect the start page’s position.

◆ displayWizardPage()

void drn::auxilium::HelpWidget::displayWizardPage ( )

Displays the wizard page in the help widget.

It loads and displays a predefined wizard page from the help documentation within the internal text browser of the help widget. It is designed to provide users with a step-by-step instructional guide or contextual information relevant to the help handbook wizard.

Postcondition: The wizard page content is loaded into the internal text browser GUI element.; The help engine’s content widget index is updated to show the position of the wizard page.