Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
pqPipelineBrowserWidget Class Reference

pqPipelineBrowserWidget is the widget for the pipeline browser. More...

#include <pqPipelineBrowserWidget.h>

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

Public Slots

void setActiveView (pqView *)
 Set the active view. More...
 
- Public Slots inherited from pqFlatTreeView
void reset ()
 
void selectAll ()
 
void setCurrentIndex (const QModelIndex &index)
 
void expandAll ()
 
void expand (const QModelIndex &index)
 
void collapse (const QModelIndex &index)
 
void scrollTo (const QModelIndex &index)
 

Signals

void deleteKey ()
 Fired when the delete key is pressed. More...
 
- Signals inherited from pqFlatTreeView
void activated (const QModelIndex &index)
 
void clicked (const QModelIndex &index)
 

Public Member Functions

 pqPipelineBrowserWidget (QWidget *parent=nullptr)
 
 ~pqPipelineBrowserWidget () override
 
bool eventFilter (QObject *object, QEvent *e) override
 Used to monitor the key press events in the tree view. More...
 
void setSelectionVisibility (bool visible)
 Set the visibility of selected items. More...
 
void enableAnnotationFilter (const QString &annotationKey)
 Set Annotation filter to use. More...
 
void disableAnnotationFilter ()
 Disable any Annotation filter. More...
 
void setAnnotationFilterMatching (bool matching)
 Choose wether Annotation filter should display matching or non-matching sources. More...
 
void enableSessionFilter (vtkSession *session)
 Set Session filter to use. More...
 
void disableSessionFilter ()
 Disable any Session filter. More...
 
void setModel (pqPipelineModel *model)
 Overload of pqFlatTreeView::setModel. More...
 
QModelIndex pipelineModelIndex (const QModelIndex &index) const
 TODO document. More...
 
const pqPipelineModelgetPipelineModel (const QModelIndex &index) const
 
QMenu * contextMenu () const
 Provides access to the context menu. More...
 
- Public Member Functions inherited from pqFlatTreeView
 pqFlatTreeView (QWidget *parent=nullptr)
 Creates a flat tree view. More...
 
 ~pqFlatTreeView () override
 
bool eventFilter (QObject *object, QEvent *e) override
 Used to monitor the header view. More...
 
QAbstractItemModel * getModel () const
 
void setModel (QAbstractItemModel *model)
 
QModelIndex getRootIndex () const
 
void setRootIndex (const QModelIndex &index)
 
QItemSelectionModel * getSelectionModel () const
 
void setSelectionModel (QItemSelectionModel *selectionModel)
 
SelectionBehavior getSelectionBehavior () const
 
void setSelectionBehavior (SelectionBehavior behavior)
 
SelectionMode getSelectionMode () const
 
void setSelectionMode (SelectionMode mode)
 
QHeaderView * getHeader () const
 Gets whether or not the column size is managed by the view. More...
 
void setHeader (QHeaderView *headerView)
 Gets whether or not the column size is managed by the view. More...
 
bool isColumnSizeManaged () const
 Gets whether or not the column size is managed by the view. More...
 
void setColumnSizeManaged (bool managed)
 Sets whether or not the column size is managed by the view. More...
 
int getIconSize () const
 
void setIconSize (int iconSize)
 
bool isIndexHidden (const QModelIndex &index) const
 
void getVisibleRect (const QModelIndex &index, QRect &area) const
 
QModelIndex getIndexVisibleAt (const QPoint &point) const
 
QModelIndex getIndexCellAt (const QPoint &point) const
 
void getSelectionIn (const QRect &rect, QItemSelection &items) const
 
bool isIndexExpanded (const QModelIndex &index) const
 
QModelIndex getNextVisibleIndex (const QModelIndex &index, const QModelIndex &root=QModelIndex()) const
 
QModelIndex getRelativeIndex (const QString &id, const QModelIndex &root=QModelIndex()) const
 
void getRelativeIndexId (const QModelIndex &index, QString &id, const QModelIndex &root=QModelIndex()) const
 
bool startEditing (const QModelIndex &index)
 
void finishEditing ()
 
void cancelEditing ()
 

Static Public Member Functions

static void setVisibility (bool visible, pqOutputPort *port)
 static method to sets the visibility of a pqOutputPort More...
 

Protected Slots

void handleIndexClicked (const QModelIndex &index)
 
void expandWithModelIndexTranslation (const QModelIndex &)
 
- Protected Slots inherited from pqFlatTreeView
void insertRows (const QModelIndex &parent, int start, int end)
 
void startRowRemoval (const QModelIndex &parent, int start, int end)
 
void finishRowRemoval (const QModelIndex &parent, int start, int end)
 
void insertColumns (const QModelIndex &parent, int start, int end)
 
void startColumnRemoval (const QModelIndex &parent, int start, int end)
 
void finishColumnRemoval (const QModelIndex &parent, int start, int end)
 
void updateData (const QModelIndex &topLeft, const QModelIndex &bottomRight)
 

Protected Member Functions

void setVisibility (bool visible, const QModelIndexList &indices)
 sets the visibility for items in the indices list. More...
 
void contextMenuEvent (QContextMenuEvent *e) override
 
bool viewportEvent (QEvent *e) override
 Overridden to pass changed font to pqPipelineModel. More...
 
- Protected Member Functions inherited from pqFlatTreeView
int horizontalOffset () const
 
