Slicer  5.0
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Slots | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes
qMRMLViewControllerBar Class Reference

#include <Libs/MRML/Widgets/qMRMLViewControllerBar.h>

Inheritance diagram for qMRMLViewControllerBar:
Inheritance graph
[legend]
Collaboration diagram for qMRMLViewControllerBar:
Collaboration graph
[legend]

Public Types

enum  LayoutBehavior { Popup =0, Panel }
 
typedef qMRMLWidget Superclass
 Superclass typedef. More...
 
- Public Types inherited from qMRMLWidget
typedef QWidget Superclass
 

Public Slots

void maximizeView ()
 
- Public Slots inherited from qMRMLWidget
virtual void setMRMLScene (vtkMRMLScene *newScene)
 Set the MRML scene associated with the widget. More...
 

Public Member Functions

Q_INVOKABLE QLayout * barLayout ()
 
Q_INVOKABLE QWidget * barWidget ()
 
Q_INVOKABLE QToolButton * pinButton ()
 Push-pin icon that shows additional options when clicked. More...
 
 qMRMLViewControllerBar (QWidget *parent=nullptr)
 Constructors. More...
 
Q_INVOKABLE void setLayoutBehavior (LayoutBehavior behavior)
 
Q_INVOKABLE QLabel * viewLabel ()
 Label that displays the view's name. More...
 
 ~qMRMLViewControllerBar () override
 
- Public Member Functions inherited from qMRMLWidget
Q_INVOKABLE vtkMRMLScenemrmlScene () const
 Return a pointer on the current MRML scene. More...
 
 qMRMLWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
 
 ~qMRMLWidget () override
 

Protected Slots

virtual void updateWidgetFromMRMLView ()
 

Protected Member Functions

virtual vtkMRMLAbstractViewNodemrmlViewNode () const
 
 qMRMLViewControllerBar (qMRMLViewControllerBarPrivate *pimpl, QWidget *parent=nullptr)
 
virtual void setMRMLViewNode (vtkMRMLAbstractViewNode *viewNode)
 

Protected Attributes

QScopedPointer< qMRMLViewControllerBarPrivate > d_ptr
 
- Protected Attributes inherited from qMRMLWidget
QScopedPointer< qMRMLWidgetPrivate > d_ptr
 

Additional Inherited Members

- Signals inherited from qMRMLWidget
void mrmlSceneChanged (vtkMRMLScene *)
 
- Static Public Member Functions inherited from qMRMLWidget
static Q_INVOKABLE QPixmap pixmapFromIcon (const QIcon &icon)
 
static Q_INVOKABLE void postInitializeApplication ()
 Initialization that needs to be performed after application object is created. More...
 
static Q_INVOKABLE void preInitializeApplication ()
 

Detailed Description

qMRMLViewControllerBar is the base class of all the bars over views. A controller bar typically contains a pin button, a view label to uniquely define a view, a popup widget to control the view and a unique color per type of view. The popup widget can be made occupy space in the widget and is then displayed below the bar.

Definition at line 55 of file qMRMLViewControllerBar.h.

Member Typedef Documentation

◆ Superclass

Superclass typedef.

Definition at line 63 of file qMRMLViewControllerBar.h.

Member Enumeration Documentation

◆ LayoutBehavior

Enumerator
Popup 
Panel 

Definition at line 69 of file qMRMLViewControllerBar.h.

Constructor & Destructor Documentation

◆ qMRMLViewControllerBar() [1/2]

qMRMLViewControllerBar::qMRMLViewControllerBar ( QWidget *  parent = nullptr)
explicit

Constructors.

◆ ~qMRMLViewControllerBar()

qMRMLViewControllerBar::~qMRMLViewControllerBar ( )
override

◆ qMRMLViewControllerBar() [2/2]

qMRMLViewControllerBar::qMRMLViewControllerBar ( qMRMLViewControllerBarPrivate *  pimpl,
QWidget *  parent = nullptr 
)
protected

Member Function Documentation

◆ barLayout()

Q_INVOKABLE QLayout* qMRMLViewControllerBar::barLayout ( )

Get the layout for the "bar" in the view controller. This layout is an HBoxLayout. It is packed in a VBoxLayout that contains the "bar" and other controllers.

◆ barWidget()

Q_INVOKABLE QWidget* qMRMLViewControllerBar::barWidget ( )

Get the widget for the "bar" in the view controller. This is the part of the controller that is visible even when view controller is not pinned.

◆ maximizeView

void qMRMLViewControllerBar::maximizeView ( )
slot

◆ mrmlViewNode()

virtual vtkMRMLAbstractViewNode* qMRMLViewControllerBar::mrmlViewNode ( ) const
protectedvirtual

◆ pinButton()

Q_INVOKABLE QToolButton* qMRMLViewControllerBar::pinButton ( )

Push-pin icon that shows additional options when clicked.

◆ setLayoutBehavior()

Q_INVOKABLE void qMRMLViewControllerBar::setLayoutBehavior ( LayoutBehavior  behavior)

Set the behavior of the controller, i.e. should it be a popup or should it occupy space within the widget? (not certain that this method can be called multiple times to toggle between the behaviors)

◆ setMRMLViewNode()

virtual void qMRMLViewControllerBar::setMRMLViewNode ( vtkMRMLAbstractViewNode viewNode)
protectedvirtual

◆ updateWidgetFromMRMLView

virtual void qMRMLViewControllerBar::updateWidgetFromMRMLView ( )
protectedvirtualslot

◆ viewLabel()

Q_INVOKABLE QLabel* qMRMLViewControllerBar::viewLabel ( )

Label that displays the view's name.

Member Data Documentation

◆ d_ptr

QScopedPointer<qMRMLViewControllerBarPrivate> qMRMLViewControllerBar::d_ptr
protected

Definition at line 102 of file qMRMLViewControllerBar.h.


The documentation for this class was generated from the following file: