pqPythonCompleter.h

Go to the documentation of this file.

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

#include "vtkPython.h"

#include "pqPythonModule.h"    //  needed for PQPYTHON_EXPORT.
#include "pqWidgetCompleter.h" // Defines pqWidgetCompleter interface

class PQPYTHON_EXPORT pqPythonCompleter : public pqWidgetCompleter
{
public:
  pqPythonCompleter(QWidget* parent)
    : pqWidgetCompleter(parent){};

protected:
  QStringList getCompletions(const QString& prompt) override;
  QString getCompletionPrefix(const QString& prompt) override;

  QString getVariableToComplete(const QString& prompt);

  void appendPyObjectAttributes(PyObject* object, QStringList& results);

  void appendFunctionKeywordArguments(PyObject* function, QStringList& results);

  PyObject* derivePyObject(const QString& pythonObjectName, PyObject* locals);

  PyObject* getBuiltins(PyObject* locals);

  virtual QStringList getPythonCompletions(const QString& pythonObjectName, bool call) = 0;
};
#endif