int verticalOffset () const
 
void resizeEvent (QResizeEvent *e) override
 
bool viewportEvent (QEvent *e) override
 
void paintEvent (QPaintEvent *e) override
 
QStyleOptionViewItem getViewOptions () const
 
void keyPressEvent (QKeyEvent *e) override
 
void keyboardSearch (const QString &search)
 
void mousePressEvent (QMouseEvent *e) override
 
void mouseMoveEvent (QMouseEvent *e) override
 
void mouseReleaseEvent (QMouseEvent *e) override
 
void mouseDoubleClickEvent (QMouseEvent *e) override
 
bool event (QEvent *e) override
 

Protected Attributes

pqPipelineModelPipelineModel
 
pqPipelineAnnotationFilterModelFilteredPipelineModel
 
QPointer< QMenu > ContextMenu
 

Additional Inherited Members

- Public Types inherited from pqFlatTreeView
enum  SelectionBehavior { SelectItems, SelectRows, SelectColumns }
 
enum  SelectionMode { NoSelection, SingleSelection, ExtendedSelection }
 

Detailed Description

pqPipelineBrowserWidget is the widget for the pipeline browser.

This is a replacement for pqPipelineBrowser.

Definition at line 24 of file pqPipelineBrowserWidget.h.

Constructor & Destructor Documentation

◆ pqPipelineBrowserWidget()

pqPipelineBrowserWidget::pqPipelineBrowserWidget ( QWidget *  parent = nullptr)

◆ ~pqPipelineBrowserWidget()

pqPipelineBrowserWidget::~pqPipelineBrowserWidget ( )
override

Member Function Documentation

◆ eventFilter()

bool pqPipelineBrowserWidget::eventFilter ( QObject *  object,
QEvent *  e 
)
override

Used to monitor the key press events in the tree view.

Returns True if the event should not be sent to the object.

◆ setSelectionVisibility()

void pqPipelineBrowserWidget::setSelectionVisibility ( bool  visible)

Set the visibility of selected items.

◆ enableAnnotationFilter()

void pqPipelineBrowserWidget::enableAnnotationFilter ( const QString &  annotationKey)

Set Annotation filter to use.

◆ disableAnnotationFilter()

void pqPipelineBrowserWidget::disableAnnotationFilter ( )

Disable any Annotation filter.

◆ setAnnotationFilterMatching()

void pqPipelineBrowserWidget::setAnnotationFilterMatching ( bool  matching)

Choose wether Annotation filter should display matching or non-matching sources.

Default is matching.

◆ enableSessionFilter()

void pqPipelineBrowserWidget::enableSessionFilter ( vtkSession session)

Set Session filter to use.

◆ disableSessionFilter()

void pqPipelineBrowserWidget::disableSessionFilter ( )

Disable any Session filter.

◆ setModel()

void pqPipelineBrowserWidget::setModel ( pqPipelineModel model)

◆ pipelineModelIndex()

QModelIndex pqPipelineBrowserWidget::pipelineModelIndex ( const QModelIndex &  index) const

TODO document.

Note
Moved from proteced

◆ getPipelineModel()

const pqPipelineModel* pqPipelineBrowserWidget::getPipelineModel ( const QModelIndex &  index) const

◆ setVisibility() [1/2]

static void pqPipelineBrowserWidget::setVisibility ( bool  visible,
pqOutputPort port 
)
static

static method to sets the visibility of a pqOutputPort

◆ contextMenu()

QMenu* pqPipelineBrowserWidget::contextMenu ( ) const

Provides access to the context menu.

◆ deleteKey

void pqPipelineBrowserWidget::deleteKey ( )
signal

Fired when the delete key is pressed.

Typically implies that the selected items need to be deleted.

◆ setActiveView

void pqPipelineBrowserWidget::setActiveView ( pqView )
slot

Set the active view.

By default connected to pqActiveObjects::viewChanged() so it keeps track of the active view.

◆ handleIndexClicked

void pqPipelineBrowserWidget::handleIndexClicked ( const QModelIndex &  index)
protectedslot

◆ expandWithModelIndexTranslation

void pqPipelineBrowserWidget::expandWithModelIndexTranslation ( const QModelIndex &  )
protectedslot

◆ setVisibility() [2/2]

void pqPipelineBrowserWidget::setVisibility ( bool  visible,
const QModelIndexList &  indices 
)
protected

sets the visibility for items in the indices list.

◆ contextMenuEvent()

void pqPipelineBrowserWidget::contextMenuEvent ( QContextMenuEvent *  e)
overrideprotected

◆ viewportEvent()

bool pqPipelineBrowserWidget::viewportEvent ( QEvent *  e)
overrideprotected

Overridden to pass changed font to pqPipelineModel.

Member Data Documentation

◆ PipelineModel

pqPipelineModel* pqPipelineBrowserWidget::PipelineModel
protected

Definition at line 123 of file pqPipelineBrowserWidget.h.

◆ FilteredPipelineModel

pqPipelineAnnotationFilterModel* pqPipelineBrowserWidget::FilteredPipelineModel
protected

Definition at line 124 of file pqPipelineBrowserWidget.h.

◆ ContextMenu

QPointer<QMenu> pqPipelineBrowserWidget::ContextMenu
protected

Definition at line 125 of file pqPipelineBrowserWidget.h.


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