ParaView
Classes | Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Properties | Friends | List of all members
pqTabbedMultiViewWidget Class Reference

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

#include <pqTabbedMultiViewWidget.h>

Inheritance diagram for pqTabbedMultiViewWidget:
Inheritance graph
[legend]

Classes

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

Public Slots

virtual void createTab ()
 
virtual void createTab (pqServer *)
 
virtual void createTab (vtkSMViewLayoutProxy *)
 
virtual void closeTab (int)
 
virtual void toggleFullScreen ()
 toggles fullscreen state. 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...
 

Signals

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

Public Member Functions

 pqTabbedMultiViewWidget (QWidget *parent=0)
 
virtual ~pqTabbedMultiViewWidget ()
 
virtual QSize clientSize () const
 Returns the size for the tabs in the widget. More...
 
virtual vtkImageData * captureImage (int width, int height)
 Captures an image for the views in the layout. More...
 
virtual int prepareForCapture (int width, int height)
 setups up the environment for capture. More...
 
virtual void cleanupAfterCapture ()
 cleans up the environment after image capture. More...
 
virtual bool writeImage (const QString &filename, int width, int height, int quality=-1)
 Capture an image and saves it out to a file. 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
 

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 frameActivated ()
 called when a frame in pqMultiViewWidget is activated. 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...
 
virtual void aboutToCreateView (pqServer *)
 called when pqObjectBuilder is about to create a new view. More...
 
void contextMenuRequested (const QPoint &)
 called when context menu need to be created on the tab title. More...
 
void onLayoutNameChanged (pqServerManagerModelItem *)
 

Protected Member Functions

virtual bool eventFilter (QObject *obj, QEvent *event)
 
virtual void assignToFrame (pqView *, bool warnIfTabCreated)
 assigns a frame to the view. More...
 

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

Constructor & Destructor Documentation

◆ pqTabbedMultiViewWidget()

pqTabbedMultiViewWidget::pqTabbedMultiViewWidget ( QWidget *  parent = 0)

◆ ~pqTabbedMultiViewWidget()

virtual pqTabbedMultiViewWidget::~pqTabbedMultiViewWidget ( )
virtual

Member Function Documentation

◆ clientSize()

virtual QSize pqTabbedMultiViewWidget::clientSize ( ) const
virtual

Returns the size for the tabs in the widget.

◆ captureImage()

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

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.

◆ prepareForCapture()

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

setups up the environment for capture.

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

◆ cleanupAfterCapture()

virtual void pqTabbedMultiViewWidget::cleanupAfterCapture ( )
virtual

cleans up the environment after image capture.

◆ writeImage()

virtual bool pqTabbedMultiViewWidget::writeImage ( const QString &  filename,
int  width,
int  height,
int  quality = -1 
)
virtual

Capture an image and saves it out to a file.

◆ 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

◆ viewSizeLocked

void pqTabbedMultiViewWidget::viewSizeLocked ( bool  )
signal

fired when lockViewSize() is called.

◆ createTab [1/3]

virtual void pqTabbedMultiViewWidget::createTab ( )
virtualslot

◆ createTab [2/3]

virtual void pqTabbedMultiViewWidget::createTab ( pqServer )
virtualslot

◆ createTab [3/3]

virtual void pqTabbedMultiViewWidget::createTab ( vtkSMViewLayoutProxy )
virtualslot

◆ closeTab

virtual void pqTabbedMultiViewWidget::closeTab ( int  )
virtualslot

◆ toggleFullScreen

virtual void pqTabbedMultiViewWidget::toggleFullScreen ( )
virtualslot

toggles fullscreen state.

◆ 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.

◆ 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.

◆ frameActivated

virtual void pqTabbedMultiViewWidget::frameActivated ( )
protectedvirtualslot

called when a frame in pqMultiViewWidget is activated.

Ensures that that widget is visible.

◆ 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.

◆ aboutToCreateView

virtual void pqTabbedMultiViewWidget::aboutToCreateView ( pqServer )
protectedvirtualslot

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.

◆ 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()

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

◆ assignToFrame()

virtual void pqTabbedMultiViewWidget::assignToFrame ( pqView ,
bool  warnIfTabCreated 
)
protectedvirtual

assigns a frame to the view.

Friends And Related Function Documentation

◆ pqInternals

friend class pqInternals
friend

Definition at line 239 of file pqTabbedMultiViewWidget.h.

Property Documentation

◆ readOnly

bool pqTabbedMultiViewWidget::readOnly
readwrite

Definition at line 59 of file pqTabbedMultiViewWidget.h.


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