IAssistProcessor Class | Extending Qt Creator Manual

Extending Qt Creator Manual | IAssistProcessor

Extending Qt Creator Manual 4.4.1

# IAssistProcessor Class

(TextEditor::IAssistProcessor)

The IAssistProcessor class acts as an interface that actually computes an assist proposal. More...

Header: | #include <IAssistProcessor>

- List of all members, including inherited members

## Public Functions

| IAssistProcessor()
virtual | ~IAssistProcessor()
virtual IAssistProposal * | immediateProposal(const AssistInterface *)
virtual IAssistProposal * | perform(const AssistInterface *interface) = 0
bool | performWasApplicable()
void | setAsyncCompletionAvailableHandler(const AsyncCompletionsAvailableHandler &finalizer)
void | setAsyncProposalAvailable(IAssistProposal *proposal)
void | setPerformWasApplicable(bool applicable)

## Detailed Description

The IAssistProcessor class acts as an interface that actually computes an assist proposal.

See also IAssistProposal and IAssistProvider.

## Member Function Documentation

### IAssistProcessor::IAssistProcessor()

Default constructs an instance of IAssistProcessor.

### `[virtual]` IAssistProcessor::~IAssistProcessor()

Destroys the instance of IAssistProcessor. The destructor is virtual.

### `[virtual]` IAssistProposal *IAssistProcessor::immediateProposal(const AssistInterface *)

### `[pure virtual]` IAssistProposal *IAssistProcessor::perform(const AssistInterface *interface)

Computes a proposal and returns it. Access to the document is made through the interface. If this is an asynchronous processor the interface will be detached.

The processor takes ownership of the interface. Also, one should be careful in the case of sharing data across asynchronous processors since there might be more than one instance of them computing a proposal at a particular time.

See also AssistInterface::detach().

### bool IAssistProcessor::performWasApplicable()

See also setPerformWasApplicable().

### void IAssistProcessor::setAsyncCompletionAvailableHandler(const AsyncCompletionsAvailableHandler &finalizer)

### void IAssistProcessor::setAsyncProposalAvailable(IAssistProposal *proposal)

### void IAssistProcessor::setPerformWasApplicable(bool applicable)

See also performWasApplicable().