KLineEdit *edit = new KLineEdit(this);
KCompletion *comp = edit->completionObject();
// Connect to the Return pressed signal - optional
connect(edit, &KLineEdit::returnKeyPressed, comp, [this](const QString &text) { addItem(text); });

KLineEdit *edit = new KLineEdit(this);
KUrlCompletion *comp = new KUrlCompletion();
edit->setCompletionObject(comp);
// Connect to the return pressed signal - optional
connect(edit, &KLineEdit::returnKeyPressed, comp, [this](const QString &text) { addItem(text); });

edit->setAutoDeleteCompletionObject(true);

// Tell the widget to not handle completion and iteration automatically
edit->setHandleSignals(false);

// Set your own key-bindings for a text completion mode
edit->setKeyBinding(KCompletionBase::TextCompletion, Qt::End);

// Hide the context (popup) menu
edit->setContextMenuPolicy(Qt::NoContextMenu);

// Default the key-bindings back to the default system settings
edit->useGlobalKeyBindings();

Member Function Documentation

[explicit] KLineEdit::KLineEdit(QWidget *parent = nullptr)

Constructs a line edit parent The parent widget of the line edit.

[explicit] KLineEdit::KLineEdit(const QString &string, QWidget *parent = nullptr)

Constructs a KLineEdit object with a default text, a parent, and a name.

string Text to be shown in the edit widget. parent The parent widget of the line edit.

[signal] void KLineEdit::aboutToShowContextMenu(QMenu *contextMenu)

Emitted before the context menu is displayed.

The signal allows you to add your own entries into the the context menu that is created on demand.

contextMenu the context menu about to be displayed

[protected] bool KLineEdit::autoSuggest() const

Whether in current state text should be auto-suggested

[signal] void KLineEdit::clearButtonClicked()

Emitted when the user clicked on the clear button

[since 4.1] QSize KLineEdit::clearButtonUsedSize() const

Returns the size used by the clear button

This function was introduced in 4.1.

[signal] void KLineEdit::completion(const QString &)

Emitted when the completion key is pressed.

Please note that this signal is not emitted if the completion mode is set to CompletionNone or EchoMode is normal.

[virtual] KCompletionBox *KLineEdit::completionBox(bool create = true)

This method will create a completion-box if none is there, yet.

create Set this to false if you don't want the box to be created i.e. to test if it is available.

Returns the completion-box, that is used in completion mode CompletionPopup.

See also setCompletionBox().

[signal] void KLineEdit::completionBoxActivated(const QString &)

Emitted whenever the completion box is activated.

[signal] void KLineEdit::completionModeChanged(KCompletion::CompletionMode)

Emitted when the user changed the completion mode by using the popupmenu.

[since 4.2.1] void KLineEdit::doCompletion(const QString &text)

Do completion now. This is called automatically when typing a key for instance. Emits completion() and/or calls makeCompletion(), depending on emitSignals and handleSignals.

This function was introduced in 4.2.1.

bool KLineEdit::isSqueezedTextEnabled() const

Returns true if text squeezing is enabled.

This is only valid when the widget is in read-only mode.

[virtual protected slot] void KLineEdit::makeCompletion(const QString &)

Completes the remaining text with a matching one from a given list.

QString KLineEdit::originalText() const

Returns the original text if text squeezing is enabled. If the widget is not in "read-only" mode, this function returns the same thing as QLineEdit::text().

See also QLineEdit.

[signal, since 5.81] void KLineEdit::returnKeyPressed(const QString &text)

Emitted when the user presses the Return or Enter key.

The argument is the current text. Note that this signal is not emitted if the widget's EchoMode is set to QLineEdit::EchoMode.

This function was introduced in 5.81.

[slot] void KLineEdit::rotateText(KCompletionBase::KeyBindingType type)

Iterates through all possible matches of the completed text or the history list.

This function simply iterates over all possible matches in case multiple matches are found as a result of a text completion request. It will have no effect if only a single match is found.

type The key-binding invoked.

