pqTabbedMultiViewWidget is used to to enable adding of multiple pqMultiViewWidget instances in tabs. More...

#include <pqTabbedMultiViewWidget.h>

Inheritance diagram for pqTabbedMultiViewWidget:

Classes
class	pqTabWidget
	Internal class used as the TabWidget. More...

Public Slots
virtual int	createTab ()

virtual int	createTab (pqServer *)

virtual int	createTab (vtkSMViewLayoutProxy *)

virtual void	closeTab (int)

void	setCurrentTab (int index)
	Makes the tab at the given index current. More...

virtual void	toggleFullScreen ()
	Toggle fullscreen state for the active multi-view widget. More...

void	toggleFullScreenActiveView ()
	Toggle fullscreen state for active view only. More...

virtual void	toggleWidgetDecoration ()
	toggles decoration visibility on the current widget More...

virtual void	lockViewSize (const QSize &)
	Locks the maximum size for each view-frame to the given size. More...

virtual void	reset ()
	cleans up the layout. More...

QSize	preview (const QSize &previewSize=QSize())
	Enter (or exit) preview mode. More...


void	setDecorationsVisibility (bool)
	When set to false, all decorations including title frames, separators, tab-bars are hidden. More...

void	showDecorations ()
	When set to false, all decorations including title frames, separators, tab-bars are hidden. More...

void	hideDecorations ()
	When set to false, all decorations including title frames, separators, tab-bars are hidden. More...

Signals
void	viewSizeLocked (bool)
	fired when lockViewSize() is called. More...

void	fullScreenEnabled (bool)
	fired when toggleFullscreen() is called. More...

void	fullScreenActiveViewEnabled (bool)
	fired when toggleFullScreenActiveView() is called. More...

Public Member Functions
	pqTabbedMultiViewWidget (QWidget *parent=nullptr)

	~pqTabbedMultiViewWidget () override

virtual QSize	clientSize () const
	Returns the size for the tabs in the widget. More...

void	setReadOnly (bool val)
	When set to true (off by default), the widget will not allow adding/removing tabs trough user interactions. More...

bool	readOnly () const

void	setTabVisibility (bool visible)
	Set the tab visibility. More...

bool	tabVisibility () const

vtkSMViewLayoutProxy *	layoutProxy () const
	Return the layout proxy for the current tab. More...

bool	decorationsVisibility () const
	Returns whether frame decorations are shown. More...

pqMultiViewWidget *	findTab (vtkSMViewLayoutProxy *) const
	Locate the pqMultiViewWidget associated with the vtkSMViewLayoutProxy held by this pqTabbedMultiViewWidget instance, if any. More...

void	updateVisibleTabs ()
	While generally not necessary to call this, if the annotations for the layout proxies are changed after they are created, applications can use this method to refresh the tabs that are visible. More...

QList< QString >	visibleTabLabels () const
	This is primarily for testing purposes. More...


void	enableAnnotationFilter (const QString &annotationKey)
	APIs for filtering of tab widgets. More...

void	disableAnnotationFilter ()
	APIs for filtering of tab widgets. More...

void	setAnnotationFilterMatching (bool matching)
	APIs for filtering of tab widgets. More...

Protected Slots
virtual void	proxyAdded (pqProxy *)
	slots connects to corresponding signals on pqServerManagerObserver. More...

virtual void	proxyRemoved (pqProxy *)

virtual void	serverRemoved (pqServer *)

virtual void	currentTabChanged (int)
	called when the active tab changes. More...

virtual void	onStateLoaded ()
	verifies that all views loaded from state are indeed assigned to some view layout, or we just assign them to one. More...

void	contextMenuRequested (const QPoint &)
	called when context menu need to be created on the tab title. More...

void	onLayoutNameChanged (pqServerManagerModelItem *)

Protected Member Functions
bool	eventFilter (QObject obj, QEvent event) override

Properties
bool	readOnly

Friends
class	pqInternals

Detailed Description

pqTabbedMultiViewWidget is used to to enable adding of multiple pqMultiViewWidget instances in tabs.

This class directly listens to the server-manager to automatically create pqMultiViewWidget instances for every vtkSMViewLayoutProxy registered.

Definition at line 28 of file pqTabbedMultiViewWidget.h.

Constructor & Destructor Documentation

◆ pqTabbedMultiViewWidget()

pqTabbedMultiViewWidget::pqTabbedMultiViewWidget ( QWidget * parent = nullptr )

◆ ~pqTabbedMultiViewWidget()

pqTabbedMultiViewWidget::~pqTabbedMultiViewWidget ( )

override

Member Function Documentation

◆ clientSize()

