Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
QmitkXnatSubjectWidget Class Reference

Widget for displaying or editing XNAT subject properties. More...

#include <QmitkXnatSubjectWidget.h>

Inheritance diagram for QmitkXnatSubjectWidget:
Collaboration diagram for QmitkXnatSubjectWidget:

Public Types

enum  Mode { INFO , CREATE }
 Operation mode for the subject widget. More...
 

Public Member Functions

 QmitkXnatSubjectWidget (QWidget *parent=nullptr)
 Construct the widget in INFO mode. More...
 
 QmitkXnatSubjectWidget (Mode mode, QWidget *parent=nullptr)
 Construct the widget in the specified mode. More...
 
 ~QmitkXnatSubjectWidget () override
 Destructor. More...
 
void SetSubject (ctkXnatSubject *subject)
 Populate the widget fields from the given subject object. More...
 
ctkXnatSubject * GetSubject () const
 Retrieve the subject object, optionally updated with user-entered values. More...
 

Protected Attributes

std::unique_ptr< Ui::QmitkXnatSubjectWidgetControls > m_Controls
 UI controls generated from the .ui form. More...
 

Detailed Description

Widget for displaying or editing XNAT subject properties.

QmitkXnatSubjectWidget provides a form-based user interface for viewing or creating XNAT subjects. In INFO mode, the widget shows the subject label, date of birth, gender, handedness, height, and weight as read-only fields, along with a breadcrumb showing the parent project. In CREATE mode, all fields are editable.

See also
QmitkXnatCreateObjectDialog, QmitkXnatProjectWidget, QmitkXnatExperimentWidget, ctkXnatSubject

Definition at line 37 of file QmitkXnatSubjectWidget.h.

Member Enumeration Documentation

◆ Mode

Operation mode for the subject widget.

Enumerator
INFO 

Display subject properties in read-only mode.

CREATE 

Allow editing of subject properties for creation.

Definition at line 45 of file QmitkXnatSubjectWidget.h.

Constructor & Destructor Documentation

◆ QmitkXnatSubjectWidget() [1/2]

QmitkXnatSubjectWidget::QmitkXnatSubjectWidget ( QWidget *  parent = nullptr)

Construct the widget in INFO mode.

Parameters
[in]parentOptional parent widget.

◆ QmitkXnatSubjectWidget() [2/2]

QmitkXnatSubjectWidget::QmitkXnatSubjectWidget ( Mode  mode,
QWidget *  parent = nullptr 
)

Construct the widget in the specified mode.

Parameters
[in]modeThe operation mode (INFO or CREATE).
[in]parentOptional parent widget.

◆ ~QmitkXnatSubjectWidget()

QmitkXnatSubjectWidget::~QmitkXnatSubjectWidget ( )
override

Destructor.

Member Function Documentation

◆ GetSubject()

ctkXnatSubject* QmitkXnatSubjectWidget::GetSubject ( ) const

Retrieve the subject object, optionally updated with user-entered values.

In CREATE mode, the returned subject has its label, dob, gender, handedness, height, and weight properties updated from the widget's input fields. In INFO mode, the subject is returned unchanged.

Returns
Pointer to the ctkXnatSubject with current widget values applied.

◆ SetSubject()

void QmitkXnatSubjectWidget::SetSubject ( ctkXnatSubject *  subject)

Populate the widget fields from the given subject object.

Sets the breadcrumb, label, date of birth, gender, handedness, height, and weight fields from the subject's properties.

Parameters
[in]subjectThe XNAT subject whose properties should be displayed.
Precondition
subject must not be nullptr.

Member Data Documentation

◆ m_Controls

std::unique_ptr<Ui::QmitkXnatSubjectWidgetControls> QmitkXnatSubjectWidget::m_Controls
protected

UI controls generated from the .ui form.

Definition at line 94 of file QmitkXnatSubjectWidget.h.


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