Public Member Functions | Protected Member Functions | List of all members
pqWidgetCompleter Class Referenceabstract

Abstact class for widget completers. More...

#include <pqWidgetCompleter.h>

Inheritance diagram for pqWidgetCompleter:
Inheritance graph
[legend]

Public Member Functions

 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

virtual QStringList getCompletions (const QString &prompt)=0
 Return a list of strings that could match the given prompt. More...
 
virtual QString getCompletionPrefix (const QString &prompt)=0
 Return the part of the prompt that can be completed. More...
 

Detailed Description

Abstact class for widget completers.

Concrete implementations must define functions that return possible completions given a prompt, and the completion prefix corresponding to the incomplete name.

Definition at line 16 of file pqWidgetCompleter.h.

Constructor & Destructor Documentation

◆ pqWidgetCompleter()

pqWidgetCompleter::pqWidgetCompleter ( QWidget *  parent)
inline

Definition at line 19 of file pqWidgetCompleter.h.

Member Function Documentation

◆ updateCompletionModel()

virtual void pqWidgetCompleter::updateCompletionModel ( const QString &  prompt)
virtual

This method is called by the client to request an update on the internal completion model, given a text prompt.

◆ getCompleteEmptyPrompts()

bool pqWidgetCompleter::getCompleteEmptyPrompts ( )
inline

get/set CompleteEmptyPrompts, indicating whether or not the completer should show anything if an empty prompt is given.

Definition at line 32 of file pqWidgetCompleter.h.

◆ setCompleteEmptyPrompts()

void pqWidgetCompleter::setCompleteEmptyPrompts ( bool  newValue)
inline

get/set CompleteEmptyPrompts, indicating whether or not the completer should show anything if an empty prompt is given.

Definition at line 33 of file pqWidgetCompleter.h.

◆ getCompletions()

virtual QStringList pqWidgetCompleter::getCompletions ( const QString &  prompt)
protectedpure virtual

Return a list of strings that could match the given prompt.

Implemented in pqPythonCompleter.

◆ getCompletionPrefix()

virtual QString pqWidgetCompleter::getCompletionPrefix ( const QString &  prompt)
protectedpure virtual

Return the part of the prompt that can be completed.

Implemented in pqPythonCompleter.


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