ParaView
Public Slots | Signals | Public Member Functions | Protected Member Functions
pqDisplayColorWidget Class Reference

Provides a standard user interface for selecting among a collection of dataset variables (both cell and node variables). More...

#include <pqDisplayColorWidget.h>

List of all members.

Public Slots

void onVariableChanged (pqVariableType type, const QString &name)
 Called when the variable selection changes.
void setRepresentation (pqDataRepresentation *display)
 When set, the source/renModule is not used to locate the display, instead this display is used.
void reloadGUI ()
 Called when the GUI must reload the arrays shown in the widget.

Signals

void variableChanged (pqVariableType type, const QString &name)
 Signal emitted whenever the user chooses a variable, or chooseVariable() is called.
void modified ()
 Fired when ever the color mode on the display changes either thorough this widget itself, of when the underlying SMObject changes.

Public Member Functions

 pqDisplayColorWidget (QWidget *parent=0)
 ~pqDisplayColorWidget ()
QString getCurrentText () const
 Returns the current text in the combo box.

Protected Member Functions

void clear ()
 Removes all variables from the collection.
void addVariable (pqVariableType type, const QString &name, bool is_partial)
 Adds a variable to the collection.
void chooseVariable (pqVariableType type, const QString &name)
 Makes the given variable the "current" selection.
pqPipelineRepresentationgetRepresentation () const
 Returns the display whose color this widget is currently editing.

Detailed Description

Provides a standard user interface for selecting among a collection of dataset variables (both cell and node variables).

Definition at line 51 of file pqDisplayColorWidget.h.


Constructor & Destructor Documentation

pqDisplayColorWidget::pqDisplayColorWidget ( QWidget *  parent = 0)
pqDisplayColorWidget::~pqDisplayColorWidget ( )

Member Function Documentation

QString pqDisplayColorWidget::getCurrentText ( ) const

Returns the current text in the combo box.

void pqDisplayColorWidget::clear ( ) [protected]

Removes all variables from the collection.

void pqDisplayColorWidget::addVariable ( pqVariableType  type,
const QString &  name,
bool  is_partial 
) [protected]

Adds a variable to the collection.

void pqDisplayColorWidget::chooseVariable ( pqVariableType  type,
const QString &  name 
) [protected]

Makes the given variable the "current" selection.

Emits the variableChanged() signal.

pqPipelineRepresentation* pqDisplayColorWidget::getRepresentation ( ) const [protected]

Returns the display whose color this widget is currently editing.

void pqDisplayColorWidget::onVariableChanged ( pqVariableType  type,
const QString &  name 
) [slot]

Called when the variable selection changes.

void pqDisplayColorWidget::setRepresentation ( pqDataRepresentation display) [slot]

When set, the source/renModule is not used to locate the display, instead this display is used.

void pqDisplayColorWidget::reloadGUI ( ) [slot]

Called when the GUI must reload the arrays shown in the widget.

i.e. this updates the domain for the combo box.

void pqDisplayColorWidget::variableChanged ( pqVariableType  type,
const QString &  name 
) [signal]

Signal emitted whenever the user chooses a variable, or chooseVariable() is called.

This signal is fired only when the change is triggered by the wiget i.e. if the ServerManager property changes, this signal won't be fired, use modified() instead.

void pqDisplayColorWidget::modified ( ) [signal]

Fired when ever the color mode on the display changes either thorough this widget itself, of when the underlying SMObject changes.


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