helpMenuItems.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file helpMenuItems.h
//! \brief Defines specialized menu items for the VR-Engage help system
//!
//! This file contains a collection of menu item classes used in the VR-Engage
//! help system. These include about boxes, help viewers, documentation links,
//! and other support resources accessible from the application's help menu.
//! These classes customize the base VR-Vantage help items for VR-Engage's
//! specific documentation and branding.
 
#pragma once
 
#include <vrePlayerStation/export.h>
 
#include <vrvCoreQt/DtMenuItem.h>
#include <vrvCoreQt/DtHelpItems.h>
#include <vrvCoreQt/DtAboutBox.h>
#include <QtCore/QProcess>
 
namespace makVrv
{
class DtMenuItem;
class DtDe;
} // namespace makVrv
 
//! \brief Customized About dialog menu item for VR-Engage
//!
//! DtVreAboutItem overrides the standard VR-Vantage about item to customize
//! the version label in the about box. It changes the label from "Version:" to
//! "Built on:" to better reflect that VR-Engage is built on top of the VR-Vantage
//! platform.
//!
//! This class is used in the Help menu to display information about the VR-Engage
//! application, including version, build date, and copyright information.
class PLAYERSTATION_DLL DtVreAboutItem : public makVrv::DtAboutItem
{
public:
   //! \brief Constructor
   //! \param de Reference to the display engine
   //!
   //! Creates a new about item associated with the specified display engine.
   DtVreAboutItem(makVrv::DtDe& de);
 
   //! \brief Virtual destructor
   //!
   //! Ensures proper cleanup of derived about item classes.
   virtual ~DtVreAboutItem() override;
 
protected:
   //! \brief Handles activation of the about menu item
   //!
   //! Override to change text from "Version: " to "Built on: "
   //! This makes more sense given that we're building VR-Engage on top of VR-Vantage.
   //! Called when the user selects the About item from the Help menu.
   virtual void on_triggered() override;
};
 
//! \brief Customized About dialog box for VR-Engage
//!
//! DtVreAboutBox provides a customized version of the VR-Vantage about box
//! with VR-Engage specific branding, version information, and appearance.
//! It displays information about the application including version, copyright,
//! build date, and credits.
class PLAYERSTATION_DLL DtVreAboutBox : public makVrv::DtAboutBox
{
   Q_OBJECT
 
public:
   //! \brief Constructor
   //! \param igApp Reference to the VR-Vantage application
   //! \param parent Parent widget (default: null)
   //! \param f Window flags (default: 0)
   //!
   //! Creates a new about box dialog with VR-Engage branding and information.
   DtVreAboutBox(makVrv::DtVrvApplication& igApp, QWidget* parent = nullptr, Qt::WindowFlags f = 0);
 
   //! \brief Virtual destructor
   //!
   //! Ensures proper cleanup of dialog resources.
   virtual ~DtVreAboutBox() override;
 
protected:
   //! \brief Path to the about box background image
   //!
   //! Static file path to the custom background image used in the VR-Engage about box.
   static DtFilename theAboutBoxImage;
};
 
 
//! \brief Menu item for launching online help
//!
//! 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.
class PLAYERSTATION_DLL DtVreHelpItem : public makVrv::DtMenuItem
{
   Q_OBJECT
public:
   //! \brief Constructor
   //! \param de Reference to the display engine
   //!
   //! Creates a new help menu item associated with the specified display engine.
   DtVreHelpItem(makVrv::DtDe& de);
 
   //! \brief Virtual destructor
   //!
   //! Ensures proper cleanup of resources and terminates any running help processes.
   virtual ~DtVreHelpItem() override;
 
   //! \brief Creates an action for this menu item
   //! \param de Reference to the display engine
   //! \param parent Parent widget that will own the action
   //! \return 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.
   virtual QAction* createAction(makVrv::DtDe&, QWidget* parent) override;
 
protected slots:
   //! \brief Handles errors from the help process
   //! \param error The process error that occurred
   //!
   //! Called when an error occurs in the Qt Assistant process.
   //! Displays an appropriate error message to the user.
   void displayError(QProcess::ProcessError error);
 
