Public Member Functions | List of all members
pqViewResolutionPropertyWidget Class Reference

widget for view resolution. More...

#include <pqViewResolutionPropertyWidget.h>

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

Signals

void highlightResetButton ()
 internal signals used to highlight (or not) the "reset-to-domain" button. More...
 
void clearHighlight ()
 internal signals used to highlight (or not) the "reset-to-domain" button. More...
 
- Signals inherited from pqPropertyWidget
void viewChanged (pqView *view)
 This signal is emitted when the current view changes. More...
 
void changeAvailable ()
 This signal is fired as soon as the user starts editing in the widget. More...
 
void changeFinished ()
 This signal is fired as soon as the user is done with making an atomic change. More...
 
void restartRequired ()
 Indicates that a restart of the program is required for the setting to take effect. More...
 

Public Member Functions

 pqViewResolutionPropertyWidget (vtkSMProxy *proxy, vtkSMProperty *smproperty, QWidget *parent=nullptr)
 
 ~pqViewResolutionPropertyWidget () override
 
void apply () override
 Overridden to clear the state for the highlight state for "reset-to-domain" button. More...
 
void reset () override
 Overridden to clear the state for the highlight state for "reset-to-domain" button. More...
 
- Public Member Functions inherited from pqPropertyWidget
 pqPropertyWidget (vtkSMProxy *proxy, QWidget *parent=nullptr)
 
 ~pqPropertyWidget () override
 
virtual void updateWidget (bool showing_advanced_properties)
 
pqViewview () const
 
vtkSMProxyproxy () const
 
vtkSMPropertyproperty () const
 
virtual char * panelVisibility () const
 Forward calls to vtkSMProperty. More...
 
virtual void setPanelVisibility (const char *vis)
 
virtual bool isSingleRowItem () const
 Determines if the PropertyWidget must be constructed using a single row. More...
 
bool showLabel () const
 
const QList< QPointer< pqPropertyWidgetDecorator > > & decorators () const
 Provides access to the decorators for this widget. More...
 
void setProperty (vtkSMProperty *property)
 
virtual void select ()
 These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...
 
virtual void selectPort (int portIndex)
 These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...
 
virtual void deselect ()
 These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...
 
bool isSelected () const
 These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...
 

Additional Inherited Members

- Public Slots inherited from pqPropertyWidget
virtual void setView (pqView *)
 called to set the active view. More...
 
- Static Public Member Functions inherited from pqPropertyWidget
template<class T >
static QString getXMLName (T *object)
 Description: This static utility method returns the XML name for an object as a QString. More...
 
static QString getTooltip (vtkSMProperty *property)
 Returns the tooltip to use for the property. More...
 
static int hintsWidgetHeightNumberOfRows (vtkPVXMLElement *hints, int defaultValue=10)
 Helper method to return value from WidgetHeight XML hint, if any. More...
 
static std::vector< std::stringparseComponentLabels (vtkPVXMLElement *hints, unsigned int elemCount=0)
 Parse a XML element as a list of label to use for this widget. More...
 
- Protected Member Functions inherited from pqPropertyWidget
void addPropertyLink (QObject *qobject, const char *qproperty, const char *qsignal, vtkSMProperty *smproperty, int smindex=-1)
 
void addPropertyLink (QObject *qobject, const char *qproperty, const char *qsignal, vtkSMProxy *smproxy, vtkSMProperty *smproperty, int smindex=-1)
 
void removePropertyLink (QObject *qobject, const char *qproperty, const char *qsignal, vtkSMProperty *smproperty, int smindex=-1)
 
void removePropertyLink (QObject *qobject, const char *qproperty, const char *qsignal, vtkSMProxy *smproxy, vtkSMProperty *smproperty, int smindex=-1)
 
void setShowLabel (bool show)
 
void setChangeAvailableAsChangeFinished (bool status)
 For most pqPropertyWidget subclasses a changeAvailable() signal, corresponds to a changeFinished() signal. More...
 
void addDecorator (pqPropertyWidgetDecorator *)
 Register a decorator. More...
 
void removeDecorator (pqPropertyWidgetDecorator *)
 Unregisters a decorator. More...
 
pqPropertyLinkslinks ()
 Provides access to the pqPropertyLinks instance. More...
 

Detailed Description

widget for view resolution.

pqViewResolutionPropertyWidget is desined to be used with properties that allow users to set resolution for things like views, images, movies etc. It provides UI elements to lock aspect ratio, scale size up or down, and reset to default.

This widget works with any vtkSMIntVectorProperty with 2 elements interpreted as (width, height).

As specified in pqStandardPropertyWidgetInterface, to use this widget for a property you can use panel_widget="view_resolution" attribute in ServerManager XML.

Definition at line 27 of file pqViewResolutionPropertyWidget.h.

Constructor & Destructor Documentation

◆ pqViewResolutionPropertyWidget()

pqViewResolutionPropertyWidget::pqViewResolutionPropertyWidget ( vtkSMProxy proxy,
vtkSMProperty smproperty,
QWidget *  parent = nullptr 
)

◆ ~pqViewResolutionPropertyWidget()

pqViewResolutionPropertyWidget::~pqViewResolutionPropertyWidget ( )
override

Member Function Documentation

◆ apply()

void pqViewResolutionPropertyWidget::apply ( )
overridevirtual

Overridden to clear the state for the highlight state for "reset-to-domain" button.

The implementation simply fires clearHighlight signal.

Reimplemented from pqPropertyWidget.

◆ reset()

void pqViewResolutionPropertyWidget::reset ( )
overridevirtual

Overridden to clear the state for the highlight state for "reset-to-domain" button.

The implementation simply fires clearHighlight signal.

Reimplemented from pqPropertyWidget.

◆ highlightResetButton

void pqViewResolutionPropertyWidget::highlightResetButton ( )
signal

internal signals used to highlight (or not) the "reset-to-domain" button.

◆ clearHighlight

void pqViewResolutionPropertyWidget::clearHighlight ( )
signal

internal signals used to highlight (or not) the "reset-to-domain" button.


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