KLineEdit Class Reference
#include <klineedit.h>
Inheritance diagram for KLineEdit:

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 and 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 new features KLineEdit also emits a few more additional signals. These are: completion( const QString& ), textRotation( KeyBindingType ), and returnPressed( const QString& ). The completion signal can be connected to a slot that will assist the user in filling out the remaining text. The text rotation 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 text. The returnPressed( const QString& )
signals are the same as QLineEdit's except it provides the current text in the widget as its argument whenever appropriate.
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 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 KStdAccel. These values, however, can be overridden locally by invoking setKeyBinding()
. You can easily revert these settings back to the default 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 KGlobalSettings::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 :
KLineEdit *edit = new KLineEdit( this, "mywidget" ); KCompletion *comp = edit->completionObject(); // Connect to the return pressed signal - optional connect(edit,SIGNAL(returnPressed(const QString&)),comp,SLOT(addItem(const QString&)));
To use a customized completion objects or your own completion object :
KLineEdit *edit = new KLineEdit( this,"mywidget" ); KURLCompletion *comp = new KURLCompletion(); edit->setCompletionObject( comp ); // Connect to the return pressed signal - optional connect(edit,SIGNAL(returnPressed(const QString&)),comp,SLOT(addItem(const QString&)));
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:
edit->setAutoDeleteCompletionObject( true );
Miscellaneous function calls :
// 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->setContextMenuEnabled( false ); // Temporarily disable signal (both completion & iteration) emitions edit->disableSignals(); // Default the key-bindings back to the default system settings. edit->useGlobalKeyBindings();
- Author:
- Dawit Alemayehu <adawit@kde.org>
Definition at line 145 of file klineedit.h.
Public Slots | |
virtual void | setReadOnly (bool) |
void | rotateText (KCompletionBase::KeyBindingType type) |
virtual void | setCompletedText (const QString &) |
void | setCompletedItems (const QStringList &items) |
void | setCompletedItems (const QStringList &items, bool autoSuggest) |
virtual void | clear () |
void | setSqueezedText (const QString &text) |
virtual void | setText (const QString &) |
Signals | |
void | completionBoxActivated (const QString &) |
void | returnPressed (const QString &) |
void | completion (const QString &) |
void | substringCompletion (const QString &) |
void | textRotation (KCompletionBase::KeyBindingType) |
void | completionModeChanged (KGlobalSettings::Completion) |
void | aboutToShowContextMenu (QPopupMenu *p) |
Public Member Functions | |
KLineEdit (const QString &string, QWidget *parent, const char *name=0) | |
KLineEdit (QWidget *parent=0, const char *name=0) | |
virtual | ~KLineEdit () |
void | setURL (const KURL &url) |
void | cursorAtEnd () |
virtual void | setCompletionMode (KGlobalSettings::Completion mode) |
virtual void | setContextMenuEnabled (bool showMenu) |
bool | isContextMenuEnabled () const |
void | setURLDropsEnabled (bool enable) |
bool | isURLDropsEnabled () const |
void | setTrapReturnKey (bool trap) |
bool | trapReturnKey () const |
virtual bool | eventFilter (QObject *, QEvent *) |
KCompletionBox * | completionBox (bool create=true) |
virtual void | setCompletionObject (KCompletion *, bool hsig=true) |
virtual void | copy () const |
void | setEnableSqueezedText (bool enable) |
bool | isSqueezedTextEnabled () const |
QString | originalText () const |
void | setCompletionBox (KCompletionBox *box) |
Protected Slots | |
virtual void | makeCompletion (const QString &) |
void | slotAboutToShow () |
void | slotCancelled () |
void | userCancelled (const QString &cancelText) |
Protected Member Functions | |
virtual void | resizeEvent (QResizeEvent *) |
virtual void | keyPressEvent (QKeyEvent *) |
virtual void | mousePressEvent (QMouseEvent *) |
virtual void | mouseDoubleClickEvent (QMouseEvent *) |
virtual void | contextMenuEvent (QContextMenuEvent *) |
virtual QPopupMenu * | createPopupMenu () |
virtual void | dropEvent (QDropEvent *) |
virtual void | setCompletedText (const QString &, bool) |
void | setUserSelection (bool userSelection) |
virtual void | create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true) |
virtual void | focusInEvent (QFocusEvent *) |
bool | autoSuggest () const |
virtual void | virtual_hook (int id, void *data) |
Properties | |
bool | contextMenuEnabled |
bool | urlDropsEnabled |
bool | trapEnterKeyEvent |
bool | enableSqueezedText |
Friends | |
class | KComboBox |
Constructor & Destructor Documentation
|
Constructs a KLineEdit object with a default text, a parent, and a name.
Definition at line 102 of file klineedit.cpp. |
|
Constructs a KLineEdit object with a parent and a name.
Definition at line 108 of file klineedit.cpp. |
|
Destructor.
Definition at line 114 of file klineedit.cpp. |
Member Function Documentation
|
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 QPopupMenu provided through since it is created and deleted on demand.
|
|
Whether in current state text should be auto-suggested.
Definition at line 1308 of file klineedit.cpp. |
|
Reimplemented to workaround a buggy QLineEdit::clear() (changing the clipboard to the text we just had in the lineedit).
Reimplemented from QLineEdit. Reimplemented in KIconViewSearchLine. Definition at line 1280 of file klineedit.cpp. |
|
Emitted when the completion key is pressed.
Please note that this signal is not emitted if the completion mode is set to |
|
Definition at line 1220 of file klineedit.cpp. |
|
Emitted whenever the completion box is activated.
|
|
Emitted when the user changed the completion mode by using the popupmenu.
|
|
Re-implemented for internal reasons. API not affected. See QLineEdit::contextMenuEvent(). Definition at line 831 of file klineedit.cpp. |
|
Reimplemented for internal reasons, the API is not affected.
Definition at line 388 of file klineedit.cpp. |
|
Reimplemented for internal reasons, the API is not affected.
Definition at line 1245 of file klineedit.cpp. |
|
Re-implemented for internal reasons. API not affected. See QLineEdit::createPopupMenu(). Reimplemented from QLineEdit. Reimplemented in KListViewSearchLine. Definition at line 837 of file klineedit.cpp. |
|
Puts the text cursor at the end of the string. This method is deprecated. Use QLineEdit::end() instead.
Definition at line 195 of file klineedit.h. |
|
Re-implemented to handle URI drops. See QLineEdit::dropEvent(). Definition at line 942 of file klineedit.cpp. |
|
Re-implemented for internal reasons. API not affected. Definition at line 965 of file klineedit.cpp. |
|
Re-implemented for internal reasons. API not affected. See QLineEdit::focusInEvent(). Definition at line 1299 of file klineedit.cpp. |
|
Returns
Definition at line 226 of file klineedit.h. |
|
Returns true if text squeezing is enabled. This is only valid when the widget is in read-only mode.
Definition at line 299 of file klineedit.cpp. |
|
Returns
Definition at line 1021 of file klineedit.cpp. |
|
Re-implemented for internal reasons. API not affected. See QLineEdit::keyPressEvent(). Reimplemented from QLineEdit. Reimplemented in KListViewLineEdit, and KRestrictedLine. Definition at line 426 of file klineedit.cpp. |
|
Completes the remaining text with a matching one from a given list.
Definition at line 220 of file klineedit.cpp. |
|
Re-implemented for internal reasons. API not affected. See QWidget::mouseDoubleClickEvent(). Definition at line 804 of file klineedit.cpp. |
|
Re-implemented for internal reasons. API not affected. See QLineEdit::mousePressEvent(). Definition at line 815 of file klineedit.cpp. |
|
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().
Definition at line 1291 of file klineedit.cpp. |
|
Re-implemented for internal reasons. API not affected. See QLineEdit::resizeEvent(). Definition at line 418 of file klineedit.cpp. |
|
Emitted when the user presses the return key.
The argument is the current text. Note that this signal is not emitted if the widget's |
|
Iterates through all possible matches of the completed text or the history list. This function simply iterates over all possible matches in case multimple matches are found as a result of a text completion request. It will have no effect if only a single match is found.
Definition at line 199 of file klineedit.cpp. |
|
Same as the above function except it allows you to temporarily turn off text completion in CompletionPopupAuto mode. TODO: Merge with above function in KDE 4. TODO: Does that make this or the above
Definition at line 1158 of file klineedit.cpp. |
|
Sets The popup will be shown immediately.
Implements KCompletionBase. Definition at line 1153 of file klineedit.cpp. |
|
See KCompletionBase::setCompletedText.
Implements KCompletionBase. Definition at line 189 of file klineedit.cpp. |
|
Set the completion-box to be used in completion mode KGlobalSettings::CompletionPopup. This will do nothing if a completion-box already exists.
Definition at line 1041 of file klineedit.cpp. |
|
Re-implemented 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 144 of file klineedit.cpp. |
|
Reimplemented for internal reasons, the API is not affected.
Reimplemented from KCompletionBase. Definition at line 1230 of file klineedit.cpp. |
|
Enables/disables the popup (context) menu.
Note that when this function is invoked with its argument set to
Definition at line 221 of file klineedit.h. |
|
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.
Definition at line 294 of file klineedit.cpp. |
|
Re-implemented for internal reasons. API not changed. Reimplemented from QLineEdit. Definition at line 259 of file klineedit.cpp. |
|
Squeezes This can only be used with read-only line-edits.
Definition at line 288 of file klineedit.cpp. |
|
Re-implemented to enable text squeezing. API is not affected. Reimplemented from QLineEdit. Definition at line 304 of file klineedit.cpp. |
|
By default, KLineEdit recognizes
Call this method with
Definition at line 1026 of file klineedit.cpp. |
|
Sets It uses KURL::prettyURL() so that the url is properly decoded for displaying. Definition at line 1036 of file klineedit.cpp. |
|
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.
Definition at line 1016 of file klineedit.cpp. |
|
Sets the widget in userSelection mode or in automatic completion selection mode. This changes the colors of selections. Definition at line 1251 of file klineedit.cpp. |
|
Will be removed in the next major release! Definition at line 468 of file klineedit.h. |
|
Will be removed in the next major release! Definition at line 473 of file klineedit.h. |
|
Emitted when the shortcut for substring completion is pressed.
|
|
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
Note that this signal is not emitted if the completion mode is set to |
|
Definition at line 1031 of file klineedit.cpp. |
|
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 1060 of file klineedit.cpp. |
The documentation for this class was generated from the following files: