DtVreHelpItem Class Reference

Detailed Description

DtVreHelpItem provides a menu item for accessing the VR-Engage online help system. When triggered, it launches Qt Assistant with the VR-Engage help collection. This class handles launching the help viewer, tracking its process, and handling any errors that may occur during the help system operation.

#include <helpMenuItems.h>

Inheritance diagram for DtVreHelpItem:

Public Member Functions
	DtVreHelpItem (makVrv::DtDe &de)
virtual	~DtVreHelpItem () override
virtual QAction *	createAction (makVrv::DtDe &, QWidget *parent) override

Protected Slots
void	displayError (QProcess::ProcessError error)
virtual void	deleteAssistant ()

Protected Member Functions
virtual void	on_triggered () override

Protected Attributes
QAction *	myAction
makVrv::DtDe &	myDe

Constructor & Destructor Documentation

DtVreHelpItem()

DtVreHelpItem::DtVreHelpItem

(

makVrv::DtDe &

de

)

Constructor.

Parameters

de	Reference to the display engine

Creates a new help menu item associated with the specified display engine.

References de().

~DtVreHelpItem()

virtual DtVreHelpItem::~DtVreHelpItem ( )

overridevirtual

Virtual destructor.

Ensures proper cleanup of resources and terminates any running help processes.

Member Function Documentation

createAction()

virtual QAction * DtVreHelpItem::createAction ( makVrv::DtDe & , QWidget * parent )

overridevirtual

Creates an action for this menu item.

Parameters

de	Reference to the display engine
parent	Parent widget that will own the action

Returns

Pointer to the created action

Builds and returns a QAction that represents this menu item in the UI. The action includes the appropriate icon, text, and connection to the menu item's functionality.

displayError

void DtVreHelpItem::displayError ( QProcess::ProcessError error )

protectedslot

Handles errors from the help process.

Parameters

error

The process error that occurred

Called when an error occurs in the Qt Assistant process. Displays an appropriate error message to the user.

deleteAssistant

virtual void DtVreHelpItem::deleteAssistant ( )

protectedvirtualslot

Handles help viewer termination.

Called when the Qt Assistant process closes or crashes. Cleans up resources associated with the help viewer.

on_triggered()

virtual void DtVreHelpItem::on_triggered ( )

overrideprotectedvirtual

Handles menu item activation.

Called when the user selects the help menu item. Launches the Qt Assistant with the VR-Engage help collection.

Member Data Documentation

myAction

QAction* DtVreHelpItem::myAction

protected

Action representing this menu item.

myDe

makVrv::DtDe& DtVreHelpItem::myDe

protected

Reference to the display engine.

---

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

• include/framework/vrePlayerStation/helpMenuItems.h