GUIHelpers.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2022.
//
// 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: Chris Bielow $
// $Authors: Chris Bielow $
// --------------------------------------------------------------------------

#pragma once

#include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
#include <OpenMS/DATASTRUCTURES/ListUtils.h>
#include <OpenMS/FORMAT/FileHandler.h>


// declare Qt classes OUTSIDE of namespace OpenMS!
class QPainter;
class QPoint;
class QString; 
class QStringList;
class QWidget;

#include <QColor>
#include <QFont>

#include <array>

namespace OpenMS
{

  class FileTypeList;

  namespace GUIHelpers
  {
    
    OPENMS_GUI_DLLAPI void openFolder(const QString& folder);


    OPENMS_GUI_DLLAPI QString getSaveFilename(QWidget* parent,
                                              const QString& caption,
                                              const QString& dir,
                                              FileTypeList supported_file_types, 
                                              bool add_all_filter,
                                              const FileTypes::Type fallback_extension);


    OPENMS_GUI_DLLAPI void startTOPPView(const QStringList& args);

    OPENMS_GUI_DLLAPI void openURL(const QString& target);

    OPENMS_GUI_DLLAPI void drawText(QPainter& painter, const QStringList& text, const QPoint& where, const QColor col_fg = QColor("invalid"), const QColor col_bg = QColor("invalid"),
                                   const QFont& font = QFont("Courier"));


    OPENMS_GUI_DLLAPI QRectF getTextDimension(const QStringList& text, const QFont& font, int& line_spacing);


    class OPENMS_GUI_DLLAPI OverlapDetector
    {
    public:
      explicit OverlapDetector(int levels);

      size_t placeItem(double x_start, double x_end);

    private:
      std::vector<double> rows_; 
    };

    class OPENMS_GUI_DLLAPI GUILock
    {
    public:
      GUILock(QWidget* gui);

      GUILock(const GUILock& rhs) = delete;
      GUILock(GUILock&& rhs) = delete;
      GUILock& operator=(const GUILock& rhs) = delete;

      ~GUILock();
      
      void lock();
      void unlock();

    private:
      QWidget* locked_widget_{ nullptr };
      bool currently_locked_{ false };
      bool was_enabled_{ true };
    };

    class ColorBrewer
    {
    public:
      struct Distinct
      {
        enum NAMES
        {
          Red,
          Blue,
          Green,
          Brown,
          Purple,
          LightGrey,
          LightGreen,
          LightBlue,
          Cyan,
          Orange,
          Yellow,
          Tan,
          Pink,
          DarkGrey,
          SIZE_OF_NAMES
        };

        const std::array<QColor, NAMES::SIZE_OF_NAMES> values = { { Qt::red,
                                                                    Qt::blue,
                                                                    Qt::green,
                                                                    QColor(129, 74, 25) /*brown*/,
                                                                    QColor(129, 38, 192) /*purple*/,
                                                                    Qt::lightGray,
                                                                    QColor(129,197,122) /*lightGreen*/,
                                                                    QColor(157,175,255) /*lightBlue*/,
                                                                    Qt::cyan,
                                                                    QColor(255,146,51) /*orange*/,
                                                                    Qt::yellow,
                                                                    QColor(233,222,187) /*tan*/,
                                                                    QColor(255,205,243) /*pink*/,
                                                                    Qt::darkGray } };
      };

      template<class COLOR_CLASS>
      static QColor getColor(uint32_t index)
      {
        // cycle if necessary
        if (index >= COLOR_CLASS::NAMES::SIZE_OF_NAMES) index = index % COLOR_CLASS::NAMES::SIZE_OF_NAMES;
        return COLOR_CLASS().values[index];
      }
    }; // ColorBrewer

    OPENMS_GUI_DLLAPI StringList convert(const QStringList& in);
    OPENMS_GUI_DLLAPI QStringList convert(const StringList& in);

  }; // GUIHelpers
}