#pragma once
/*=========================================================================

 medInria

 Copyright (c) INRIA 2013 - 2020. All rights reserved.
 See LICENSE.txt for details.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

=========================================================================*/

#include <QWidget>
#include <QtCore>

#include <medCoreLegacyExport.h>

class medToolBox;
class medDataIndex;
class medAbstractData;

/**
 * @class medAbstractDataSource
 * @brief Abstract base class for dynamic data sources, e.g. plugins that act as database clients
 * This class defines access methods to the following widgets: a mainViewWidget,
 * a source selection widget and several ToolBoxes.
 * All dynamic data source implementation should derive from this class.
 **/
class MEDCORELEGACY_EXPORT medAbstractDataSource : public QObject
{
    Q_OBJECT

public:
    medAbstractDataSource(QWidget *parent = nullptr);
    ~medAbstractDataSource();

    /**
    * Returns the main view widget
    * This widget is used to navigate within the data, e.g. a qTreeWidget
    */
    virtual QWidget *mainViewWidget() = 0;

    /**
    * Returns the source selector widget
    * A widget that let's the user choose between different data locations
    */
    virtual QWidget *sourceSelectorWidget() = 0;

    /** Returns the tab name for the plugin using the data source*/
    virtual QString tabName() = 0;

    /** Returns all ToolBoxes owned by the source data plugin*/
    virtual QList<medToolBox*> getToolBoxes() = 0;

    /** Returns a short description of the data source */
    virtual QString description() const = 0;

signals:
    /** A source data may emit a signal to a file on disk when it successfully received the data and is ready for importing*/
    void dataToImportReceived(QString pathToData);

    void dataToFetchReceived(QHash<QString, QHash<QString, QVariant> > patientData,
                             QHash<QString, QHash<QString, QVariant> > seriesData);

    /** A source data may emit a signal to a medAbstractData in memory when it successfully received the data and is ready for importing*/
    void dataReceived(medAbstractData *data);

    /** A data source emits a signal when it failed to get the data*/
    void dataReceivingFailed(QString pathToData);

    /**
     * @brief Emits this signal when the source wants to export some data to a file.
     *
     * The medBrowserArea will treat the demand based on the medDataIndex.
     * @param index
    */
    void exportData(const medDataIndex &index);

    /** emitted when the source is about to remove a data.*/
    void dataRemoved(const medDataIndex &index);

    void updateProgress(int level);

    void moveRequested(const QString &uid, const QString &queryLevel);

    void moveState(int status, const QString &pathOrMessage);
};