/usr/include/gofigure2/QGoTabElementBase.h

/*=========================================================================
 Authors: The GoFigure Dev. Team.
 at Megason Lab, Systems biology, Harvard Medical school, 2009-11

 Copyright (c) 2009-11, President and Fellows of Harvard College.
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

 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 the  President and Fellows of Harvard College
 nor the names of its contributors may be used to endorse or promote
 products derived from this software without specific prior written
 permission.

 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 THE COPYRIGHT OWNER OR CONTRIBUTORS
 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.

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

#ifndef __QGoTabElementBase_h
#define __QGoTabElementBase_h

#include <QMainWindow>
#include <QDir>
#include <QStatusBar>

#include "QGoPlugin.h"
#include "QGoDockWidgetStatus.h"

#include "QGoGUILibConfigure.h"
#include "QGoTraceSettingsWidget.h"
#include "QGoToolBarStatus.h"

class QAction;
class QActionGroup;
class QMenu;
class QToolBar;
class QDockWidget;
class QGoPluginManager;

/**
\class QGoTabElementBase
\brief Abstract class for one tab element in GoFigure2.
\example GUI/lib/qgotabelementbase.cxx
*/
class QGOGUILIB_EXPORT QGoTabElementBase:public QMainWindow
{
  Q_OBJECT
public:
  /** \brief Constructor */
  explicit QGoTabElementBase(QWidget *parent = 0);

  /** \brief Destructor */
  virtual ~QGoTabElementBase();

  typedef std::pair< QGoDockWidgetStatus *, QDockWidget * > QGoDockWidgetStatusPair;

  /** \brief Get the dimension type of the underlying data set.*/
  virtual GoFigure::TabDimensionType GetTabDimensionType() const = 0;

  virtual std::list< QGoToolBarStatus* > GetToolBarsStatus();

  /** \brief Get all actions belonging to View Menu and Toolbar.*/
  virtual std::vector< QAction * > ViewActions();

  /** \brief Get all actions belonging to View Menu only.*/
  virtual std::vector< QAction * > ViewNoToolBarActions();

  /** \brief Get all actions belonging to Segmentation Menu and Toolbar. */
  virtual std::vector< QAction * > SegmentationActions();

  /** \brief Get all actions belonging to Tools Menu and Toolbar. */
  virtual std::vector< QAction * > ToolsActions();

  /** \brief Get all actions belonging to Bookmark Menu and Toolbar. */
  virtual std::vector< QAction * > BookmarkActions();

  /** \brief Get all actions belonging to Mode Menu and Toolbar.*/
  //virtual std::vector< QAction * > ModeActions();

  /** \brief Get all actions belonging to the Traces Toolbar.*/
  //virtual std::vector< QAction * > TracesActions();
  //virtual QGoToolBarStatus* TracesActions();

  /** \brief Get the widget for the trace settings to be added in the TraceSettings Toolbar*/
  //virtual QGoTraceSettingsWidget* TraceSettingsWidget();

  /** \brief Get all the DockWidgets with its status (visibility, location). */
  virtual std::list< QGoDockWidgetStatusPair > & DockWidget();

//   virtual QStatusBar* StatusBar();

  virtual std::list< QAction * > GetPluginActions();

  virtual void SetPluginActions(std::list< QAction * > iList);

  /** \brief Write Settings for the tab element. */
  virtual void WriteSettings() = 0;

  /** \brief Read Settings for the related tab element.*/
  virtual void ReadSettings() = 0;

  /**
   * \brief Mouse interaction style set as default
   */
  virtual void DefaultInteractorBehavior(bool){}
  /**
   * \brief Mouse interaction style allows user to zoom in/out volume with all
   * buttons
   */
  virtual void ZoomInteractorBehavior(bool){}
  /**
   * \brief Mouse interaction style allows user to Translate volume with all buttons
   */
  virtual void TranslateInteractorBehavior(bool){}

  void SetStatusBarPointer(QStatusBar* iStatusbar);

  //virtual void SetTraceSettingsToolBar(QToolBar* iToolBar);

  virtual void CreateModeToolBar(QMenu* iMenu, QToolBar* iToolBar);
  virtual void CreateViewToolBar(QMenu* iMenu, QToolBar* iToolBar);

protected:
  std::list< QAction * > m_PluginActionList;

  std::vector< QAction * > m_ViewActions;
  QGoToolBarStatus*        m_ViewActionsMenuToolBar;
  std::vector< QAction* >  m_ViewNoToolBarActions;
  std::vector< QAction * > m_SegmentationActions;
  std::vector< QAction * > m_ToolsActions;
  std::vector< QAction * > m_BookmarkActions;
  //std::vector< QAction * > m_ModeActions;
  QGoToolBarStatus*        m_ModeToolBar;
  //std::vector< QAction * > m_TracesActions;
  //QGoToolBarStatus*        m_TracesActions;
  //QGoTraceSettingsWidget*  m_TraceSettingsWidgetForToolBar;
  //QToolBar*                m_TraceSettingsToolBar;

  std::list< QGoDockWidgetStatusPair >  m_DockWidgetList;
  std::list< QGoToolBarStatus* >        m_ToolBarList;
  QStatusBar*                           m_StatusBar;

private:
  Q_DISABLE_COPY(QGoTabElementBase);
};
#endif
libgofigure-dev 0.9.0-3+b1 / usr / include / gofigure2 / QGoTabElementBase.h
