KLineEdit
#include <KLineEdit>
Signals | |
void | aboutToShowContextMenu (QMenu *contextMenu) |
void | clearButtonClicked () |
void | completion (const QString &) |
void | completionBoxActivated (const QString &) |
void | completionModeChanged (KCompletion::CompletionMode) |
void | returnKeyPressed (const QString &text) |
void | substringCompletion (const QString &) |
void | textRotation (KCompletionBase::KeyBindingType) |
Public Slots | |
void | rotateText (KCompletionBase::KeyBindingType type) |
void | setCompletedItems (const QStringList &items, bool autoSuggest=true) override |
void | setCompletedText (const QString &) override |
virtual void | setReadOnly (bool) |
void | setSqueezedText (const QString &text) |
virtual void | setText (const QString &) |
Protected Slots | |
virtual void | makeCompletion (const QString &) |
void | userCancelled (const QString &cancelText) |
Detailed Description
An enhanced QLineEdit widget for inputting text.
Detail
This widget inherits from QLineEdit and implements the following additional functionalities:
- a completion object that provides both automatic and manual text completion as well as multiple match iteration features
- configurable key-bindings to activate these features
- a popup-menu item that can be used to allow the user to set text completion modes on the fly based on their preference
To support these features KLineEdit also emits a few more additional signals:
completion(const QString &)
: this signal can be connected to a slot that will assist the user in filling out the remaining texttextRotation(KeyBindingType)
: this signal is intended to be used to iterate through the list of all possible matches whenever there is more than one match for the entered textreturnKeyPressed(const QString &)
: this signal provides the current text in the widget as its argument whenever appropriate (this is in addition to theQLineEdit::returnPressed()
signal which KLineEdit inherits from QLineEdit).
This widget by default creates a completion object when you invoke the completionObject(bool)
member function for the first time or use setCompletionObject(KCompletion *, bool)
to assign your own completion object. Additionally, to make this widget more functional, KLineEdit will by default handle the text rotation and completion events internally when a completion object is created through either one of the methods mentioned above. If you do not need this functionality, simply use KCompletionBase::setHandleSignals(bool)
or set the boolean parameter in the above functions to false.
The default key-bindings for completion and rotation is determined from the global settings in KStandardShortcut. These values, however, can be overridden locally by invoking KCompletionBase::setKeyBinding()
. The values can easily be reverted back to the default setting, by simply calling useGlobalSettings()
. An alternate method would be to default individual key-bindings by using setKeyBinding() with the default second argument.
If EchoMode
for this widget is set to something other than QLineEdit::Normal
, the completion mode will always be defaulted to CompletionNone. This is done purposefully to guard against protected entries, such as passwords, being cached in KCompletion's list. Hence, if the EchoMode
is not QLineEdit::Normal
, the completion mode is automatically disabled.
A read-only KLineEdit will have the same background color as a disabled KLineEdit, but its foreground color will be the one used for the read-write mode. This differs from QLineEdit's implementation and is done to give visual distinction between the three different modes: disabled, read-only, and read-write.
Usage
To enable the basic completion feature:
To use a customized completion object or your own completion object:
Note if you specify your own completion object you have to either delete it when you don't need it anymore, or you can tell KLineEdit to delete it for you:
Miscellaneous function calls :
Definition at line 138 of file klineedit.h.
Property Documentation
◆ squeezedTextEnabled
|
readwrite |
Definition at line 146 of file klineedit.h.
◆ trapEnterKeyEvent
|
readwrite |
Definition at line 145 of file klineedit.h.
Constructor & Destructor Documentation
◆ KLineEdit() [1/2]
Constructs a KLineEdit object with a default text, a parent, and a name.
- Parameters
-
string Text to be shown in the edit widget. parent The parent widget of the line edit.
Definition at line 128 of file klineedit.cpp.
◆ KLineEdit() [2/2]
Constructs a line edit.
- Parameters
-
parent The parent widget of the line edit.
Definition at line 136 of file klineedit.cpp.
◆ ~KLineEdit()
|
override |
Destructor.
Definition at line 144 of file klineedit.cpp.
Member Function Documentation
◆ aboutToShowContextMenu
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.
NOTE: Do not store the pointer to the QMenu provided through since it is created and deleted on demand.
- Parameters
-
contextMenu the context menu about to be displayed
◆ autoSuggest()
|
protected |
Whether in current state text should be auto-suggested.
Definition at line 1366 of file klineedit.cpp.
◆ clearButtonClicked
|
signal |
Emitted when the user clicked on the clear button.
◆ clearButtonUsedSize()
QSize KLineEdit::clearButtonUsedSize | ( | ) | const |
◆ completion
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.
◆ completionBox()
|
virtual |
This method will create a completion-box if none is there, yet.
- Parameters
-
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.
Definition at line 1274 of file klineedit.cpp.
◆ completionBoxActivated
Emitted whenever the completion box is activated.
◆ completionModeChanged
|
signal |
Emitted when the user changed the completion mode by using the popupmenu.
◆ contextMenuEvent()
|
overrideprotectedvirtual |
Reimplemented for internal reasons.
API not affected.
See QLineEdit::contextMenuEvent().
Reimplemented from QLineEdit.
Definition at line 974 of file klineedit.cpp.
◆ copy()
|
virtual |
Reimplemented for internal reasons, the API is not affected.
Definition at line 416 of file klineedit.cpp.
◆ createStandardContextMenu()
|
protected |
Reimplemented for internal reasons.
API not affected.
See QLineEdit::createStandardContextMenu().
Definition at line 882 of file klineedit.cpp.
◆ doCompletion()
Do completion now.
This is called automatically when typing a key for instance. Emits completion() and/or calls makeCompletion(), depending on emitSignals and handleSignals.
- Since
- 4.2.1
Definition at line 1399 of file klineedit.cpp.
◆ event()
|
overrideprotectedvirtual |
Reimplemented for internal reasons.
API not affected.
Reimplemented from QLineEdit.
Definition at line 1023 of file klineedit.cpp.
◆ isSqueezedTextEnabled()
bool KLineEdit::isSqueezedTextEnabled | ( | ) | const |
Returns true if text squeezing is enabled.
This is only valid when the widget is in read-only mode.
Definition at line 330 of file klineedit.cpp.
◆ keyPressEvent()
Reimplemented for internal reasons.
API not affected.
See QLineEdit::keyPressEvent().
Reimplemented from QLineEdit.
Definition at line 465 of file klineedit.cpp.
◆ makeCompletion
Completes the remaining text with a matching one from a given list.
Definition at line 253 of file klineedit.cpp.
◆ mouseDoubleClickEvent()
|
overrideprotectedvirtual |
Reimplemented for internal reasons.
API not affected.
See QWidget::mouseDoubleClickEvent().
Reimplemented from QLineEdit.
Definition at line 830 of file klineedit.cpp.
◆ mousePressEvent()
|
overrideprotectedvirtual |
Reimplemented for internal reasons.
API not affected.
See QLineEdit::mousePressEvent().
Reimplemented from QLineEdit.
Definition at line 842 of file klineedit.cpp.
◆ mouseReleaseEvent()
|
overrideprotectedvirtual |
Reimplemented for internal reasons.
API not affected.
See QLineEdit::mouseReleaseEvent().
Reimplemented from QLineEdit.
Definition at line 864 of file klineedit.cpp.
◆ originalText()
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
Definition at line 1350 of file klineedit.cpp.
◆ paintEvent()
|
overrideprotectedvirtual |
Reimplemented from QLineEdit.
Definition at line 1372 of file klineedit.cpp.
◆ resizeEvent()
|
overrideprotectedvirtual |
Reimplemented for internal reasons.
API not affected.
Reimplemented from QWidget.
Definition at line 455 of file klineedit.cpp.
◆ returnKeyPressed
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.
- Since
- 5.81
◆ rotateText
|
slot |
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.
- Parameters
-
type The key-binding invoked.
Definition at line 231 of file klineedit.cpp.
◆ setCompletedItems
|
overrideslot |
Same as the above function except it allows you to temporarily turn off text completion in CompletionPopupAuto mode.
- Parameters
-
items list of completion matches to be shown in the completion box. autoSuggest true if you want automatic text completion (suggestion) enabled.
Definition at line 1216 of file klineedit.cpp.
◆ setCompletedText [1/2]
See KCompletionBase::setCompletedText.
Definition at line 221 of file klineedit.cpp.
◆ setCompletedText() [2/2]
This function simply sets the lineedit text and highlights the text appropriately if the boolean value is set to true.
- Parameters
-
text marked
Definition at line 201 of file klineedit.cpp.
◆ setCompletionBox()
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.
- Parameters
-
box The KCompletionBox to set
Definition at line 1076 of file klineedit.cpp.
◆ setCompletionMode()
|
overridevirtual |
Reimplemented from KCompletionBase for internal reasons.
This function is re-implemented in order to make sure that the EchoMode is acceptable before we set the completion mode.
See KCompletionBase::setCompletionMode
Reimplemented from KCompletionBase.
Definition at line 165 of file klineedit.cpp.
◆ setCompletionModeDisabled()
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.
Definition at line 195 of file klineedit.cpp.
◆ setCompletionObject()
|
overridevirtual |
Reimplemented for internal reasons, the API is not affected.
Reimplemented from KCompletionBase.
Definition at line 1286 of file klineedit.cpp.
◆ setReadOnly
|
virtualslot |
Sets the lineedit to read-only.
Similar to QLineEdit::setReadOnly but also takes care of the background color, and the clear button.
Definition at line 291 of file klineedit.cpp.
◆ setSqueezedText
Squeezes text
into the line edit.
This can only be used with read-only line-edits.
Definition at line 318 of file klineedit.cpp.
◆ setSqueezedTextEnabled()
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
- QLineEdit
Definition at line 324 of file klineedit.cpp.
◆ setText
Reimplemented to enable text squeezing.
API is not affected.
Definition at line 336 of file klineedit.cpp.
◆ setTrapReturnKey()
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()
Definition at line 1059 of file klineedit.cpp.
◆ setUrl()
Sets url
into the lineedit.
It uses QUrl::toDisplayString() so that the url is properly decoded for displaying.
Definition at line 1071 of file klineedit.cpp.
◆ setUrlDropsEnabled()
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.
- Parameters
-
enable If true
, insert decoded URLs
◆ setUserSelection()
|
protected |
Sets the widget in userSelection mode or in automatic completion selection mode.
This changes the colors of selections.
Definition at line 1304 of file klineedit.cpp.
◆ substringCompletion
Emitted when the shortcut for substring completion is pressed.
◆ textRotation
|
signal |
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.
◆ trapReturnKey()
bool KLineEdit::trapReturnKey | ( | ) | const |
- Returns
true
if keyevents ofKey_Return
orKey_Enter
will be stopped or if they will be propagated.
- See also
- setTrapReturnKey ()
Definition at line 1065 of file klineedit.cpp.
◆ urlDropsEnabled()
bool KLineEdit::urlDropsEnabled | ( | ) | const |
Returns true
when decoded URL drops are enabled.
Definition at line 1053 of file klineedit.cpp.
◆ userCancelled
Resets the current displayed text.
Call this function to revert a text completion if the user cancels the request. Mostly applies to popup completions.
Definition at line 1111 of file klineedit.cpp.
◆ userText()
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().
- Since
- 4.2.2
Definition at line 1360 of file klineedit.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:16:24 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.