qSlicerCLIProgressBar.h

Go to the documentation of this file.

/*==============================================================================
 
  Program: 3D Slicer
 
  Copyright (c) Kitware Inc.
 
  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.
 
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
 
  This file was originally developed by Jean-Christophe Fillion-Robin, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1
 
==============================================================================*/
 
#ifndef __qSlicerCLIProgressBar_h
#define __qSlicerCLIProgressBar_h
 
// Qt includes
#include <QMetaType>
#include <QWidget>
 
// CTK includes
#include <ctkVTKObject.h>
 
// Slicer includes
#include "qSlicerBaseQTCLIExport.h"
 
class vtkMRMLCommandLineModuleNode;
class qSlicerCLIProgressBarPrivate;
 
class Q_SLICER_BASE_QTCLI_EXPORT qSlicerCLIProgressBar : public QWidget
{
  Q_OBJECT
  Q_ENUMS(Visibility)
  QVTK_OBJECT

  Q_PROPERTY(Visibility nameVisibility READ nameVisibility WRITE setNameVisibility)
  Q_PROPERTY(Visibility statusVisibility READ statusVisibility WRITE setStatusVisibility)
  Q_PROPERTY(Visibility progressVisibility READ progressVisibility WRITE setProgressVisibility)
public:
  typedef QWidget Superclass;
  qSlicerCLIProgressBar(QWidget* parent = nullptr);
  ~qSlicerCLIProgressBar() override;

  Q_INVOKABLE vtkMRMLCommandLineModuleNode* commandLineModuleNode() const;

  enum Visibility
  {
    AlwaysHidden = 0,
    AlwaysVisible,
    HiddenWhenIdle,
    VisibleAfterCompletion
  };

  Visibility nameVisibility() const;
  Visibility statusVisibility() const;
  Visibility progressVisibility() const;
 
public slots:

  void setCommandLineModuleNode(vtkMRMLCommandLineModuleNode* commandLineModuleNode);

  void setNameVisibility(qSlicerCLIProgressBar::Visibility visibility);

  void setStatusVisibility(qSlicerCLIProgressBar::Visibility visibility);

  void setProgressVisibility(qSlicerCLIProgressBar::Visibility visibility);
 
protected slots:

  void updateUiFromCommandLineModuleNode(vtkObject* commandLineModuleNode);

  void showDetails(bool show);
 
protected:
  QScopedPointer<qSlicerCLIProgressBarPrivate> d_ptr;
 
private:
  Q_DECLARE_PRIVATE(qSlicerCLIProgressBar);
  Q_DISABLE_COPY(qSlicerCLIProgressBar);
};
 
#endif