KDE API ReferenceKTextEditor
#include <codecompletionmodelcontrollerinterface.h>
Public Types | |
| enum | MatchReaction { None =0, HideListIfAutomaticInvocation =1, ForExtension =0xffff } |
Public Member Functions | |
| CodeCompletionModelControllerInterface3 () | |
| virtual | ~CodeCompletionModelControllerInterface3 () |
| virtual void | aborted (View *view) |
| virtual Range | completionRange (View *view, const Cursor &position) |
| virtual QString | filterString (View *view, const Range &range, const Cursor &position) |
| virtual MatchReaction | matchingItem (const QModelIndex &matched) |
| virtual bool | shouldAbortCompletion (View *view, const Range &range, const QString ¤tCompletion) |
| virtual bool | shouldExecute (const QModelIndex &selected, QChar inserted) |
| virtual bool | shouldStartCompletion (View *view, const QString &insertedText, bool userInsertion, const Cursor &position) |
| virtual Range | updateCompletionRange (View *view, const Range &range) |
Detailed Description
Controller interface for a CodeCompletionModel.
The CodeCompletionModelControllerInterface3 gives an CodeCompletionModel better control over the completion.
By implementing methods defined in this interface you can:
- control when automatic completion should start (shouldStartCompletion())
- define a custom completion range (that will be replaced when the completion is executed) (completionRange())
- dynamically modify the completion range during completion (updateCompletionRange())
- specify the string used for filtering the completion (filterString())
- control when completion should stop (shouldAbortCompletion())
When the interface is not implemented, or no methods are overridden the default behaviour is used, which will be correct in many situations.
Implemeting the Interface
To use this class implement it in your CodeCompletionModel.
- See also
- CodeCompletionModel
- Since
- 4.5
Definition at line 226 of file codecompletionmodelcontrollerinterface.h.
Member Enumeration Documentation
| Enumerator | |
|---|---|
| None | |
| HideListIfAutomaticInvocation | |
| ForExtension |
If this is returned, the completion-list is hidden if it was invoked automatically. |
Definition at line 326 of file codecompletionmodelcontrollerinterface.h.
Constructor & Destructor Documentation
| KTextEditor::CodeCompletionModelControllerInterface3::CodeCompletionModelControllerInterface3 | ( | ) |
Definition at line 119 of file codecompletionmodelcontrollerinterface.cpp.
|
virtual |
Definition at line 123 of file codecompletionmodelcontrollerinterface.cpp.
Member Function Documentation
|
virtual |
Notification that completion for this model has been aborted.
- Parameters
-
view The view in which the completion for this model was aborted
Definition at line 190 of file codecompletionmodelcontrollerinterface.cpp.
|
virtual |
This function returns the completion range that will be used for the current completion.
This range will be used for filtering the completion list and will get replaced when executing the completion
The default implementation will work for most languages that don't have special chars in identifiers.
- Parameters
-
view The view to generate completions for position Current cursor position
- Returns
- the completion range
Definition at line 142 of file codecompletionmodelcontrollerinterface.cpp.
|
virtual |
This function returns the filter-text used for the current completion.
Can return an empty string to disable filtering.
The default implementation will return the text from range start to the cursor position.
The smart-mutex is not locked when this is called.
- Parameters
-
view The view to generate completions for range The completion range position Current cursor position
- Returns
- the string used for filtering the completion list
Definition at line 173 of file codecompletionmodelcontrollerinterface.cpp.
|
virtual |
Called whenever an item in the completion-list perfectly matches the current filter text.
- Parameters
-
The index that is matched
- Returns
- Whether the completion-list should be hidden on this event. The default-implementation always returns HideListIfAutomaticInvocation
Definition at line 200 of file codecompletionmodelcontrollerinterface.cpp.
|
virtual |
This function decides if the completion should be aborted.
Called after every change to the range (eg. when user entered text)
The default implementation will return true when any special character was entered, or when the range is empty.
The smart-mutex is not locked when this is called.
- Parameters
-
view The view to generate completions for range The completion range currentCompletion The text typed so far
- Returns
- true, if the completion should be aborted, otherwise false
Definition at line 178 of file codecompletionmodelcontrollerinterface.cpp.
|
virtual |
When an item within this model is currently selected in the completion-list, and the user inserted the given character, should the completion-item be executed? This can be used to execute items from other inputs than the return-key.
For example a function item could be executed by typing '(', or variable items by typing '.'.
- Parameters
-
selected The currently selected index inserted The character that was inserted by tue user
Definition at line 194 of file codecompletionmodelcontrollerinterface.cpp.
|
virtual |
This function decides if the automatic completion should be started when the user entered some text.
The default implementation will return true if the last character in insertedText is a letter, a number, '.', '_' or '>'
- Parameters
-
view The view to generate completions for insertedText The text that was inserted by the user userInsertion Whether the text was inserted by the user using typing. If false, it may have been inserted for example by code-completion. position Current cursor position
- Returns
- true, if the completion should be started, otherwise false
Definition at line 127 of file codecompletionmodelcontrollerinterface.cpp.
|
virtual |
This function lets the CompletionModel dynamically modify the range.
Called after every change to the range (eg. when user entered text)
The default implementation does nothing.
The smart-mutex is not locked when this is called.
- Warning
- Make sure you lock it before you change the range
- Parameters
-
view The view to generate completions for range Reference to the current range
- Returns
- the modified range
Definition at line 163 of file codecompletionmodelcontrollerinterface.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat May 9 2020 03:56:48 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.
