class CodeCompletionInterface

# class CodeCompletionInterface | This is an interface for the KTextEditor::View class. More...
Contains pure virtuals
Full name | `KTextEditor::CodeCompletionInterface`
Definition | `#include <codecompletioninterface.h>`
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

#### Public Methods

- CodeCompletionInterface ()
- virtual ~CodeCompletionInterface ()
- unsigned int codeCompletionInterfaceNumber () const
- virtual void showArgHint (QStringList functionList, const QString& strWrapping, const QString& strDelimiter)
- virtual void showCompletionBox (QValueList complList,int offset=0, bool casesensitive=true)
- virtual void completionAborted ()
- virtual void completionDone ()
- virtual void completionDone (CompletionEntry)
- virtual void argHintHidden ()
- virtual void filterInsertString (CompletionEntry*,QString*)

#### Protected Methods

- void setCodeCompletionInterfaceDCOPSuffix (const QCString &suffix)

## Detailed Description

This is an interface for the KTextEditor::View class. It can be used to show completion lists, i.e. lists that pop up while a user is typing. The user can then choose from the list or he can just keep typing. The completion list will disappear if an item is chosen, if no completion is available or if the user presses Esc etc. The contents of the list is automatically adapted to the string the user types.

There is another signal, which may be implmemented, but isn't documented here, because it would have been a BIC change and I'm not sure if it is really of need

void completionExtendedComment(CompletionEntry)

CodeCompletionInterface () | ### CodeCompletionInterface

~CodeCompletionInterface () | ### ~CodeCompletionInterface

[virtual]

unsigned int codeCompletionInterfaceNumber () | ### codeCompletionInterfaceNumber

[const]

void setCodeCompletionInterfaceDCOPSuffix (const QCString &suffix) | ### setCodeCompletionInterfaceDCOPSuffix

[protected]

void showArgHint (QStringList functionList, const QString& strWrapping, const QString& strDelimiter) | ### showArgHint

[pure virtual]

This shows an argument hint.

void showCompletionBox (QValueList complList,int offset=0, bool casesensitive=true) | ### showCompletionBox

[pure virtual]

This shows a completion list. `offset` is the real start of the text that should be completed. `0` means that the text starts at the current cursor position. if `casesensitive` is `true`, the popup will only contain completions that match the input text regarding case.

void completionAborted () | ### completionAborted

[pure virtual]

This signal is emitted when the completion list disappears and no completion has been done. This is the case e.g. when the user presses Escape.

IMPORTANT: Please check if a connect to this signal worked, and implement some fallback when the implementation doesn't support it

IMPORTANT FOR IMPLEMENTERS: When you don't support this signal, please just override the inherited function, if you support it, declare it as a signal

void completionDone () | ### completionDone

[pure virtual]

This signal is emitted when the completion list disappears and a completion has been inserted into text. This is the case e.g. when the user presses Return on a selected item in the completion list.

IMPORTANT: Please check if a connect to this signal worked, and implement some fallback when the implementation doesn't support it

IMPORTANT FOR IMPLEMENTERS: When you don't support this signal, please just override the inherited function, if you support it, declare it as a signal

void completionDone (CompletionEntry) | ### completionDone

[pure virtual]

This signal is the same as completionDone(), but additionally it carries the information which completion item was used.

IMPORTANT: Please check if a connect to this signal worked, and implement some fallback when the implementation doesn't support it

IMPORTANT: The pointer to the CompleteionEntry, is only valid in the slots connected to this signal when the connected slots are left, the data element may be destroyed, depending on the implementation

IMPORTANT FOR IMPLEMENTERS: When you don't support this signal, please just override the inherited function, if you support it, declare it as a signal.

void argHintHidden () | ### argHintHidden

[pure virtual]

This signal is emitted when the argument hint disappears. This is the case e.g. when the user moves the cursor somewhere else.

IMPORTANT: Please check if a connect to this signal worked, and implement some fallback when the implementation doesn't support it

IMPORTANT FOR IMPLEMENTERS: When you don't support this signal, please just override the inherited function, if you support it, declare it as a signal

void filterInsertString (CompletionEntry*,QString*) | ### filterInsertString

[pure virtual]

This signal is emitted just before a completion takes place. You can use it to modify the CompletionEntry. The modified entry will not be visible in the completion list (because that has just disappeared) but it will be used when the completion is inserted into the text.

IMPORTANT: Please check if a connect to this signal worked, and implement some fallback when the implementation doesn't support it

IMPORTANT FOR IMPLEMENTERS: When you don't support this signal, please just override the inherited function, if you support it, declare it as a signal

Generated by: root on macppc.ports.openbsd.org on Sat Sep 6 10:38:11 2003, using kdoc 2.0a54.