Dialog for selecting a change reason when saving/deleting entities. More...

#include <ChangeReasonDialog.hpp>

Inherits QDialog.

Collaboration diagram for ChangeReasonDialog:

Public Types
enum class	OperationType { Create , Amend , Delete }
	Type of operation requiring a change reason. More...

Public Member Functions
	ChangeReasonDialog (const std::vector< dq::domain::change_reason > &reasons, OperationType operation, bool hasFieldChanges, QWidget *parent=nullptr)
	Construct the dialog.

std::string	selectedReasonCode () const
	Get the selected reason code.

std::string	commentary () const
	Get the commentary entered by the user.

Detailed Description

Dialog for selecting a change reason when saving/deleting entities.

This dialog is displayed when a user saves changes to an entity that requires change tracking. It presents a list of applicable reasons and optionally requires commentary based on the selected reason.

Usage:

ChangeReasonDialog dialog(reasons, ChangeReasonDialog::OperationType::Amend, this);
if (dialog.exec() == QDialog::Accepted) {
    std::string reason_code = dialog.selectedReasonCode();
    std::string commentary = dialog.commentary();
}

Member Enumeration Documentation

◆ OperationType

enum class OperationType

strong

Type of operation requiring a change reason.

Enumerator
Create	Creating a new entity.
Amend	Updating an existing entity.
Delete	Deleting an entity.

Constructor & Destructor Documentation

◆ ChangeReasonDialog()

ChangeReasonDialog	(	const std::vector< dq::domain::change_reason > &	reasons,
		OperationType	operation,
		bool	hasFieldChanges,
		QWidget *	parent = `nullptr`
	)

explicit

Construct the dialog.

Parameters

reasons	List of applicable change reasons (from ChangeReasonCache)
operation	Type of operation (Create, Amend or Delete)
hasFieldChanges	True if any entity fields have been modified. When false, this is a "touch" operation and only "common.non_material_update" is valid. When true, "common.non_material_update" is disabled. Ignored for Create operations (all reasons are always enabled).
parent	Parent widget

Member Function Documentation

◆ selectedReasonCode()

std::string selectedReasonCode ( ) const

Get the selected reason code.

Returns: The code of the selected reason (e.g., "common.rectification")

Here is the caller graph for this function:

◆ commentary()

std::string commentary ( ) const

Get the commentary entered by the user.

Returns: Commentary text (may be empty if not required)