IAssistProvider Class

(TextEditor::IAssistProvider)

The IAssistProvider class acts as an interface for providing code assist. More...

Header: #include <IAssistProvider>
Inherits: QObject

Public Types

enum RunType { Synchronous, Asynchronous, AsynchronousWithThread }

Public Functions

IAssistProvider(QObject *parent = 0)
virtual IAssistProcessor *createProcessor() const = 0
virtual RunType runType() const = 0
virtual bool supportsEditor(Core::Id editorId) const = 0
  • 32 public functions inherited from QObject

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public slot inherited from QObject
  • 2 signals inherited from QObject
  • 1 public variable inherited from QObject
  • 10 static public members inherited from QObject
  • 9 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

The IAssistProvider class acts as an interface for providing code assist.

There might be different kinds of assist such as completions or refactoring actions (quickfixes).

Within this API the term completion denotes any kind of information prompted to the user in order to auxiliate her to "complete" a particular code construction. Examples of completions currently supported are snippets, function hints, and contextual contents.

This is class is part of the CodeAssist API.

See also IAssistProposal and IAssistProcessor.

Member Type Documentation

enum IAssistProvider::RunType

Member Function Documentation

IAssistProvider::IAssistProvider(QObject *parent = 0)

Default constructs an instance of IAssistProvider.

[pure virtual] IAssistProcessor *IAssistProvider::createProcessor() const

Creates and returns the IAssistProcessor responsible for computing an IAssistProposal.

[pure virtual] RunType IAssistProvider::runType() const

[pure virtual] bool IAssistProvider::supportsEditor(Core::Id editorId) const

Returns whether this provider supports the editor which has the editorId.