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

#include <pqBlockProxyWidget.h>

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

Public Slots

void apply () const override
 
- Public Slots inherited from pqProxyWidget
bool filterWidgets (bool show_advanced=false, const QString &filterText=QString())
 Updates the property widgets shown based on the filterText or show_advanced flag. More...
 
void showLinkedInteractiveWidget (int portIndex, bool show, bool changeFocus)
 Show any interactive widget linked to a specific output port this proxyWdiget has. More...
 
virtual void apply () const
 Accepts the property widget changes changes. More...
 
void reset () const
 Cleans the property widget changes and resets the widgets. More...
 
void setView (pqView *)
 Set the current view to use to show 3D widgets, if any for the panel. More...
 
void updatePanel ()
 Same as calling filterWidgets() with the arguments specified to the most recent call to filterWidgets(). More...
 
virtual bool restoreDefaults ()
 Restores application default proxy settings. More...
 
void saveAsDefaults ()
 Saves settings as defaults for proxy. More...
 
static pqPropertyWidgetcreateWidgetForProperty (vtkSMProperty *property, vtkSMProxy *proxy, QWidget *parentObj)
 create a widget for a property. More...
 

Public Member Functions

 pqBlockProxyWidget (vtkSMProxy *proxy, QString selector, QWidget *parent, Qt::WindowFlags flags=Qt::WindowFlags{})
 
 ~pqBlockProxyWidget () override
 
- Public Member Functions inherited from pqProxyWidget
 pqProxyWidget (vtkSMProxy *proxy, const QStringList &properties, std::initializer_list< QString > defaultLabels, std::initializer_list< QString > advancedLabels, bool showHeadersFooters=true, QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags{})
 
 pqProxyWidget (vtkSMProxy *proxy, std::initializer_list< QString > defaultLabels, std::initializer_list< QString > advancedLabels, QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags{})
 
 pqProxyWidget (vtkSMProxy *proxy, const QStringList &properties, bool showHeadersFooters=true, QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags{})
 
 pqProxyWidget (vtkSMProxy *proxy, QWidget *parent, Qt::WindowFlags flags=Qt::WindowFlags{})
 
 pqProxyWidget (vtkSMProxy *proxy)
 
 ~pqProxyWidget () override
 
vtkSMProxyproxy () const
 Returns the proxy this panel shows. More...
 
void setApplyChangesImmediately (bool value)
 When set to true, whenever the widget changes, the values are immediately pushed to the ServerManager property without having to wait for apply(). More...
 
bool applyChangesImmediately () const
 
bool useDocumentationForLabels () const
 When this is true, the panel uses a descriptive layout where the documentation for properties is used instead of their labels. More...
 
void showContextMenu (const QPoint &pt, pqPropertyWidget *propWidget)
 
const QSet< QString > & defaultVisibilityLabels () const
 pqProxyWidget shows widgets for properties in two configurations: basic and advanced. More...
 
const QSet< QString > & advancedVisibilityLabels () const
 pqProxyWidget shows widgets for properties in two configurations: basic and advanced. More...
 

Protected Slots

void onChangeFinished () override
 
- Protected Slots inherited from pqProxyWidget
virtual void onChangeFinished ()
 Called when a pqPropertyWidget fires changeFinished() signal. More...
 

Additional Inherited Members

- Public Types inherited from pqProxyWidget
enum  DocumentationType { NONE, USE_DESCRIPTION, USE_SHORT_HELP, USE_LONG_HELP }
 
- Signals inherited from pqProxyWidget
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...
 
- Static Public Member Functions inherited from pqProxyWidget
static QWidget * newGroupLabelWidget (const QString &label, QWidget *parentWidget, const QList< QWidget *> &buttons=QList< QWidget *>())
 Returns a new widget that has the label and a h-line separator. More...
 
static bool useDocumentationForLabels (vtkSMProxy *proxy)
 Returns true of the proxy provided has XML hints indicating that labels should use documentation instead of the XML label for the widgets in the UI. More...
 
static QString documentationText (vtkSMProperty *property, DocumentationType type=USE_DESCRIPTION)
 Returns formatted (HTML or plainText) documentation for the property. More...
 
static QString documentationText (vtkSMProxy *property, DocumentationType type=USE_DESCRIPTION)
 Returns formatted (HTML or plainText) documentation for the proxy. More...
 
static DocumentationType showProxyDocumentationInPanel (vtkSMProxy *proxy)
 Returns true if the proxy has XML hints indicating that the panel should show a header label for the documentation. More...
 
- Protected Member Functions inherited from pqProxyWidget
void showEvent (QShowEvent *event) override
 
void hideEvent (QHideEvent *event) override
 
void applyInternal () const
 

Detailed Description

Definition at line 12 of file pqBlockProxyWidget.h.

Constructor & Destructor Documentation

◆ pqBlockProxyWidget()

pqBlockProxyWidget::pqBlockProxyWidget ( vtkSMProxy proxy,
QString  selector,
QWidget *  parent,
Qt::WindowFlags  flags = Qt::WindowFlags{} 
)

◆ ~pqBlockProxyWidget()

pqBlockProxyWidget::~pqBlockProxyWidget ( )
override

Member Function Documentation

◆ apply

void pqBlockProxyWidget::apply ( ) const
overrideslot

◆ onChangeFinished

void pqBlockProxyWidget::onChangeFinished ( )
overrideprotectedslot

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