pqPythonCalculatorCompleter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef pqPythonCalculatorCompleter_h
#define pqPythonCalculatorCompleter_h

#include "pqPythonCompleter.h"
#include "vtkSMSourceProxy.h" // For vtkSMSourceProxy

class PQPYTHON_EXPORT pqPythonCalculatorCompleter : public pqPythonCompleter
{
public:
  pqPythonCalculatorCompleter(QWidget* parent, vtkSMSourceProxy* input)
    : pqPythonCompleter(parent)
    , Input(input)
  {
    this->setCompleteEmptyPrompts(true); // Override pqPythonCompleter default
  }

  struct FunctionInfo
  {
    QString name;
    QString docstring;
    QString module;
  };

  static QList<FunctionInfo> getFunctionInfos(const QStringList& ignoredModules = {});

protected:
  QStringList getPythonCompletions(const QString& pythonObjectName, bool call) override;

  void AddArrayNamesToResults(
    const vtkPVDataSetAttributesInformation* attributesInformation, QStringList& results);

private:
  vtkSMSourceProxy* Input; // Needed to retrieve input field names
};
#endif