spectatorItemDelegate.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file spectatorItemDelegate.h
//! \ingroup vreManager
//! \brief Spectator mode item delegate for VREngage Manager
//!
//! This file defines the DtSpectatorItemDelegate class, which is responsible for
//! providing a customized checkbox editor for spectator mode selection in the VREngage Manager.
 
#pragma once
 
#include "vreManager/export.h"
 
#include <QStyledItemDelegate>
#include <QCheckBox>
 
//! \brief Custom item delegate for spectator mode selection
//!
//! This delegate provides a checkbox editor for toggling spectator mode in the VREngage
//! Manager interface. It handles the creation, display, and manipulation of the
//! checkbox editor for spectator mode cells in the manager's table view.
class VREMANAGER_DLL DtSpectatorItemDelegate : public QStyledItemDelegate
{
   Q_OBJECT
public:
   //! \brief Constructor
   //! \param parent The parent object
   //!
   //! Initializes a new spectator item delegate with the specified parent.
   DtSpectatorItemDelegate(QObject* parent = 0);
 
   //! \brief Destructor
   //!
   //! Cleans up resources used by the spectator item delegate.
   virtual ~DtSpectatorItemDelegate() override;
 
   //! \brief Creates a checkbox editor for spectator mode selection
   //! \param parent The parent widget
   //! \param option The style options to use when drawing the editor
   //! \param index The model index of the item being edited
   //! \return A checkbox widget configured for spectator mode selection
   //!
   //! Creates and configures a checkbox editor for toggling spectator mode.
   virtual QWidget* createEditor(
      QWidget* parent, const QStyleOptionViewItem& option, const QModelIndex& index) const override;
 
   //! \brief Destroys the editor when editing is finished
   //! \param editor The editor widget to destroy
   //! \param index The model index of the item that was being edited
   //!
   //! Handles cleanup of the editor widget when editing is complete.
   virtual void destroyEditor(QWidget* editor, const QModelIndex& index) const override;
 
   //! \brief Sets the editor data based on the model index
   //! \param editor The editor widget to update
   //! \param index The model index containing the data to edit
   //!
   //! Populates the checkbox with data from the model (checked/unchecked state).
   virtual void setEditorData(QWidget* editor, const QModelIndex& index) const override;
 
   //! \brief Updates the model with data from the editor
   //! \param editor The editor widget containing the updated data
   //! \param model The model to update
   //! \param index The model index to update
   //!
   //! Transfers the checkbox state back to the model when editing is complete.
   virtual void setModelData(QWidget* editor, QAbstractItemModel* model, const QModelIndex& index) const override;
 
   //! \brief Custom painting for the checkbox in the view
   //! \param painter The painter to use for drawing
   //! \param option The style options to use when drawing
   //! \param index The model index of the item to draw
   //!
   //! Handles custom drawing of the checkbox in the view when not being edited.
   virtual void paint(QPainter* painter, const QStyleOptionViewItem& option, const QModelIndex& index) const override;
 
   //! \brief Updates the editor's geometry
   //! \param editor The editor widget to update
   //! \param option The style options to use when positioning
   //! \param index The model index of the item being edited
   //!
   //! Positions the checkbox editor appropriately in the cell.
   virtual void updateEditorGeometry(
      QWidget* editor, const QStyleOptionViewItem& option, const QModelIndex& index) const override;
 
protected slots:
   //! \brief Handles checkbox state changes
   //! \param state The new state of the checkbox
   //!
   //! Called when the checkbox state changes between checked and unchecked.
   virtual void onStateChanged(int state);
 
protected:
   //! \brief The checkbox editor widget
   //!
   //! Maintains a reference to the currently active checkbox editor.
   //! Declared mutable to allow modification in const methods.
   mutable QCheckBox* myEditor;
};