/*=========================================================================

   Program: ParaView
   Module: pqPropertyWidgetInterface.h

   Copyright (c) 2012 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.2.

   See License_v1.2.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

=========================================================================*/
#ifndef _pqPropertyWidgetInterface_h
#define _pqPropertyWidgetInterface_h

#include <QtPlugin>

#include "pqComponentsModule.h"

class pqPropertyWidget;
class pqPropertyWidgetDecorator;
class vtkPVXMLElement;
class vtkSMProperty;
class vtkSMPropertyGroup;
class vtkSMProxy;

/// pqPropertyWidgetInterface is part of the ParaView Plugin infrastructure that
/// enables support for plugins to add new pqPropertyWidget and
/// pqPropertyWidgetDecorator types and make them available within the
/// application.
class PQCOMPONENTS_EXPORT pqPropertyWidgetInterface
{
public:
  // Destroys the property widget interface object.
  virtual ~pqPropertyWidgetInterface();

  /// Given a proxy and its property, create a widget for the same, of possible.
  /// For unsupported/unknown proxies/properties, implementations should simply
  /// return NULL without raising any errors (or messages).
  virtual pqPropertyWidget* createWidgetForProperty(vtkSMProxy *proxy,
                                                    vtkSMProperty *property);

  /// Given a proxy and its property group, create a widget for the same, of possible.
  /// For unsupported/unknown proxies/property-groups, implementations should simply
  /// return NULL without raising any errors (or messages).
  virtual pqPropertyWidget* createWidgetForPropertyGroup(vtkSMProxy *proxy,
                                                         vtkSMPropertyGroup *group);

  /// Given the type of the decorator and the pqPropertyWidget that needs to be
  /// decorated, create the pqPropertyWidgetDecorator instance, if possible.
  /// For unsupported/unknown, implementations should simply return NULL without
  /// raising any errors (or messages).
  virtual pqPropertyWidgetDecorator* createWidgetDecorator(
    const QString& type, vtkPVXMLElement* config, pqPropertyWidget* widget);
};

Q_DECLARE_INTERFACE(pqPropertyWidgetInterface, "com.kitware/paraview/propertywidget")

#endif // _pqPropertyWidgetInterface_h