get_start_iter


Description:

public virtual bool get_start_iter (SourceCompletionContext context, SourceCompletionProposal proposal, out TextIter iter)

Get the TextIter at which the completion for proposal starts.

When implemented, this information is used to position the completion window accordingly when a proposal is selected in the completion window. The proposal text inside the completion window is aligned on iter.

If this function is not implemented, the word boundary is taken to position the completion window. See activate_proposal for an explanation on the word boundaries.

When the proposal is activated, the default handler uses iter as the start of the word to replace. See activate_proposal for more information.

Parameters:

this

a SourceCompletionProvider.

context

a SourceCompletionContext.

proposal

a SourceCompletionProposal.

iter

a TextIter.

Returns:

true if iter was set for proposal, false otherwise.