virtual QSize pqTabbedMultiViewWidget::clientSize ( ) const

virtual

Returns the size for the tabs in the widget.

◆ setReadOnly()

void pqTabbedMultiViewWidget::setReadOnly ( bool val )

When set to true (off by default), the widget will not allow adding/removing tabs trough user interactions.

◆ readOnly()

bool pqTabbedMultiViewWidget::readOnly ( ) const

◆ setTabVisibility()

void pqTabbedMultiViewWidget::setTabVisibility ( bool visible )

Set the tab visibility.

To save some screen space when only one tab is needed, this can be set to false. True by default.

◆ tabVisibility()

bool pqTabbedMultiViewWidget::tabVisibility ( ) const

◆ layoutProxy()

vtkSMViewLayoutProxy* pqTabbedMultiViewWidget::layoutProxy ( ) const

Return the layout proxy for the current tab.

◆ decorationsVisibility()

bool pqTabbedMultiViewWidget::decorationsVisibility ( ) const

Returns whether frame decorations are shown.

◆ findTab()

pqMultiViewWidget* pqTabbedMultiViewWidget::findTab ( vtkSMViewLayoutProxy * ) const

Locate the pqMultiViewWidget associated with the vtkSMViewLayoutProxy held by this pqTabbedMultiViewWidget instance, if any.

◆ enableAnnotationFilter()

void pqTabbedMultiViewWidget::enableAnnotationFilter ( const QString & annotationKey )

APIs for filtering of tab widgets.

This matches the API exposed by pqPipelineBrowserWidget.

◆ disableAnnotationFilter()

void pqTabbedMultiViewWidget::disableAnnotationFilter ( )

APIs for filtering of tab widgets.

This matches the API exposed by pqPipelineBrowserWidget.

◆ setAnnotationFilterMatching()

void pqTabbedMultiViewWidget::setAnnotationFilterMatching ( bool matching )

APIs for filtering of tab widgets.

This matches the API exposed by pqPipelineBrowserWidget.

◆ updateVisibleTabs()

void pqTabbedMultiViewWidget::updateVisibleTabs ( )

While generally not necessary to call this, if the annotations for the layout proxies are changed after they are created, applications can use this method to refresh the tabs that are visible.

◆ visibleTabLabels()

QList<QString> pqTabbedMultiViewWidget::visibleTabLabels ( ) const

This is primarily for testing purposes.

Returns list of names for visible tabs.

◆ viewSizeLocked

void pqTabbedMultiViewWidget::viewSizeLocked ( bool )

signal

fired when lockViewSize() is called.

◆ fullScreenEnabled

void pqTabbedMultiViewWidget::fullScreenEnabled ( bool )

signal

fired when toggleFullscreen() is called.

◆ fullScreenActiveViewEnabled

void pqTabbedMultiViewWidget::fullScreenActiveViewEnabled ( bool )

signal

fired when toggleFullScreenActiveView() is called.

◆ createTab [1/3]

virtual int pqTabbedMultiViewWidget::createTab ( )

virtualslot

◆ createTab [2/3]

virtual int pqTabbedMultiViewWidget::createTab ( pqServer * )

virtualslot

◆ createTab [3/3]

virtual int pqTabbedMultiViewWidget::createTab ( vtkSMViewLayoutProxy * )

virtualslot

◆ closeTab

virtual void pqTabbedMultiViewWidget::closeTab ( int )

virtualslot

◆ setCurrentTab

void pqTabbedMultiViewWidget::setCurrentTab ( int index )

slot

Makes the tab at the given index current.

◆ setDecorationsVisibility

void pqTabbedMultiViewWidget::setDecorationsVisibility ( bool )

slot

When set to false, all decorations including title frames, separators, tab-bars are hidden.

◆ showDecorations

void pqTabbedMultiViewWidget::showDecorations ( )

inlineslot

When set to false, all decorations including title frames, separators, tab-bars are hidden.

Definition at line 128 of file pqTabbedMultiViewWidget.h.

◆ hideDecorations

void pqTabbedMultiViewWidget::hideDecorations ( )

inlineslot

When set to false, all decorations including title frames, separators, tab-bars are hidden.

Definition at line 129 of file pqTabbedMultiViewWidget.h.

◆ toggleFullScreen

virtual void pqTabbedMultiViewWidget::toggleFullScreen ( )

virtualslot

Toggle fullscreen state for the active multi-view widget.

All views contained in the active tab will be displayed fullscreen. Hide frame decorations, but they can still be shown afterward through the GUI.

◆ toggleFullScreenActiveView

void pqTabbedMultiViewWidget::toggleFullScreenActiveView ( )

