TOPPViewMenu.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-2023.
//
// 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
 
// OpenMS_GUI config
#include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
 
#include <OpenMS/DATASTRUCTURES/FlagSet.h>
#include <OpenMS/KERNEL/StandardTypes.h>
#include <OpenMS/VISUAL/EnhancedWorkspace.h>
#include <OpenMS/VISUAL/LayerDataBase.h>
 
#include <QObject>
 
#include <vector>
 
class QAction;
class QMenu;
 
namespace OpenMS
{
  class TOPPViewBase;
  class EnhancedWorkspace;
  class RecentFilesMenu;
  
  enum class TV_STATUS
  {
    HAS_CANVAS,
    HAS_LAYER,
    HAS_MIRROR_MODE,  // implies 1D View
    IS_1D_VIEW,
    TOPP_IDLE
  };
  
  using FS_TV = FlagSet<TV_STATUS>;
  FS_TV OPENMS_GUI_DLLAPI operator+(const TV_STATUS left, const TV_STATUS right);
 
  using FS_LAYER = FlagSet<LayerDataBase::DataType>;
  FS_LAYER OPENMS_GUI_DLLAPI operator+(const LayerDataBase::DataType left, const LayerDataBase::DataType right);
 
 
  class TOPPViewMenu
    : public QObject
  {
    Q_OBJECT
  public:
    TOPPViewMenu(TOPPViewBase* const parent, EnhancedWorkspace* const ws, RecentFilesMenu* const recent_files);
 
    void addWindowToggle(QAction* const window_toggle);
 
  public slots:
    void update(const FS_TV status, const LayerDataBase::DataType layer_type);
 
  private:
    struct ActionRequirement_
    {
      ActionRequirement_(QAction* action, const FS_TV& needs, const FS_LAYER layer_set)
        : action_(action), needs_(needs), layer_set_(layer_set) {}
      ActionRequirement_(QAction* action, const TV_STATUS& needs, const FS_LAYER layer_set)
        : action_(action), needs_(needs), layer_set_(layer_set) {}
 
      void enableAction(const FS_TV status, const LayerDataBase::DataType layer_type);
 
    private:
      QAction* action_;
      FS_TV needs_;
      FS_LAYER layer_set_;
    };
 
    QAction* addAction_(QAction* action, const TV_STATUS req, const FS_LAYER layer_set = FS_LAYER());
    QAction* addAction_(QAction* action, const FS_TV req, const FS_LAYER layer_set = FS_LAYER());
 
    std::vector<ActionRequirement_> menu_items_;
 
    QMenu* m_windows_;
  };
 
} //namespace