Public Member Functions | Protected Member Functions | List of all members
pqPythonShellCompleter Class Reference

Completer class for Python shell, using interactive shell context to provide line completions. More...

#include <pqPythonShellCompleter.h>

Inheritance diagram for pqPythonShellCompleter:
Inheritance graph
[legend]
Collaboration diagram for pqPythonShellCompleter:
Collaboration graph
[legend]

Public Member Functions

 pqPythonShellCompleter (QWidget *parent, vtkPythonInteractiveInterpreter *interp)
 
- Public Member Functions inherited from pqPythonCompleter
 pqPythonCompleter (QWidget *parent)
 
- Public Member Functions inherited from pqWidgetCompleter
 pqWidgetCompleter (QWidget *parent)
 
virtual void updateCompletionModel (const QString &prompt)
 This method is called by the client to request an update on the internal completion model, given a text prompt. More...
 
bool getCompleteEmptyPrompts ()
 get/set CompleteEmptyPrompts, indicating whether or not the completer should show anything if an empty prompt is given. More...
 
void setCompleteEmptyPrompts (bool newValue)
 get/set CompleteEmptyPrompts, indicating whether or not the completer should show anything if an empty prompt is given. More...
 

Protected Member Functions

QStringList getPythonCompletions (const QString &pythonObjectName, bool call) override
 Given a text prompt, return a list of possible completions. More...
 
- Protected Member Functions inherited from pqPythonCompleter
QStringList getCompletions (const QString &prompt) override
 Return a list of strings that could match the given prompt. More...
 
QString getCompletionPrefix (const QString &prompt) override
 Return the part of the prompt that can be completed. More...
 
QString getVariableToComplete (const QString &prompt)
 From a prompt string that can contain multiple tokens, retrieve the last (possibly incomplete) variable name. More...
 
void appendPyObjectAttributes (PyObject *object, QStringList &results)
 Given a PyObject, append all of its attributes in the results list. More...
 
void appendFunctionKeywordArguments (PyObject *function, QStringList &results)
 Given a PyObject that is a function, append all of it's keyword arguments to the results list. More...
 
PyObjectderivePyObject (const QString &pythonObjectName, PyObject *locals)
 Given pythonObjectName string in the form "X.Y.Z.T" and script locals, return the most derived PyObject that matches the string. More...
 
PyObjectgetBuiltins (PyObject *locals)
 Given the locals namespace return the builtins objects as a dict. More...
 

Detailed Description

Completer class for Python shell, using interactive shell context to provide line completions.

Definition at line 16 of file pqPythonShellCompleter.h.

Constructor & Destructor Documentation

◆ pqPythonShellCompleter()

pqPythonShellCompleter::pqPythonShellCompleter ( QWidget *  parent,
vtkPythonInteractiveInterpreter *  interp 
)
inline

Definition at line 19 of file pqPythonShellCompleter.h.

Member Function Documentation

◆ getPythonCompletions()

QStringList pqPythonShellCompleter::getPythonCompletions ( const QString &  pythonObjectName,
bool  call 
)
overrideprotectedvirtual

Given a text prompt, return a list of possible completions.

This method must be implemented in concrete classes.

Implements pqPythonCompleter.


The documentation for this class was generated from the following file: