qMRMLViewControllerBar.h

Go to the documentation of this file.

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

  Program: 3D Slicer

  Copyright (c) Kitware Inc.

  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

  This file was originally developed by Julien Finet, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1

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

#ifndef __qMRMLViewControllerBar_h
#define __qMRMLViewControllerBar_h

// QT includes
class QLayout;

// qMRMLWidget includes
#include "qMRMLWidget.h"
#include "qMRMLWidgetsExport.h"
class qMRMLViewControllerBarPrivate;

//
// Widget layout:
//   VBoxLayout (ControllerLayout)
//      Widget (BarWidget)
//        HBoxLayout (BarLayout)
//      Optional PopupWidget (can be statically displayed under BarWidget if ControllerBar is a panel)
//
//
// To add widgets to the "bar" section, add them to the barLayout().
// To add widgets to the "controller" section (when not using a
// popup), add them to the layout().
//
class QMRML_WIDGETS_EXPORT qMRMLViewControllerBar
  : public qMRMLWidget
{
  Q_OBJECT
public:
  typedef qMRMLWidget Superclass;

  explicit qMRMLViewControllerBar(QWidget* parent = 0);
  virtual ~qMRMLViewControllerBar();

  enum LayoutBehavior {
    Popup=0,
    Panel
  };

  void setLayoutBehavior(LayoutBehavior behavior);

  // get the layout for the "bar" in the view controller. this layout
  // is an HBoxLayout. It itself is packed in a VBoxLayout that
  // contains the "bar" and other controllers.
  QLayout* barLayout();

  // get the widget for the "bar" in the view controller.
  QWidget* barWidget();

protected:
  QScopedPointer<qMRMLViewControllerBarPrivate> d_ptr;
  qMRMLViewControllerBar(qMRMLViewControllerBarPrivate* pimpl, QWidget* parent = 0);

private:
  Q_DECLARE_PRIVATE(qMRMLViewControllerBar);
  Q_DISABLE_COPY(qMRMLViewControllerBar);
};

#endif