Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
QmitkXnatProjectWidget Class Reference

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

#include <QmitkXnatProjectWidget.h>

Inheritance diagram for QmitkXnatProjectWidget:
Collaboration diagram for QmitkXnatProjectWidget:

Public Types

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

Public Member Functions

 QmitkXnatProjectWidget (QWidget *parent=nullptr)
 Construct the widget in INFO mode. More...
 
 QmitkXnatProjectWidget (Mode mode, QWidget *parent=nullptr)
 Construct the widget in the specified mode. More...
 
 ~QmitkXnatProjectWidget () override
 Destructor. More...
 
void SetProject (ctkXnatProject *project)
 Populate the widget fields from the given project object. More...
 
ctkXnatProject * GetProject () const
 Retrieve the project object, optionally updated with user-entered values. More...
 

Protected Attributes

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

Detailed Description

Widget for displaying or editing XNAT project properties.

QmitkXnatProjectWidget provides a form-based user interface for viewing or creating XNAT projects. In INFO mode, the widget shows the project name, description, and principal investigator in read-only fields (the ID field is hidden). In CREATE mode, all fields including the project ID are visible and editable.

See also
QmitkXnatCreateObjectDialog, QmitkXnatSubjectWidget, QmitkXnatExperimentWidget, ctkXnatProject

Definition at line 38 of file QmitkXnatProjectWidget.h.

Member Enumeration Documentation

◆ Mode

Operation mode for the project widget.

Enumerator
INFO 

Display project properties in read-only mode.

CREATE 

Allow editing of project properties for creation.

Definition at line 46 of file QmitkXnatProjectWidget.h.

Constructor & Destructor Documentation

◆ QmitkXnatProjectWidget() [1/2]

QmitkXnatProjectWidget::QmitkXnatProjectWidget ( QWidget *  parent = nullptr)

Construct the widget in INFO mode.

Parameters
[in]parentOptional parent widget.

◆ QmitkXnatProjectWidget() [2/2]

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

Construct the widget in the specified mode.

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

◆ ~QmitkXnatProjectWidget()

QmitkXnatProjectWidget::~QmitkXnatProjectWidget ( )
override

Destructor.

Member Function Documentation

◆ GetProject()

ctkXnatProject* QmitkXnatProjectWidget::GetProject ( ) const

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

In CREATE mode, the returned project has its ID, name, and description properties updated from the widget's input fields. In INFO mode, the project is returned unchanged.

Returns
Pointer to the ctkXnatProject with current widget values applied.

◆ SetProject()

void QmitkXnatProjectWidget::SetProject ( ctkXnatProject *  project)

Populate the widget fields from the given project object.

Sets the name, description, and principal investigator fields from the project's properties.

Parameters
[in]projectThe XNAT project whose properties should be displayed.
Precondition
project must not be nullptr.

Member Data Documentation

◆ m_Controls

std::unique_ptr<Ui::QmitkXnatProjectWidgetControls> QmitkXnatProjectWidget::m_Controls
protected

UI controls generated from the .ui form.

Definition at line 94 of file QmitkXnatProjectWidget.h.


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