qmlActionMenu.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file qmlActionMenu.h
//! \brief Defines the QML-based action menu interface for VR-Engage
//!
//! This file contains the DtQmlActionMenu class which provides the interface between
//! the C++ menu system and the QML-based UI rendering. It handles the presentation
//! of menu items, processing selections, and coordinating with the underlying menu logic.
 
#pragma once
 
#include "vrePlayerStation/export.h"
 
#include <QStringList>
#include <QtQuick/QQuickItem>
 
 
namespace makVre
{
class DtMenu;
 
//! \brief QML-based action menu interface for VR-Engage
//!
//! DtQmlActionMenu provides the bridge between the C++ menu system and the
//! QML-based UI rendering. It exposes menu data to QML, processes user interactions,
//! and coordinates with the underlying DtMenu objects. This class allows the menu
//! system to use modern QML rendering while maintaining the C++ business logic.
class PLAYERSTATION_DLL DtQmlActionMenu : public QQuickItem
{
public:
   Q_OBJECT;
 
   //! \brief QML-invokable method for handling button clicks
   //! \param index Index of the clicked menu item
   //!
   //! Called from QML when a menu button is clicked. This method processes
   //! the selection and triggers the appropriate action.
   Q_INVOKABLE virtual void button_clicked(int index);
 
   //! \brief QML-invokable method for selecting menu items
   //! \param index Index of the selected menu item
   //!
   //! Called from QML when a menu item is selected but not yet activated.
   //! This updates the selection state without triggering the action.
   Q_INVOKABLE virtual void selectItem(int index);
 
 
public:
   //! \brief Constructor
   //!
   //! Creates a new QML action menu interface with default state.
   DtQmlActionMenu();
 
   //! \brief Virtual destructor
   //!
   //! Ensures proper cleanup of QML resources and connections.
   virtual ~DtQmlActionMenu() override;
 
   //! \brief Updates the menu data exposed to QML
   //!
   //! Refreshes the menu item data based on the current C++ menu state,
   //! preparing it for display by the QML UI components.
   void updateMenuData();
 
   //! \brief Initializes the QML document
   //! \param rootItem Root QML item to attach the menu to
   //!
   //! Sets up the QML document and establishes connections between
   //! C++ and QML components. This must be called before the menu can be displayed.
   void initDoc(QQuickItem* rootItem);
 
   //! \brief Sets the visibility of the menu
   //! \param visible True to show the menu, false to hide it
   //!
   //! Controls whether the menu is visible in the UI.
   void setVisible(bool visible);
 
   //! \brief Sets the currently selected menu item
   //! \param index Index of the menu item to select
   //!
   //! Updates the selection state in the menu without triggering the action.
   void setSelectedMenuIndex(int index);
 
   //! \brief Sets the menu title
   //! \param title New title text for the menu
   //!
   //! Updates the title displayed at the top of the menu.
   void setTitle(const QString& title);
 
   //! \brief Sets the maximum number of visible menu items
   //! \param len Maximum number of items to display
   //!
   //! Controls the maximum number of menu items that can be displayed at once.
   //! If there are more items than this limit, scrolling will be enabled.
   void setMaxMenuLength(const int len);
 
   //! \brief List of menu item text strings
   //!
   //! Contains the text of each menu item to be displayed in the QML UI.
   QStringList myMenus;
 
   //! \brief List of menu item decorators
   //!
   //! Contains decorator strings (like icons or badges) for menu items.
   QStringList myDecorators;
 
   //! \brief Root QML item for the menu
   //!
   //! The top-level QML item that contains the entire menu UI.
   QQuickItem* myRoot;
 
   //! \brief Window object for the menu
   //!
   //! QML window object that contains the menu interface.
   QObject* myWindow;
 
   //! \brief QML menu object
   //!
   //! The specific QML object representing the menu within the window.
   QObject* myMenuObject;
 
   //! \brief Current C++ menu being displayed
   //!
   //! Pointer to the current DtMenu instance being presented in the QML UI.
   DtMenu* myCurrentMenu;
 
   //! \brief Initial visibility flag
   //!
   //! Controls whether the menu is visible when first initialized.
   bool initVisible;
};
}; // namespace makVre