[override virtual slot] void KLineEdit::setCompletedItems(const QStringList &items, bool autoSuggest = true)

Reimplements: KCompletionBase::setCompletedItems(const QStringList &items, bool autoSuggest).

Same as the above function except it allows you to temporarily turn off text completion in CompletionPopupAuto mode.

items list of completion matches to be shown in the completion box.

autoSuggest true if you want automatic text completion (suggestion) enabled.

[virtual protected] void KLineEdit::setCompletedText(const QString &, bool)

This function simply sets the lineedit text and highlights the text appropriately if the boolean value is set to true.

void KLineEdit::setCompletionBox(KCompletionBox *box)

Set the completion-box to be used in completion mode CompletionPopup. This will do nothing if a completion-box already exists.

box The KCompletionBox to set

See also completionBox().

void KLineEdit::setCompletionModeDisabled(KCompletion::CompletionMode mode, bool disable = true)

Disables completion modes by making them non-checkable.

The context menu allows to change the completion mode. This method allows to disable some modes.

[virtual slot] void KLineEdit::setReadOnly(bool)

Sets the lineedit to read-only. Similar to QLineEdit::setReadOnly but also takes care of the background color, and the clear button.

[slot] void KLineEdit::setSqueezedText(const QString &text)

Squeezes text into the line edit.

This can only be used with read-only line-edits.

void KLineEdit::setSqueezedTextEnabled(bool enable)

Enable text squeezing whenever the supplied text is too long. Only works for "read-only" mode.

Note that once text squeezing is enabled, QLineEdit::text() and QLineEdit::displayText() return the squeezed text. If you want the original text, use originalText.

See also isSqueezedTextEnabled() and QLineEdit.

void KLineEdit::setTrapReturnKey(bool trap)

By default, KLineEdit recognizes Key_Return and Key_Enter and emits the returnPressed() signals, but it also lets the event pass, for example causing a dialog's default-button to be called.

Call this method with trap = true to make KLineEdit stop these events. The signals will still be emitted of course.

See also trapReturnKey().

void KLineEdit::setUrl(const QUrl &url)

Sets url into the lineedit. It uses QUrl::toDisplayString() so that the url is properly decoded for displaying.

void KLineEdit::setUrlDropsEnabled(bool enable)

Enables/Disables handling of URL drops. If enabled and the user drops an URL, the decoded URL will be inserted. Otherwise the default behavior of QLineEdit is used, which inserts the encoded URL. Call setUrlDropsEnabled(false) if you need dropEvent to be called in a KLineEdit subclass.

enable If true, insert decoded URLs

See also urlDropsEnabled().

[protected] void KLineEdit::setUserSelection(bool userSelection)

Sets the widget in userSelection mode or in automatic completion selection mode. This changes the colors of selections.

[signal] void KLineEdit::substringCompletion(const QString &)

Emitted when the shortcut for substring completion is pressed.

[signal] void KLineEdit::textRotation(KCompletionBase::KeyBindingType)

Emitted when the text rotation key-bindings are pressed.

The argument indicates which key-binding was pressed. In KLineEdit's case this can be either one of two values: PrevCompletionMatch or NextCompletionMatch. See KCompletionBase::setKeyBinding for details.

Note that this signal is not emitted if the completion mode is set to CompletionNone or echoMode() is not normal.

bool KLineEdit::trapReturnKey() const

Returns true if keyevents of Key_Return or Key_Enter will be stopped or if they will be propagated.

See also setTrapReturnKey().

bool KLineEdit::urlDropsEnabled() const

Returns true when decoded URL drops are enabled

See also setUrlDropsEnabled().

[protected slot] void KLineEdit::userCancelled(const QString &cancelText)

Resets the current displayed text. Call this function to revert a text completion if the user cancels the request. Mostly applies to popup completions.

[since 4.2.2] QString KLineEdit::userText() const

Returns the text as given by the user (i.e. not autocompleted) if the widget has autocompletion disabled, this function returns the same as QLineEdit::text().

This function was introduced in 4.2.2.