slot

Toggle fullscreen state for active view only.

◆ toggleWidgetDecoration

virtual void pqTabbedMultiViewWidget::toggleWidgetDecoration ( )

virtualslot

toggles decoration visibility on the current widget

◆ lockViewSize

virtual void pqTabbedMultiViewWidget::lockViewSize ( const QSize & )

virtualslot

Locks the maximum size for each view-frame to the given size.

Use empty QSize() instance to indicate no limits.

◆ reset

virtual void pqTabbedMultiViewWidget::reset ( )

virtualslot

cleans up the layout.

◆ preview

QSize pqTabbedMultiViewWidget::preview ( const QSize & previewSize = QSize() )

slot

Enter (or exit) preview mode.

Preview mode is a mode were various widget's decorations are hidden and the widget is locked to the specified size. If the widget's current size is less than the size specified, then the widget is locked to a size with similar aspect ratio as requested. Pass in invalid (or empty) size to exit preview mode.

Preview mode is preferred over toggleWidgetDecoration and lockViewSize and is mutually exclusive with either. Mixing them can have unintended consequences.

Returns: the size to which the widget was locked. When unlocked, this will be QSize(QWIDGETSIZE_MAX, QWIDGETSIZE_MAX). When entering preview mode this will same as requested previewSize or a smaller size preserving aspect ratio as much as possible.

◆ proxyAdded

virtual void pqTabbedMultiViewWidget::proxyAdded ( pqProxy * )

protectedvirtualslot

slots connects to corresponding signals on pqServerManagerObserver.

◆ proxyRemoved

virtual void pqTabbedMultiViewWidget::proxyRemoved ( pqProxy * )

protectedvirtualslot

◆ serverRemoved

virtual void pqTabbedMultiViewWidget::serverRemoved ( pqServer * )

protectedvirtualslot

◆ currentTabChanged

virtual void pqTabbedMultiViewWidget::currentTabChanged ( int )

protectedvirtualslot

called when the active tab changes.

If the active tab is the "+" tab, then add a new tab to the widget.

◆ onStateLoaded

virtual void pqTabbedMultiViewWidget::onStateLoaded ( )

protectedvirtualslot

verifies that all views loaded from state are indeed assigned to some view layout, or we just assign them to one.

◆ contextMenuRequested

void pqTabbedMultiViewWidget::contextMenuRequested ( const QPoint & )

protectedslot

called when context menu need to be created on the tab title.

◆ onLayoutNameChanged

void pqTabbedMultiViewWidget::onLayoutNameChanged ( pqServerManagerModelItem * )

protectedslot

◆ eventFilter()

bool pqTabbedMultiViewWidget::eventFilter	(	QObject *	obj,
		QEvent *	event
	)

overrideprotected

Friends And Related Function Documentation

◆ pqInternals

friend class pqInternals

friend

Definition at line 289 of file pqTabbedMultiViewWidget.h.

Property Documentation

◆ readOnly

bool pqTabbedMultiViewWidget::readOnly

readwrite

Definition at line 32 of file pqTabbedMultiViewWidget.h.

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

/builds/gitlab-kitware-sciviz-ci/Qt/Components/pqTabbedMultiViewWidget.h

Classes

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Properties

Friends

Detailed Description

Constructor & Destructor Documentation

◆ pqTabbedMultiViewWidget()

◆ ~pqTabbedMultiViewWidget()

Member Function Documentation

◆ clientSize()

◆ setReadOnly()

◆ readOnly()

◆ setTabVisibility()

◆ tabVisibility()

◆ layoutProxy()

◆ decorationsVisibility()

◆ findTab()

◆ enableAnnotationFilter()

◆ disableAnnotationFilter()

◆ setAnnotationFilterMatching()

◆ updateVisibleTabs()

◆ visibleTabLabels()

◆ viewSizeLocked

◆ fullScreenEnabled

◆ fullScreenActiveViewEnabled

◆ createTab [1/3]

◆ createTab [2/3]

◆ createTab [3/3]

◆ closeTab

◆ setCurrentTab

◆ setDecorationsVisibility

◆ showDecorations

◆ hideDecorations

◆ toggleFullScreen

◆ toggleFullScreenActiveView

◆ toggleWidgetDecoration

◆ lockViewSize

◆ reset

◆ preview

◆ proxyAdded

◆ proxyRemoved

◆ serverRemoved

◆ currentTabChanged

◆ onStateLoaded

◆ contextMenuRequested

◆ onLayoutNameChanged

◆ eventFilter()

Friends And Related Function Documentation

◆ pqInternals

Property Documentation

◆ readOnly