Public Types | Signals | Public Member Functions | List of all members
pqMultiBlockPropertiesStateWidget Class Reference

A QWidget that tracks the state multi block property/ies, and allows to reset them. More...

#include <pqMultiBlockPropertiesStateWidget.h>

Inherits QWidget.

Public Types

typedef QWidget Superclass
 
using BlockPropertyState = vtkSMColorMapEditorHelper::BlockPropertyState
 

Signals

void stateChanged (BlockPropertyState newState)
 
void selectedBlockSelectorsChanged ()
 
void startStateReset ()
 
void endStateReset ()
 

Public Member Functions

 pqMultiBlockPropertiesStateWidget (vtkSMProxy *repr, const QList< QString > &properties, int iconSize, QString selector=QString(), QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
 
 ~pqMultiBlockPropertiesStateWidget () override
 
BlockPropertyState getState () const
 Get the state of the properties. More...
 
QPixmap getStatePixmap (BlockPropertyState state) const
 
QString getStateToolTip (BlockPropertyState state) const
 Get the tooltip of the current state. More...
 
pqHighlightableToolButtongetResetButton () const
 Get the reset button. More...
 
std::vector< std::stringgetProperties () const
 Get the properties being tracked. More...
 
std::vector< std::stringgetSelectors () const
 Get the selectors being tracked. More...
 

Detailed Description

A QWidget that tracks the state multi block property/ies, and allows to reset them.

This widget is used to track the state of multiple properties of a multi block proxy. It allows to reset the state of the properties. If a selector is provided, the widget will only track the properties of the selected block, else it will track the properties of the current selectors provided by SelectedBlockSelectors property of the proxy.

Definition at line 31 of file pqMultiBlockPropertiesStateWidget.h.

Member Typedef Documentation

◆ Superclass

Definition at line 35 of file pqMultiBlockPropertiesStateWidget.h.

◆ BlockPropertyState

Definition at line 42 of file pqMultiBlockPropertiesStateWidget.h.

Constructor & Destructor Documentation

◆ pqMultiBlockPropertiesStateWidget()

pqMultiBlockPropertiesStateWidget::pqMultiBlockPropertiesStateWidget ( vtkSMProxy repr,
const QList< QString > &  properties,
int  iconSize,
QString  selector = QString(),
QWidget *  parent = nullptr,
Qt::WindowFlags  f = Qt::WindowFlags() 
)

◆ ~pqMultiBlockPropertiesStateWidget()

pqMultiBlockPropertiesStateWidget::~pqMultiBlockPropertiesStateWidget ( )
override

Member Function Documentation

◆ getState()

BlockPropertyState pqMultiBlockPropertiesStateWidget::getState ( ) const

Get the state of the properties.

◆ getStatePixmap()

QPixmap pqMultiBlockPropertiesStateWidget::getStatePixmap ( BlockPropertyState  state) const

◆ getStateToolTip()

QString pqMultiBlockPropertiesStateWidget::getStateToolTip ( BlockPropertyState  state) const

Get the tooltip of the current state.

◆ getResetButton()

pqHighlightableToolButton* pqMultiBlockPropertiesStateWidget::getResetButton ( ) const

Get the reset button.

◆ getProperties()

std::vector<std::string> pqMultiBlockPropertiesStateWidget::getProperties ( ) const

Get the properties being tracked.

◆ getSelectors()

std::vector<std::string> pqMultiBlockPropertiesStateWidget::getSelectors ( ) const

Get the selectors being tracked.

◆ stateChanged

void pqMultiBlockPropertiesStateWidget::stateChanged ( BlockPropertyState  newState)
signal

◆ selectedBlockSelectorsChanged

void pqMultiBlockPropertiesStateWidget::selectedBlockSelectorsChanged ( )
signal

◆ startStateReset

void pqMultiBlockPropertiesStateWidget::startStateReset ( )
signal

◆ endStateReset

void pqMultiBlockPropertiesStateWidget::endStateReset ( )
signal

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