pqTabbedMultiViewWidget Class Reference

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

#include <pqTabbedMultiViewWidget.h>

Inheritance diagram for pqTabbedMultiViewWidget:

List of all members.

Public Slots
void	createTab ()
void	createTab (pqServer *)
void	createTab (vtkSMViewLayoutProxy *)
void	closeTab (int)
void	toggleFullScreen ()
	toggles fullscreen state.
void	lockViewSize (const QSize &)
	Locks the maximum size for each view-frame to the given size.
void	reset ()
	cleans up the layout.
Signals
void	viewSizeLocked (bool)
	fired when lockViewSize() is called.
Public Member Functions
	pqTabbedMultiViewWidget (QWidget *parent=0)
virtual	~pqTabbedMultiViewWidget ()
QSize	clientSize () const
	Returns the size for the tabs in the widget.
vtkImageData *	captureImage (int width, int height)
	Captures an image for the views in the layout.
int	prepareForCapture (int width, int height)
	setups up the environment for capture.
void	cleanupAfterCapture ()
	cleans up the environment after image capture.
Protected Slots
void	proxyAdded (pqProxy *)
	slots connects to corresponding signals on pqServerManagerObserver.
void	proxyRemoved (pqProxy *)
void	serverRemoved (pqServer *)
void	currentTabChanged (int)
	called when the active tab changes.
void	frameActivated ()
	called when a frame in pqMultiViewWidget is activated.
void	onStateLoaded ()
	verifies that all views loaded from state are indeed assigned to some view layout, or we just assign them to one.
void	aboutToCreateView (pqServer *)
	called when pqObjectBuilder is about to create a new view.
Protected Member Functions
bool	eventFilter (QObject *obj, QEvent *event)
void	assignToFrame (pqView *, bool warnIfTabCreated)
	assigns a frame to the view.

---

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 49 of file pqTabbedMultiViewWidget.h.

---

Constructor & Destructor Documentation

pqTabbedMultiViewWidget::pqTabbedMultiViewWidget

(

QWidget *

parent = 0

)

virtual pqTabbedMultiViewWidget::~pqTabbedMultiViewWidget

(

)

[virtual]

---

Member Function Documentation

QSize pqTabbedMultiViewWidget::clientSize

(

)

const

Returns the size for the tabs in the widget.

vtkImageData* pqTabbedMultiViewWidget::captureImage	(	int	width,
		int	height
	)

Captures an image for the views in the layout.

Note that there must be at least one valid view in the widget, otherwise returns NULL.

int pqTabbedMultiViewWidget::prepareForCapture	(	int	width,
		int	height
	)

setups up the environment for capture.

Returns the magnification that can be used to capture the image for required size.

void pqTabbedMultiViewWidget::cleanupAfterCapture

(

)

cleans up the environment after image capture.

void pqTabbedMultiViewWidget::viewSizeLocked

(

bool

)

[signal]

fired when lockViewSize() is called.

void pqTabbedMultiViewWidget::createTab

(

)

[slot]

void pqTabbedMultiViewWidget::createTab

(

pqServer *

)

[slot]

void pqTabbedMultiViewWidget::createTab

(

vtkSMViewLayoutProxy *

)

[slot]

void pqTabbedMultiViewWidget::closeTab

(

int

)

[slot]

void pqTabbedMultiViewWidget::toggleFullScreen

(

)

[slot]

toggles fullscreen state.

void pqTabbedMultiViewWidget::lockViewSize

(

const QSize &

)

[slot]

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

Use empty QSize() instance to indicate no limits.

void pqTabbedMultiViewWidget::reset

(

)

[slot]

cleans up the layout.

void pqTabbedMultiViewWidget::proxyAdded

(

pqProxy *

)

[protected, slot]

slots connects to corresponding signals on pqServerManagerObserver.

void pqTabbedMultiViewWidget::proxyRemoved

(

pqProxy *

)

[protected, slot]

void pqTabbedMultiViewWidget::serverRemoved

(

pqServer *

)

[protected, slot]

void pqTabbedMultiViewWidget::currentTabChanged

(

int

)

[protected, slot]

called when the active tab changes.

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

void pqTabbedMultiViewWidget::frameActivated

(

)

[protected, slot]

called when a frame in pqMultiViewWidget is activated.

Ensures that that widget is visible.

void pqTabbedMultiViewWidget::onStateLoaded

(

)

[protected, slot]

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

void pqTabbedMultiViewWidget::aboutToCreateView

(

pqServer *

)

[protected, slot]

called when pqObjectBuilder is about to create a new view.

We ensure that a layout exists to accept that view. This is essential for collaborative mode to work correctly without ending up multiple layouts on the two processes.

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

void pqTabbedMultiViewWidget::assignToFrame	(	pqView *	,
		bool	warnIfTabCreated
	)		[protected]

assigns a frame to the view.

---

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

• /home/kitware/Dashboards/My Tests/ParaView/Qt/Components/pqTabbedMultiViewWidget.h