   //! \brief Handles help viewer termination
   //!
   //! Called when the Qt Assistant process closes or crashes.
   //! Cleans up resources associated with the help viewer.
   virtual void deleteAssistant();
 
protected:
   //! \brief Handles menu item activation
   //!
   //! Called when the user selects the help menu item. Launches the
   //! Qt Assistant with the VR-Engage help collection.
   virtual void on_triggered() override;
 
   //! \brief Action representing this menu item
   QAction* myAction;
 
   //! \brief Reference to the display engine
   makVrv::DtDe& myDe;
};
 
//! \brief Menu item for accessing controls mapping documentation
//!
//! DtVreControlsMappingMenuItem provides a menu item for accessing documentation
//! about control mappings in VR-Engage. When triggered, it opens a web link to
//! the controls mapping documentation, which shows how input devices (keyboard,
//! mouse, controllers) are mapped to actions in the application.
class PLAYERSTATION_DLL DtVreControlsMappingMenuItem : public makVrv::DtWebLinkMenuItem
{
   Q_OBJECT
public:
   //! \brief Constructor
   //! \param de Reference to the display engine
   //!
   //! Creates a new controls mapping menu item associated with the specified display engine.
   DtVreControlsMappingMenuItem(makVrv::DtDe& de);
 
   //! \brief Virtual destructor
   //!
   //! Ensures proper cleanup of resources.
   virtual ~DtVreControlsMappingMenuItem() override;
 
   //! \brief Creates an action for this menu item
   //! \param de Reference to the display engine
   //! \param parent Parent widget that will own the action
   //! \return 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.
   virtual QAction* createAction(makVrv::DtDe&, QWidget* parent) override;
 
protected:
   //! \brief Handles menu item activation
   //!
   //! Called when the user selects the controls mapping menu item.
   //! Opens the controls mapping documentation in the default web browser.
   virtual void on_triggered() override;
 
   //! \brief Action representing this menu item
   QAction* myAction;
 
   //! \brief Reference to the display engine
   makVrv::DtDe& myDe;
};
 
//! \brief Menu item for accessing the VR-Engage website
//!
//! DtVreVersionWebSiteMenuItem provides a menu item for accessing the official
//! VR-Engage product website. When triggered, it opens the website in the default
//! web browser, providing access to additional product information, downloads,
//! and support resources.
class PLAYERSTATION_DLL DtVreVersionWebSiteMenuItem : public makVrv::DtWebLinkMenuItem
{
   Q_OBJECT
public:
   //! \brief Constructor
   //! \param de Reference to the display engine
   //!
   //! Creates a new website menu item associated with the specified display engine.
   DtVreVersionWebSiteMenuItem(makVrv::DtDe& de);
 
   //! \brief Virtual destructor
   //!
   //! Ensures proper cleanup of resources.
   virtual ~DtVreVersionWebSiteMenuItem() override;
 
   //! \brief Creates an action for this menu item
   //! \param de Reference to the display engine
   //! \param parent Parent widget that will own the action
   //! \return 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.
   virtual QAction* createAction(makVrv::DtDe&, QWidget* parent) override;
};
 
//! \brief Menu item for accessing release notes
//!
//! DtVreReleaseNotesMenuItem provides a menu item for accessing the VR-Engage
//! release notes. When triggered, it opens the release notes document in the
//! default web browser, providing information about new features, bug fixes,
//! and other changes in the current version of the application.
class PLAYERSTATION_DLL DtVreReleaseNotesMenuItem : public makVrv::DtWebLinkMenuItem
{
   Q_OBJECT
public:
   //! \brief Constructor
   //! \param de Reference to the display engine
   //!
   //! Creates a new release notes menu item associated with the specified display engine.
   DtVreReleaseNotesMenuItem(makVrv::DtDe& de);
 
