.TH "KTextEditor::CodeCompletionInterface" kde3 "11 Jun 2005" "Version Version 3.4.1" "interfaces Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KTextEditor::CodeCompletionInterface \- This is an interface for the \fBKTextEditor::View\fP class.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <codecompletioninterface.h>\fP
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "unsigned int \fBcodeCompletionInterfaceNumber\fP () const "
.br
.ti -1c
.RI "virtual void \fBshowArgHint\fP (\fBQStringList\fP functionList, const \fBQString\fP &strWrapping, const \fBQString\fP &strDelimiter)=0"
.br
.ti -1c
.RI "virtual void \fBshowCompletionBox\fP (\fBQValueList\fP< \fBCompletionEntry\fP > complList, int offset=0, bool casesensitive=true)=0"
.br
.ti -1c
.RI "virtual void \fBcompletionAborted\fP ()=0"
.br
.ti -1c
.RI "virtual void \fBcompletionDone\fP ()=0"
.br
.ti -1c
.RI "virtual void \fBcompletionDone\fP (\fBCompletionEntry\fP)=0"
.br
.ti -1c
.RI "virtual void \fBargHintHidden\fP ()=0"
.br
.ti -1c
.RI "virtual void \fBfilterInsertString\fP (\fBCompletionEntry\fP *, \fBQString\fP *)=0"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBsetCodeCompletionInterfaceDCOPSuffix\fP (const \fBQCString\fP &suffix)"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBPrivateCodeCompletionInterface\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
This is an interface for the \fBKTextEditor::View\fP 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.
.PP
There are other signals, which may be implmemented, but aren't documented here, because it would have been a BIC change...:
.PP
void completionExtendedComment(CompletionEntry)
.PP
This is emitted when the user has completed the argument entry (ie. enters the wrapping symbol(s) void argHintCompleted()
.PP
This is emitted when there is a reason other than completion for the hint being hidden. void argHintAborted()
.PP
This is emitted when a code completion box is about to be displayed void aboutToShowCompletionBox() 
.PP
Definition at line 86 of file codecompletioninterface.h.
.SH "Member Function Documentation"
.PP 
.SS "virtual void KTextEditor::CodeCompletionInterface::showArgHint (\fBQStringList\fP functionList, const \fBQString\fP & strWrapping, const \fBQString\fP & strDelimiter)\fC [pure virtual]\fP"
.PP
This shows an argument hint. 
.PP
.SS "virtual void KTextEditor::CodeCompletionInterface::showCompletionBox (\fBQValueList\fP< \fBCompletionEntry\fP > complList, int offset = \fC0\fP, bool casesensitive = \fCtrue\fP)\fC [pure virtual]\fP"
.PP
This shows a completion list. 
.PP
\fCoffset\fP is the real start of the text that should be completed. \fC0\fP means that the text starts at the current cursor position. if \fCcasesensitive\fP is \fCtrue\fP, the popup will only contain completions that match the input text regarding case. 
.SS "virtual void KTextEditor::CodeCompletionInterface::completionAborted ()\fC [pure virtual]\fP"
.PP
This signal is emitted when the completion list disappears and no completion has been done. 
.PP
This is the case e.g. when the user presses Escape.
.PP
IMPORTANT: Please check if a connect to this signal worked, and implement some fallback when the implementation doesn't support it
.PP
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
.SS "virtual void KTextEditor::CodeCompletionInterface::completionDone ()\fC [pure virtual]\fP"
.PP
This signal is emitted when the completion list disappears and a completion has been inserted into text. 
.PP
This is the case e.g. when the user presses Return on a selected item in the completion list.
.PP
IMPORTANT: Please check if a connect to this signal worked, and implement some fallback when the implementation doesn't support it
.PP
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
.SS "virtual void KTextEditor::CodeCompletionInterface::completionDone (\fBCompletionEntry\fP)\fC [pure virtual]\fP"
.PP
This signal is the same as \fBcompletionDone()\fP, but additionally it carries the information which completion item was used. 
.PP
IMPORTANT: Please check if a connect to this signal worked, and implement some fallback when the implementation doesn't support it
.PP
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
.PP
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.
.SS "virtual void KTextEditor::CodeCompletionInterface::argHintHidden ()\fC [pure virtual]\fP"
.PP
This signal is emitted when the argument hint disappears. 
.PP
This is the case e.g. when the user moves the cursor somewhere else.
.PP
IMPORTANT: Please check if a connect to this signal worked, and implement some fallback when the implementation doesn't support it
.PP
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
.SS "virtual void KTextEditor::CodeCompletionInterface::filterInsertString (\fBCompletionEntry\fP *, \fBQString\fP *)\fC [pure virtual]\fP"
.PP
This signal is emitted just before a completion takes place. 
.PP
You can use it to modify the \fBCompletionEntry\fP. 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.
.PP
IMPORTANT: Please check if a connect to this signal worked, and implement some fallback when the implementation doesn't support it
.PP
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

.SH "Author"
.PP 
Generated automatically by Doxygen for interfaces Library from the source code.
