KLineEdit Class Reference
An enhanced QLineEdit widget for inputting text. An enhanced single line input widget. More...
#include <klineedit.h>
Inheritance diagram for KLineEdit:

Public Slots | |
virtual void | setReadOnly (bool) |
Re-implemented for internal reasons. | |
void | rotateText (KCompletionBase::KeyBindingType) |
Iterates through all possible matches of the completed text or the history list. | |
virtual void | setCompletedText (const QString &) |
See KCompletionBase::setCompletedText. | |
void | setCompletedItems (const QStringList &items) |
Sets items into the completion-box if completionMode() is CompletionPopup. | |
virtual void | clear () |
Reimplemented to workaround a buggy QLineEdit::clear() (changing the clipboard to the text we just had in the lineedit). | |
void | setSqueezedText (const QString &text) |
Squeezes text into the line edit. | |
Signals | |
void | completionBoxActivated (const QString &) |
Emitted whenever the completion box is activated. | |
void | returnPressed (const QString &) |
Emitted when the user presses the return key. | |
void | completion (const QString &) |
Emitted when the completion key is pressed. | |
void | substringCompletion (const QString &) |
Emitted when the shortcut for substring completion is pressed. | |
void | textRotation (KCompletionBase::KeyBindingType) |
Emitted when the text rotation key-bindings are pressed. | |
void | completionModeChanged (KGlobalSettings::Completion) |
Emitted when the user changed the completion mode by using the popupmenu. | |
void | aboutToShowContextMenu (QPopupMenu *) |
Emitted before the context menu is displayed. | |
Public Methods | |
KLineEdit (const QString &string, QWidget *parent, const char *name=0) | |
Constructs a KLineEdit object with a default text, a parent, and a name. | |
KLineEdit (QWidget *parent=0, const char *name=0) | |
Constructs a KLineEdit object with a parent and a name. | |
virtual | ~KLineEdit () |
Destructor. | |
void | setURL (const KURL &url) |
Sets url into the lineedit. | |
void | cursorAtEnd () |
Puts the text cursor at the end of the string. | |
virtual void | setCompletionMode (KGlobalSettings::Completion mode) |
Re-implemented from KCompletionBase for internal reasons. | |
virtual void | setContextMenuEnabled (bool showMenu) |
Enables/disables the popup (context) menu. | |
bool | isContextMenuEnabled () const |
Returns true when the context menu is enabled. | |
void | setURLDropsEnabled (bool enable) |
Enables/Disables handling of URL drops. | |
bool | isURLDropsEnabled () const |
Returns true when decoded URL drops are enabled. | |
void | 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. | |
bool | trapReturnKey () const |
virtual bool | eventFilter (QObject *, QEvent *) |
Re-implemented for internal reasons. | |
KCompletionBox * | completionBox (bool create=true) |
virtual void | setCompletionObject (KCompletion *, bool hsig=true) |
Reimplemented for internal reasons, the API is not affected. | |
virtual void | copy () const |
Reimplemented for internal reasons, the API is not affected. | |
Protected Slots | |
virtual void | makeCompletion (const QString &) |
Completes the remaining text with a matching one from a given list. | |
void | slotAboutToShow () |
void | slotCancelled () |
Protected Methods | |
virtual void | resizeEvent (QResizeEvent *) |
Re-implemented for internal reasons. | |
virtual void | keyPressEvent (QKeyEvent *) |
Re-implemented for internal reasons. | |
virtual void | mousePressEvent (QMouseEvent *) |
Re-implemented for internal reasons. | |
virtual void | mouseDoubleClickEvent (QMouseEvent *) |
Re-implemented for internal reasons. | |
virtual QPopupMenu * | createPopupMenu () |
Re-implemented for internal reasons. | |
virtual void | dropEvent (QDropEvent *) |
Re-implemented to handle URI drops. | |
virtual void | create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true) |
Reimplemented for internal reasons, the API is not affected. |
Detailed Description
An enhanced QLineEdit widget for inputting text. An enhanced single line input widget.
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 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 KStdAccel. These values, however, can be overriden 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 usning setKeyBinding() with the default second argument.
NOTE that if the 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.
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 that you have to either delete the allocated completion object when you don't need it anymore, or call setAutoDeleteCompletionObject( true );
Miscellaneous function calls :
// Tell the widget not to handle completion and // iteration internally. edit->setHandleSignals( false ); // Set your own completion key for manual completions. edit->setKeyBinding( KCompletionBase::TextCompletion, Qt::End ); // Hide the context (popup) menu edit->setContextMenuEnabled( false ); // Temporarly disable signal emitions // (both completion & iteration signals) edit->disableSignals(); // Default the key-bindings to system settings. edit->useGlobalKeyBindings();
- Author:
- Dawit Alemayehu <adawit@kde.org>
Definition at line 136 of file klineedit.h.
Constructor & Destructor Documentation
|
Constructs a KLineEdit object with a default text, a parent, and a name.
Definition at line 69 of file klineedit.cpp. |
|
Constructs a KLineEdit object with a parent and a name.
Definition at line 75 of file klineedit.cpp. |
|
Destructor.
Definition at line 81 of file klineedit.cpp. |
Member Function Documentation
|
Sets It uses KURL::prettyURL() so that the url is properly decoded for displaying. Definition at line 733 of file klineedit.cpp. References KURL::prettyURL(), and QLineEdit::setText(). |
|
Puts the text cursor at the end of the string. This method is deprecated. Use QLineEdit::end() instead.
Definition at line 185 of file klineedit.h. References QLineEdit::end(). |
|
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 98 of file klineedit.cpp. References KGlobalSettings::Completion, KCompletionBase::completionMode(), KGlobalSettings::CompletionNone, KGlobalSettings::CompletionPopup, QLineEdit::echoMode(), and KCompletionBase::setCompletionMode(). |
|
Enables/disables the popup (context) menu.
Note that when this function is invoked with its argument set to
Definition at line 211 of file klineedit.h. |
|
Returns
Definition at line 216 of file klineedit.h. |
|
Enables/Disables handling of URL drops. If enabled and the user drops an URL, the decoded URL will be inserted. Otherwise the default behaviour of QLineEdit is used, which inserts the encoded URL.
Definition at line 713 of file klineedit.cpp. |
|
Returns
Definition at line 718 of file klineedit.cpp. |
|
By default, KLineEdit recognizes
Call this method with
Definition at line 723 of file klineedit.cpp. |
|
Definition at line 728 of file klineedit.cpp. |
|
Re-implemented for internal reasons. API not affected. Definition at line 671 of file klineedit.cpp. References QKeyEvent::accept(), KCursor::autoHideEventFilter(), QLineEdit::displayText(), QKeyEvent::key(), QLineEdit::returnPressed(), QKeyEvent::state(), and QEvent::type(). |
|
Definition at line 830 of file klineedit.cpp. |
|
Reimplemented for internal reasons, the API is not affected.
Reimplemented from KCompletionBase. Definition at line 838 of file klineedit.cpp. References KCompletionBase::compObj(), KCompletionBase::handleSignals(), setCompletedItems(), and KCompletionBase::setCompletionObject(). |
|
Reimplemented for internal reasons, the API is not affected.
Definition at line 221 of file klineedit.cpp. References QApplication::clipboard(), QLineEdit::copy(), QLineEdit::end(), QLineEdit::getSelection(), QString::mid(), and QLineEdit::selectionChanged(). Referenced by keyPressEvent(). |
|
Emitted whenever the completion box is activated.
|
|
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 |
|
Emitted when the completion key is pressed.
Please note that this signal is not emitted if the completion mode is set to Referenced by keyPressEvent(). |
|
Emitted when the shortcut for substring completion is pressed.
Referenced by keyPressEvent(). |
|
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 Referenced by keyPressEvent(). |
|
Emitted when the user changed the completion mode by using the popupmenu.
|
|
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.
Referenced by createPopupMenu(). |
|
Re-implemented for internal reasons. API not changed. Reimplemented from QLineEdit. Definition at line 178 of file klineedit.cpp. References QLineEdit::isReadOnly(), QLineEdit::setReadOnly(), and QLineEdit::setText(). |
|
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 132 of file klineedit.cpp. References KCompletionBase::compObj(), QLineEdit::displayText(), QLineEdit::hasSelectedText(), QString::isNull(), KCompletionBase::KeyBindingType, KCompletionBase::NextCompletionMatch, KCompletion::nextMatch(), KCompletionBase::PrevCompletionMatch, KCompletion::previousMatch(), and setCompletedText(). Referenced by keyPressEvent(). |
|
See KCompletionBase::setCompletedText.
Implements KCompletionBase. Definition at line 123 of file klineedit.cpp. References KGlobalSettings::Completion, KGlobalSettings::CompletionAuto, KGlobalSettings::CompletionMan, KCompletionBase::completionMode(), and KGlobalSettings::CompletionPopup. Referenced by makeCompletion(), and rotateText(). |
|
Sets The popup will be shown immediately. Implements KCompletionBase. Definition at line 809 of file klineedit.cpp. References QString::isEmpty(), and QLineEdit::text(). Referenced by keyPressEvent(), makeCompletion(), and setCompletionObject(). |
|
Reimplemented to workaround a buggy QLineEdit::clear() (changing the clipboard to the text we just had in the lineedit).
Reimplemented from QLineEdit. Definition at line 859 of file klineedit.cpp. References QLineEdit::setText(). Referenced by KEditListBox::clear(). |
|
Squeezes This can only be used with read-only line-edits.
Definition at line 202 of file klineedit.cpp. References QLineEdit::isReadOnly(), resizeEvent(), and QLineEdit::setText(). |
|
Completes the remaining text with a matching one from a given list.
Definition at line 147 of file klineedit.cpp. References KCompletion::allMatches(), KGlobalSettings::Completion, KCompletionBase::completionMode(), KGlobalSettings::CompletionPopup, KCompletionBase::compObj(), QString::isNull(), KCompletion::makeCompletion(), setCompletedItems(), and setCompletedText(). Referenced by keyPressEvent(). |
|
Definition at line 397 of file klineedit.h. |
|
Definition at line 402 of file klineedit.h. |
|
Re-implemented for internal reasons. API not affected. See QLineEdit::resizeEvent(). Definition at line 252 of file klineedit.cpp. References QToolTip::add(), QToolTip::hide(), QString::left(), QString::length(), QToolTip::remove(), QString::right(), QLineEdit::setCursorPosition(), QLineEdit::setText(), and QFontMetrics::width(). Referenced by setSqueezedText(). |
|
|
Re-implemented for internal reasons. API not affected. See QLineEdit::mousePressEvent(). Definition at line 541 of file klineedit.cpp. References QMouseEvent::button(), and QLineEdit::selectAll(). |
|
Re-implemented for internal reasons. API not affected. See QWidget::mouseDoubleClickEvent(). Definition at line 530 of file klineedit.cpp. References QMouseEvent::button(), QApplication::doubleClickInterval(), and QTimer::singleShot(). |
|
Re-implemented for internal reasons. API not affected. See QLineEdit::createPopupMenu(). Reimplemented from QLineEdit. Definition at line 556 of file klineedit.cpp. References aboutToShowContextMenu(), KGlobalSettings::Completion, KGlobalSettings::CompletionAuto, KGlobalSettings::CompletionMan, KGlobalSettings::completionMode(), KCompletionBase::completionMode(), KGlobalSettings::CompletionNone, KGlobalSettings::CompletionPopup, KGlobalSettings::CompletionShell, KCompletionBase::compObj(), QLineEdit::createPopupMenu(), QPopupMenu::insertItem(), QPopupMenu::insertSeparator(), QLineEdit::isReadOnly(), QPopupMenu::setAccel(), and QPopupMenu::setItemChecked(). |
|
Re-implemented to handle URI drops. See QLineEdit::dropEvent(). Definition at line 648 of file klineedit.cpp. References QDropEvent::accept(), KURLDrag::decode(), QString::isEmpty(), QString::length(), QLineEdit::text(), and QLineEdit::validateAndSet(). |
|
Reimplemented for internal reasons, the API is not affected.
Definition at line 853 of file klineedit.cpp. References KCursor::setAutoHideCursor(). |
The documentation for this class was generated from the following files: