ParaView
Public Slots | Public Member Functions | Protected Slots | List of all members
pqAnimatablePropertiesComboBox Class Reference

pqAnimatablePropertiesComboBox is a combo box that can list the animatable properties of any proxy. More...

#include <pqAnimatablePropertiesComboBox.h>

Inherits QComboBox.

Public Slots

void setSource (vtkSMProxy *proxy)
 Set the source whose properties this widget should list. More...
 
void setSourceWithoutProperties (vtkSMProxy *proxy)
 Set source without calling buildPropertyList() internally. More...
 
void setCollapseVectors (bool val)
 If true, vector properties will have a single entry. More...
 
void setVectorSizeFilter (int size)
 This class can filter the displayed properties to only show those with a specified number of components. More...
 
void addSMProperty (const QString &label, const QString &propertyname, int index)
 Add a property to the widget. More...
 

Public Member Functions

 pqAnimatablePropertiesComboBox (QWidget *parent=0)
 
 ~pqAnimatablePropertiesComboBox ()
 
vtkSMProxy * source () const
 Returns the source whose properties are currently being listed, if any. More...
 
vtkSMProxy * getCurrentProxy () const
 
QString getCurrentPropertyName () const
 
int getCurrentIndex () const
 
bool getCollapseVectors () const
 If true, vector properties will have a single entry. More...
 
int getVectorSizeFilter () const
 This class can filter the displayed properties to only show those with a specified number of components. More...
 
void setUseBlankEntry (bool b)
 Sometimes, we want the combo to show a empty field that does not represent any property. More...
 

Protected Slots

void buildPropertyList ()
 Builds the property list. More...
 

Detailed Description

pqAnimatablePropertiesComboBox is a combo box that can list the animatable properties of any proxy.

Definition at line 42 of file pqAnimatablePropertiesComboBox.h.

Constructor & Destructor Documentation

§ pqAnimatablePropertiesComboBox()

pqAnimatablePropertiesComboBox::pqAnimatablePropertiesComboBox ( QWidget *  parent = 0)

§ ~pqAnimatablePropertiesComboBox()

pqAnimatablePropertiesComboBox::~pqAnimatablePropertiesComboBox ( )

Member Function Documentation

§ source()

vtkSMProxy* pqAnimatablePropertiesComboBox::source ( ) const

Returns the source whose properties are currently being listed, if any.

§ getCurrentProxy()

vtkSMProxy* pqAnimatablePropertiesComboBox::getCurrentProxy ( ) const

§ getCurrentPropertyName()

QString pqAnimatablePropertiesComboBox::getCurrentPropertyName ( ) const

§ getCurrentIndex()

int pqAnimatablePropertiesComboBox::getCurrentIndex ( ) const

§ getCollapseVectors()

bool pqAnimatablePropertiesComboBox::getCollapseVectors ( ) const

If true, vector properties will have a single entry.

If false, each vector component will be displayed separately. Default: false.

§ getVectorSizeFilter()

int pqAnimatablePropertiesComboBox::getVectorSizeFilter ( ) const

This class can filter the displayed properties to only show those with a specified number of components.

Returns the current filter settings. -1 means no filtering (default).

§ setUseBlankEntry()

void pqAnimatablePropertiesComboBox::setUseBlankEntry ( bool  b)
inline

Sometimes, we want the combo to show a empty field that does not represent any property.

Set this to true to use such a field.

Definition at line 69 of file pqAnimatablePropertiesComboBox.h.

§ setSource

void pqAnimatablePropertiesComboBox::setSource ( vtkSMProxy *  proxy)
slot

Set the source whose properties this widget should list.

If source is null, the widget gets disabled.

§ setSourceWithoutProperties

void pqAnimatablePropertiesComboBox::setSourceWithoutProperties ( vtkSMProxy *  proxy)
slot

Set source without calling buildPropertyList() internally.

Thus the user will explicitly call addSMProperty to add properties.

§ setCollapseVectors

void pqAnimatablePropertiesComboBox::setCollapseVectors ( bool  val)
slot

If true, vector properties will have a single entry.

If false, each vector component will be displayed separately. Default: false.

§ setVectorSizeFilter

void pqAnimatablePropertiesComboBox::setVectorSizeFilter ( int  size)
slot

This class can filter the displayed properties to only show those with a specified number of components.

Set the current filter setting. -1 means no filtering (default).

§ addSMProperty

void pqAnimatablePropertiesComboBox::addSMProperty ( const QString &  label,
const QString &  propertyname,
int  index 
)
slot

Add a property to the widget.

§ buildPropertyList

void pqAnimatablePropertiesComboBox::buildPropertyList ( )
protectedslot

Builds the property list.


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