Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | Friends | List of all members
pqDisplayColorWidget Class Reference

pqDisplayColorWidget is a widget that can be used to select the array to with for representations (also known as displays). More...

#include <pqDisplayColorWidget.h>

Inherits QWidget.

Public Types

typedef QPair< int, QString > ValueType
 

Public Slots

void setRepresentation (pqDataRepresentation *display)
 Set the representation to control the scalar coloring properties on. More...
 

Signals

void arraySelectionChanged ()
 fired to indicate the array-name changed. More...
 

Public Member Functions

 pqDisplayColorWidget (QWidget *parent=0)
 
 ~pqDisplayColorWidget () override
 
ValueType arraySelection () const
 Get/Set the array name as pair (association-number, arrayname). More...
 
QString getCurrentText () const
 
int componentNumber () const
 Get/Set the component number (-1 == magnitude). More...
 
vtkSMViewProxyviewProxy () const
 Returns the view proxy corresponding to the set representation, if any. More...
 

Protected Member Functions

void setArraySelection (const ValueType &)
 Update the UI to show the selected array. More...
 
void setComponentNumber (int)
 Update the UI to show the selected component. More...
 

Friends

class PropertyLinksConnection
 

Detailed Description

pqDisplayColorWidget is a widget that can be used to select the array to with for representations (also known as displays).

It comprises of two combo-boxes, one for the array name, and another for component number. To use, set the representation using setRepresentation(..). If the representation has appropriate properties, this widget will allow users to select the array name.

Definition at line 55 of file pqDisplayColorWidget.h.

Member Typedef Documentation

◆ ValueType

typedef QPair<int, QString> pqDisplayColorWidget::ValueType

Definition at line 61 of file pqDisplayColorWidget.h.

Constructor & Destructor Documentation

◆ pqDisplayColorWidget()

pqDisplayColorWidget::pqDisplayColorWidget ( QWidget *  parent = 0)

◆ ~pqDisplayColorWidget()

pqDisplayColorWidget::~pqDisplayColorWidget ( )
override

Member Function Documentation

◆ arraySelection()

ValueType pqDisplayColorWidget::arraySelection ( ) const

Get/Set the array name as pair (association-number, arrayname).

◆ getCurrentText()

QString pqDisplayColorWidget::getCurrentText ( ) const
inline

Definition at line 71 of file pqDisplayColorWidget.h.

◆ componentNumber()

int pqDisplayColorWidget::componentNumber ( ) const

Get/Set the component number (-1 == magnitude).

◆ viewProxy()

vtkSMViewProxy* pqDisplayColorWidget::viewProxy ( ) const

Returns the view proxy corresponding to the set representation, if any.

◆ arraySelectionChanged

void pqDisplayColorWidget::arraySelectionChanged ( )
signal

fired to indicate the array-name changed.

◆ setRepresentation

void pqDisplayColorWidget::setRepresentation ( pqDataRepresentation display)
slot

Set the representation to control the scalar coloring properties on.

◆ setArraySelection()

void pqDisplayColorWidget::setArraySelection ( const ValueType )
protected

Update the UI to show the selected array.

◆ setComponentNumber()

void pqDisplayColorWidget::setComponentNumber ( int  )
protected

Update the UI to show the selected component.

Friends And Related Function Documentation

◆ PropertyLinksConnection

friend class PropertyLinksConnection
friend

Definition at line 172 of file pqDisplayColorWidget.h.


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