pqProxiesWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: pqProxiesWidget.h
5 
6  Copyright (c) 2005,2006 Sandia Corporation, Kitware Inc.
7  All rights reserved.
8 
9  ParaView is a free software; you can redistribute it and/or modify it
10  under the terms of the ParaView license version 1.2.
11 
12  See License_v1.2.txt for the full ParaView license.
13  A copy of this license can be obtained by contacting
14  Kitware Inc.
15  28 Corporate Drive
16  Clifton Park, NY 12065
17  USA
18 
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
23 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 
31 ========================================================================*/
32 #ifndef pqProxiesWidget_h
33 #define pqProxiesWidget_h
34 
35 #include "pqComponentsModule.h"
36 #include <QMap>
37 #include <QScopedPointer>
38 #include <QWidget>
39 
40 class vtkSMProxy;
41 class pqView;
42 
61 class PQCOMPONENTS_EXPORT pqProxiesWidget : public QWidget
62 {
63  Q_OBJECT
64  typedef QWidget Superclass;
65 
66 public:
67  pqProxiesWidget(QWidget* parent = nullptr, Qt::WindowFlags flags = Qt::WindowFlags{});
68  ~pqProxiesWidget() override;
69 
76  QMap<QString, bool> expanderState() const;
77 
83  void setExpanderState(const QMap<QString, bool>& state);
84 
85 public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
89  void clear();
90 
94  void addProxy(vtkSMProxy*, const QString& componentName = QString(),
95  const QStringList& properties = QStringList(), bool applyChangesImmediately = false,
96  bool showHeadersFooters = true);
97 
102  void updateLayout();
103 
110  bool filterWidgets(bool show_advanced = false, const QString& filterText = QString());
111 
115  void apply() const;
116 
120  void reset() const;
121 
125  void setView(pqView*);
126 
131  void updatePanel();
132 
133 Q_SIGNALS:
138  void changeAvailable(vtkSMProxy* proxy);
139 
144  void changeFinished(vtkSMProxy* proxy);
145 
150  void restartRequired(vtkSMProxy* proxy);
151 
152 private Q_SLOTS:
153  void triggerChangeFinished();
154  void triggerChangeAvailable();
155  void triggerRestartRequired();
156 
157 private: // NOLINT(readability-redundant-access-specifiers)
158  Q_DISABLE_COPY(pqProxiesWidget)
159 
160  class pqInternals;
161  const QScopedPointer<pqInternals> Internals;
162 };
163 
164 #endif
#define PQCOMPONENTS_EXPORT
This is a PQ abstraction of a generic view module.
Definition: pqView.h:54
pqProxiesWidget similar to pqProxyWidget with the difference being that unlike pqProxyWidget, pqProxiesWidget supports showing of multiple proxies in the same widget.
proxy for a VTK object(s) on a server
Definition: vtkSMProxy.h:152