// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2004 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov

/*========================================================================
 For general information about using VTK and Qt, see:
 http://www.trolltech.com/products/3rdparty/vtksupport.html
=========================================================================*/

/*========================================================================
 !!! WARNING for those who want to contribute code to this file.
 !!! If you use a commercial edition of Qt, you can modify this code.
 !!! If you use an open source version of Qt, you are free to modify
 !!! and use this code within the guidelines of the GPL license.
 !!! Unfortunately, you cannot contribute the changes back into this
 !!! file.  Doing so creates a conflict between the GPL and BSD-like VTK
 !!! license.
=========================================================================*/

/**
 * @class   vtkEventQtSlotConnect
 * @brief   Manage connections between VTK events and Qt slots.
 *
 * vtkEventQtSlotConnect provides a way to manage connections between VTK events
 * and Qt slots.
 * Qt slots to connect with must have one of the following signatures:
 * - MySlot()
 * - MySlot(vtkObject* caller)
 * - MySlot(vtkObject* caller, unsigned long vtk_event)
 * - MySlot(vtkObject* caller, unsigned long vtk_event, void* client_data)
 * - MySlot(vtkObject* caller, unsigned long vtk_event, void* client_data, void* call_data)
 * - MySlot(vtkObject* caller, unsigned long vtk_event, void* client_data, void* call_data,
 * vtkCommand*)
 */

#ifndef vtkEventQtSlotConnect_h
#define vtkEventQtSlotConnect_h

#include "QVTKWin32Header.h"       // for export define
#include "vtkCommand.h"            // for event defines
#include "vtkGUISupportQtModule.h" // For export macro
#include "vtkObject.h"
#include <QtCore/QObject> // for version info

class QObject;

VTK_ABI_NAMESPACE_BEGIN
class vtkQtConnections;
class vtkQtConnection;

// manage connections between VTK object events and Qt slots
class VTKGUISUPPORTQT_EXPORT vtkEventQtSlotConnect : public vtkObject
{
public:
  static vtkEventQtSlotConnect* New();
  vtkTypeMacro(vtkEventQtSlotConnect, vtkObject);

  /**
   * Print the current connections between VTK and Qt
   */
  void PrintSelf(ostream& os, vtkIndent indent) override;

  /**
   * Connect a vtk object's event with a Qt object's slot.  Multiple
   * connections which are identical are treated as separate connections.
   */
  virtual void Connect(vtkObject* vtk_obj, unsigned long event, const QObject* qt_obj,
    const char* slot, void* client_data = nullptr, float priority = 0.0,
    Qt::ConnectionType type = Qt::AutoConnection);

  /**
   * Disconnect a vtk object from a qt object.
   * Passing no arguments will disconnect all slots maintained by this object.
   * Passing in only a vtk object will disconnect all slots from it.
   * Passing only a vtk object and event, will disconnect all slots matching
   * the vtk object and event.
   * Passing all information in will match all information.
   */
  virtual void Disconnect(vtkObject* vtk_obj = nullptr, unsigned long event = vtkCommand::NoEvent,
    const QObject* qt_obj = nullptr, const char* slot = nullptr, void* client_data = nullptr);

  /**
   * Allow to query vtkEventQtSlotConnect to know if some Connect() have been
   * setup and how many.
   */
  virtual int GetNumberOfConnections() const;

protected:
  vtkQtConnections* Connections;
  friend class vtkQtConnection;
  void RemoveConnection(vtkQtConnection*);

  vtkEventQtSlotConnect();
  ~vtkEventQtSlotConnect() override;

private:
  vtkEventQtSlotConnect(const vtkEventQtSlotConnect&) = delete;
  void operator=(const vtkEventQtSlotConnect&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif
