drn::auxilium::HelpWidget Class Reference

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.

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.