2.6.0/html/TOPPASBase_8h_source.html

// --------------------------------------------------------------------------

//                   OpenMS -- Open-Source Mass Spectrometry

// --------------------------------------------------------------------------

// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,

// ETH Zurich, and Freie Universitaet Berlin 2002-2020.

//

// This software is released under a three-clause BSD license:

//  * Redistributions of source code must retain the above copyright

//    notice, this list of conditions and the following disclaimer.

//  * Redistributions in binary form must reproduce the above copyright

//    notice, this list of conditions and the following disclaimer in the

//    documentation and/or other materials provided with the distribution.

//  * Neither the name of any author or any participating institution

//    may be used to endorse or promote products derived from this software

//    without specific prior written permission.

// For a full list of authors, refer to the file AUTHORS.

// --------------------------------------------------------------------------

// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING

// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;

// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,

// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR

// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF

// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

//

// --------------------------------------------------------------------------

// $Maintainer: Johannes Veit $

// $Authors: Johannes Junker, Chris Bielow $

// --------------------------------------------------------------------------


#pragma once


// OpenMS_GUI config

#include <OpenMS/VISUAL/OpenMS_GUIConfig.h>


//OpenMS

#include <OpenMS/DATASTRUCTURES/DefaultParamHandler.h>

#include <OpenMS/VISUAL/TOPPASTreeView.h>


//QT

#include <QtWidgets/QMainWindow>

#include <QtWidgets/QMdiArea>

#include <QtWidgets/QButtonGroup>

#include <QtCore/QProcess>

#include <QtWidgets/QSplashScreen>

#include <QtNetwork/QNetworkReply>


class QToolBar;

class QListWidget;

class QTextEdit;

class QMdiArea;

class QLabel;

class QWidget;

class QTreeWidget;

class QTreeWidgetItem;

class QWebView;

class QNetworkAccessManager;


namespace OpenMS

{

  class TOPPASWidget;

  class TOPPASScene;

  class TOPPASTabBar;

  class TOPPASLogWindow;

  class TOPPASResources;


  class OPENMS_GUI_DLLAPI TOPPASBase :

    public QMainWindow,

    public DefaultParamHandler

  {

    Q_OBJECT


public:


    TOPPASBase(QWidget* parent = nullptr);

    ~TOPPASBase() override;


    void loadPreferences(String filename = "");

    void savePreferences();

    void loadFiles(const StringList& list, QSplashScreen* splash_screen);


public slots:

    void addTOPPASFile(const String& file_name, bool in_new_window = true);

    void openFileDialog();

    void openExampleDialog();

    void newPipeline(const int id = -1);

    void includePipeline();

    void saveCurrentPipelineAs();

    void savePipeline();

    void exportAsImage();

    void loadPipelineResourceFile();

    void savePipelineResourceFile();

    void openOnlinePipelineRepository();

    void preferencesDialog();

    void updateCurrentPath();

    void updateTabBar(QMdiSubWindow* w);

    void showAboutDialog();

    void showURL();

    void showStatusMessage(std::string msg, OpenMS::UInt time);

    void showCursorStatus(double x, double y);

    void closeFile();

    void updateToolBar();

    void runPipeline();

    void abortPipeline();

    void toolStarted();

    void toolFinished();

    void toolCrashed();

    void toolFailed();

    void outputVertexFinished(const String& file);

    void updateTOPPOutputLog(const QString& out);

    void showPipelineFinishedLogMessage();

    void saveToClipboard(TOPPASScene* scene);

    void sendClipboardContent();

    void refreshParameters();

    void openFilesInTOPPView(QStringList all_files);

    void openToppasFile(QString filename);

protected slots:


    void closeByTab(int id);

    void focusByTab(int id);


    void updateMenu();

    void showAsWindow_(TOPPASWidget* sw, const String& caption, const int special_id = -1);

    void insertNewVertex_(double x, double y, QTreeWidgetItem* item = nullptr);

    void insertNewVertexInCenter_(QTreeWidgetItem* item);


    void downloadTOPPASfromHomepage_(const QUrl& url);

    void toppasFileDownloaded_(QNetworkReply* r);

    void TOPPASreadyRead();


    void descriptionUpdated_();


protected:


    TOPPASLogWindow* log_;

    QTextEdit* desc_;


    QToolBar* tool_bar_;


    QMdiArea* ws_;


    QWebView* webview_;

    QNetworkAccessManager* network_manager_;

    QNetworkReply* network_reply_;


    TOPPASTabBar* tab_bar_;


    QTreeWidget* tools_tree_view_;

    QListWidget* blocks_list_;


    QLabel* message_label_;


    TOPPASWidget* window_(int id) const;


    String current_path_;


    String tmp_path_;


    static int node_offset_;


    static qreal z_value_;


    TOPPASWidget* activeSubWindow_() const;


    void closeEvent(QCloseEvent* event) override;

    void keyPressEvent(QKeyEvent* e) override;


    enum LogState

    {

      LS_NOTICE,

      LS_WARNING,

      LS_ERROR

    };

    void showLogMessage_(LogState state, const String& heading, const String& body);


    TOPPASScene* clipboard_scene_;


public:

    static int const IDINITIALUNTITLED = 1000;


    static TOPPASTreeView* createTOPPToolsTreeWidget(QWidget* parent_widget = nullptr);


    static QString savePipelineAs(TOPPASWidget* w, QString current_path);


    static QString loadPipelineResourceFile(TOPPASWidget* w, QString current_path);


    static QString savePipelineResourceFile(TOPPASWidget* w, QString current_path);


    static QString refreshPipelineParameters(TOPPASWidget* tw, QString current_path);

  }; //class


} //namespace