qSlicerDirectoryListView.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 __qSlicerDirectoryListView_h
#define __qSlicerDirectoryListView_h

// Qt includes
#include <QWidget>

// QtGUI includes
#include "qSlicerBaseQTGUIExport.h"

class QDragEnterEvent;
class QDropEvent;
class qSlicerDirectoryListViewPrivate;

class Q_SLICER_BASE_QTGUI_EXPORT qSlicerDirectoryListView : public QWidget
{
  Q_OBJECT
  Q_PROPERTY(QStringList directoryList READ directoryList WRITE setDirectoryList NOTIFY directoryListChanged);
public:
  typedef QWidget Superclass;

  explicit qSlicerDirectoryListView(QWidget* parent = nullptr);

  ~qSlicerDirectoryListView() override;

  bool hasDirectory(const QString& path)const;

  QStringList directoryList(bool absolutePath = false)const;

  QStringList selectedDirectoryList(bool absolutePath = false)const;

  void dragEnterEvent(QDragEnterEvent *event) override;
  void dropEvent(QDropEvent *event) override;

public slots:

  void addDirectory(const QString& path);

  void setDirectoryList(const QStringList& paths);

  void removeDirectory(const QString& path);

  void removeSelectedDirectories();

  void selectAllDirectories();

  void clearDirectorySelection();

signals:
  void directoryListChanged();

protected:
  QScopedPointer<qSlicerDirectoryListViewPrivate> d_ptr;

private:
  Q_DECLARE_PRIVATE(qSlicerDirectoryListView);
  Q_DISABLE_COPY(qSlicerDirectoryListView);

};

#endif