   //! \brief Virtual destructor
   //!
   //! Ensures proper cleanup of resources.
   virtual ~DtVreReleaseNotesMenuItem() override;
 
   //! \brief Creates an action for this menu item
   //! \param de Reference to the display engine
   //! \param parent Parent widget that will own the action
   //! \return 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.
   virtual QAction* createAction(makVrv::DtDe&, QWidget* parent) override;
};
 
//! \brief Menu item for accessing first experience guide
//!
//! DtVreFirstExperienceMenuItem provides a menu item for accessing the "First Experience"
//! guide for VR-Engage. When triggered, it opens the first experience guide document
//! in the default web browser, providing new users with a step-by-step introduction
//! to the basic features and workflow of the application.
class PLAYERSTATION_DLL DtVreFirstExperienceMenuItem : public makVrv::DtWebLinkMenuItem
{
   Q_OBJECT
public:
   //! \brief Constructor
   //! \param de Reference to the display engine
   //!
   //! Creates a new first experience guide menu item associated with the specified display engine.
   DtVreFirstExperienceMenuItem(makVrv::DtDe& de);
 
   //! \brief Virtual destructor
   //!
   //! Ensures proper cleanup of resources.
   virtual ~DtVreFirstExperienceMenuItem() override;
 
   //! \brief Creates an action for this menu item
   //! \param de Reference to the display engine
   //! \param parent Parent widget that will own the action
   //! \return 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.
   virtual QAction* createAction(makVrv::DtDe&, QWidget* parent) override;
};
 
//! \brief Menu item for accessing the VR-Engage User's Guide
//!
//! DtVreUsersGuideMenuItem provides a menu item for accessing the comprehensive
//! User's Guide for VR-Engage. When triggered, it opens the User's Guide document
//! in the default web browser. The User's Guide contains detailed documentation
//! on all features, workflows, and components of the application.
class PLAYERSTATION_DLL DtVreUsersGuideMenuItem : public makVrv::DtWebLinkMenuItem
{
   Q_OBJECT
public:
   //! \brief Constructor
   //! \param de Reference to the display engine
   //!
   //! Creates a new User's Guide menu item associated with the specified display engine.
   DtVreUsersGuideMenuItem(makVrv::DtDe& de);
 
   //! \brief Virtual destructor
   //!
   //! Ensures proper cleanup of resources.
   virtual ~DtVreUsersGuideMenuItem() override;
 
   //! \brief Creates an action for this menu item
   //! \param de Reference to the display engine
   //! \param parent Parent widget that will own the action
   //! \return 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.
   virtual QAction* createAction(makVrv::DtDe&, QWidget* parent) override;
};
 
//! \brief Menu item for displaying information about loaded plugins
//!
//! DtVrePluginsMenuItem provides a menu item for displaying information about
//! loaded plugins in the VR-Engage application. When triggered, it shows a dialog
//! listing all active plugins, their versions, and other relevant information.
//! This is useful for debugging and verifying which plugins are currently active.
class PLAYERSTATION_DLL DtVrePluginsMenuItem : public makVrv::DtMenuItem
{
   Q_OBJECT
public:
   //! \brief Constructor
   //! \param de Reference to the display engine
   //!
   //! Creates a new plugins menu item associated with the specified display engine.
   DtVrePluginsMenuItem(makVrv::DtDe& de);
 
   //! \brief Virtual destructor
   //!
   //! Ensures proper cleanup of resources.
   virtual ~DtVrePluginsMenuItem() override;
 
   //! \brief Creates an action for this menu item
   //! \param de Reference to the display engine
   //! \param parent Parent widget that will own the action
   //! \return 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.
   virtual QAction* createAction(makVrv::DtDe&, QWidget* parent) override;
 
protected:
   //! \brief Handles menu item activation
   //!
   //! Called when the user selects the plugins menu item. Shows a dialog
   //! displaying information about all loaded plugins in the application.
   virtual void on_triggered() override;
 
protected:
   //! \brief Reference to the display engine
   makVrv::DtDe& myDe;
};