Slicer  5.0
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Properties | Public Slots | Public Member Functions | Protected Slots | Protected Attributes
qSlicerCLIProgressBar Class Reference

#include <Base/QTCLI/qSlicerCLIProgressBar.h>

Inheritance diagram for qSlicerCLIProgressBar:
Inheritance graph
[legend]
Collaboration diagram for qSlicerCLIProgressBar:
Collaboration graph
[legend]

Public Types

typedef QWidget Superclass
 
enum  Visibility { AlwaysHidden = 0, AlwaysVisible, HiddenWhenIdle, VisibleAfterCompletion }
 Visibility behavior of the GUI elements of the CLI progress bar. More...
 

Properties

Visibility nameVisibility
 
Visibility progressVisibility
 
Visibility statusVisibility
 

Public Slots

void setCommandLineModuleNode (vtkMRMLCommandLineModuleNode *commandLineModuleNode)
 Set the commandLineModuleNode. More...
 
void setNameVisibility (qSlicerCLIProgressBar::Visibility visibility)
 
void setProgressVisibility (qSlicerCLIProgressBar::Visibility visibility)
 
void setStatusVisibility (qSlicerCLIProgressBar::Visibility visibility)
 

Public Member Functions

Q_INVOKABLE vtkMRMLCommandLineModuleNodecommandLineModuleNode () const
 Get the commandLineModuleNode. More...
 
Visibility nameVisibility () const
 
Visibility progressVisibility () const
 
 qSlicerCLIProgressBar (QWidget *parent=nullptr)
 
Visibility statusVisibility () const
 
 ~qSlicerCLIProgressBar () override
 

Protected Slots

void showDetails (bool show)
 Update the ui base on the command line module node. More...
 
void updateUiFromCommandLineModuleNode (vtkObject *commandLineModuleNode)
 Update the ui base on the command line module node. More...
 

Protected Attributes

QScopedPointer< qSlicerCLIProgressBarPrivate > d_ptr
 

Detailed Description

Definition at line 37 of file qSlicerCLIProgressBar.h.

Member Typedef Documentation

◆ Superclass

Definition at line 60 of file qSlicerCLIProgressBar.h.

Member Enumeration Documentation

◆ Visibility

Visibility behavior of the GUI elements of the CLI progress bar.

Enumerator
AlwaysHidden 
AlwaysVisible 
HiddenWhenIdle 
VisibleAfterCompletion 

Definition at line 68 of file qSlicerCLIProgressBar.h.

Property Documentation

◆ nameVisibility

Visibility qSlicerCLIProgressBar::nameVisibility
readwrite

This property controls how the module name is visible. AlwaysHidden by default.

See also
nameVisibility(), setNameVisibility(), nameVisibility

Definition at line 47 of file qSlicerCLIProgressBar.h.

◆ progressVisibility

Visibility qSlicerCLIProgressBar::progressVisibility
readwrite

This property controls how the progress bar is visible. VisibleAfterCompletion by default.

See also
progressVisibility(), setProgressVisibility(), progressVisibility

Definition at line 57 of file qSlicerCLIProgressBar.h.

◆ statusVisibility

Visibility qSlicerCLIProgressBar::statusVisibility
readwrite

This property controls how the status label is visible. AlwaysVisible by default.

See also
statusVisibility(), setStatusVisibility(), statusVisibility

Definition at line 52 of file qSlicerCLIProgressBar.h.

Constructor & Destructor Documentation

◆ qSlicerCLIProgressBar()

qSlicerCLIProgressBar::qSlicerCLIProgressBar ( QWidget *  parent = nullptr)

◆ ~qSlicerCLIProgressBar()

qSlicerCLIProgressBar::~qSlicerCLIProgressBar ( )
override

Member Function Documentation

◆ commandLineModuleNode()

Q_INVOKABLE vtkMRMLCommandLineModuleNode* qSlicerCLIProgressBar::commandLineModuleNode ( ) const

Get the commandLineModuleNode.

◆ nameVisibility()

Visibility qSlicerCLIProgressBar::nameVisibility ( ) const

Visibility of the module name.

See also
nameVisibility

◆ progressVisibility()

Visibility qSlicerCLIProgressBar::progressVisibility ( ) const

Visibility of the progress bar.

See also
progressVisiblity

◆ setCommandLineModuleNode

void qSlicerCLIProgressBar::setCommandLineModuleNode ( vtkMRMLCommandLineModuleNode commandLineModuleNode)
slot

Set the commandLineModuleNode.

◆ setNameVisibility

void qSlicerCLIProgressBar::setNameVisibility ( qSlicerCLIProgressBar::Visibility  visibility)
slot

Set the module name visibility

See also
nameVisibility

◆ setProgressVisibility

void qSlicerCLIProgressBar::setProgressVisibility ( qSlicerCLIProgressBar::Visibility  visibility)
slot

Set the progress bar visibility

See also
progressVisibility

◆ setStatusVisibility

void qSlicerCLIProgressBar::setStatusVisibility ( qSlicerCLIProgressBar::Visibility  visibility)
slot

Set the status label visibility

See also
statusVisibility

◆ showDetails

void qSlicerCLIProgressBar::showDetails ( bool  show)
protectedslot

Update the ui base on the command line module node.

◆ statusVisibility()

Visibility qSlicerCLIProgressBar::statusVisibility ( ) const

Visibility of the status label.

See also
statusVisibility

◆ updateUiFromCommandLineModuleNode

void qSlicerCLIProgressBar::updateUiFromCommandLineModuleNode ( vtkObject *  commandLineModuleNode)
protectedslot

Update the ui base on the command line module node.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerCLIProgressBarPrivate> qSlicerCLIProgressBar::d_ptr
protected

Definition at line 113 of file qSlicerCLIProgressBar.h.


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