pqPropertyWidgetInterface.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: pqPropertyWidgetInterface.h
5 
6  Copyright (c) 2012 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 pqPropertyWidgetInterface_h
33 #define pqPropertyWidgetInterface_h
34 
35 #include <QtPlugin>
36 
37 #include "pqComponentsModule.h"
38 
39 class pqPropertyWidget;
41 class vtkPVXMLElement;
42 class vtkSMProperty;
43 class vtkSMPropertyGroup;
44 class vtkSMProxy;
45 
53 {
54 public:
55  // Destroys the property widget interface object.
56  virtual ~pqPropertyWidgetInterface();
57 
63  virtual pqPropertyWidget* createWidgetForProperty(
64  vtkSMProxy* proxy, vtkSMProperty* property, QWidget* parentWidget);
65 
71  virtual pqPropertyWidget* createWidgetForPropertyGroup(
72  vtkSMProxy* proxy, vtkSMPropertyGroup* group, QWidget* parentWidget);
73 
80  virtual pqPropertyWidgetDecorator* createWidgetDecorator(
81  const QString& type, vtkPVXMLElement* config, pqPropertyWidget* widget);
82 
86  virtual void createDefaultWidgetDecorators(pqPropertyWidget* widget);
87 };
88 
89 Q_DECLARE_INTERFACE(pqPropertyWidgetInterface, "com.kitware/paraview/propertywidget")
90 
91 #endif // pqPropertyWidgetInterface_h
pqPropertyWidget represents a widget created for each property of a proxy on the pqPropertiesPanel (f...
type
#define PQCOMPONENTS_EXPORT
pqPropertyWidgetInterface is part of the ParaView Plugin infrastructure that enables support for plug...
Q_DECLARE_INTERFACE(pqViewFrameActionsInterface, "com.kitware/paraview/viewframeactions")
superclass for all SM properties
proxy for a VTK object(s) on a server
Definition: vtkSMProxy.h:152
This is used by vtkPVXMLParser to represent an XML document starting at the root element.
pqPropertyWidgetDecorator provides a mechanism to decorate pqPropertyWidget instances to add logic to...