# class KLineEdit

###

Module | kdeui
Namespace |
Class | KLineEdit
Inherits | QLineEdit,KCompletionBase

An enhanced QLineEdit widget for inputting text.

Detail \n

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 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 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.

KLineEdit has also a password mode which depends of globals KDE settings. Use KLineEdit.setPasswordMode instead of QLineEdit.echoMode property to have a password field.

Usage \n

To enable the basic completion feature:

    KLineEdit *edit = new KLineEdit( this );
    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 );
    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 :\n

    // 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();

Author Dawit Alemayehu <adawit@kde.org>

### methods

- KLineEdit (string, parent)

  returns ctor
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  string | QString |
  parent | QWidget | 0

  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.

- KLineEdit (parent)

  returns ctor
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  parent | QWidget | 0

  Constructs a line edit

  parent - The parent widget of the line edit.

- KLineEdit (a0, a1)

  returns ctor
  before KDE 4.1.0 only

  Argument | Type | Default
  --- | --- | ---
  a0 | QString |
  a1 | QWidget | 0

- KLineEdit (a0)

  returns ctor
  before KDE 4.1.0 only

  Argument | Type | Default
  --- | --- | ---
  a0 | QWidget | 0

- aboutToShowContextMenu (p)

  returns Nothing
  SIGNAL ("aboutToShowContextMenu (QMenu*)")

  Argument | Type | Default
  --- | --- | ---
  p | QMenu |

  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.

  p - the context menu about to be displayed

- autoSuggest ( )

  returns bool

  Whether in current state text should be auto-suggested

- clear ( )

  returns Nothing

  Reimplemented to workaround a buggy QLineEdit.clear() (changing the clipboard to the text we just had in the lineedit)

- clearButtonClicked ( )

  returns Nothing
  SIGNAL ("clearButtonClicked ()")

  Emitted when the user clicked on the clear button

- clickMessage ( )

  returns QString

  Returns the message set with setClickMessage

- completion (a0)

  returns Nothing
  SIGNAL ("completion (const QString&)")

  Argument | Type | Default
  --- | --- | ---
  a0 | 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.

- completionBox (create)

  returns KCompletionBox

  Argument | Type | Default
  --- | --- | ---
  create | bool | 1

  Returns the completion-box, that is used in completion mode KGlobalSettings.CompletionPopup. 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.

- completionBoxActivated (a0)

  returns Nothing
  SIGNAL ("completionBoxActivated (const QString&)")

  Argument | Type | Default
  --- | --- | ---
  a0 | QString |

  Emitted whenever the completion box is activated.

- completionModeChanged (a0)

  returns Nothing
  SIGNAL ("completionModeChanged (Completion)")

  Argument | Type | Default
  --- | --- | ---
  a0 | KGlobalSettings.Completion |

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

- contextMenuEvent (a0)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  a0 | QContextMenuEvent |

  Re-implemented for internal reasons. API not affected.

  See QLineEdit.contextMenuEvent().

- copy ( )

  returns Nothing

  Reimplemented for internal reasons, the API is not affected.

- create (a0, initializeWindow, destroyOldWindow)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  a0 | WId | 0
  initializeWindow | bool | 1
  destroyOldWindow | bool | 1

  Reimplemented for internal reasons, the API is not affected.

- createStandardContextMenu ( )

  returns QMenu

  Re-implemented for internal reasons. API not affected.

  See QLineEdit.createStandardContextMenu().

- dropEvent (a0)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  a0 | QDropEvent |

  Re-implemented to handle URI drops.

  See QLineEdit.dropEvent().

- event (a0)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  a0 | QEvent |

  Re-implemented for internal reasons. API not affected.

- focusInEvent (ev)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  ev | QFocusEvent |

- focusOutEvent (ev)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  ev | QFocusEvent |

- isClearButtonShown ( )

  returns bool

  Returns whether or not the clear button is shown

- isContextMenuEnabled ( )

  returns bool

  Returns true when the context menu is enabled. Deprecated use contextMenuPolicy

- isSqueezedTextEnabled ( )

  returns bool

  Returns true if text squeezing is enabled. This is only valid when the widget is in read-only mode.

- keyPressEvent (a0)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  a0 | QKeyEvent |

  Re-implemented for internal reasons. API not affected.

  See QLineEdit.keyPressEvent().

- makeCompletion (a0)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  a0 | QString |

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

- mouseDoubleClickEvent (a0)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  a0 | QMouseEvent |

  Re-implemented for internal reasons. API not affected.

  See QWidget.mouseDoubleClickEvent().

- mousePressEvent (a0)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  a0 | QMouseEvent |

  Re-implemented for internal reasons. API not affected.

  See QLineEdit.mousePressEvent().

- mouseReleaseEvent (a0)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  a0 | QMouseEvent |

  Re-implemented for internal reasons. API not affected.

  See QLineEdit.mouseReleaseEvent().

- originalText ( )

  returns QString

  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

- paintEvent (ev)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  ev | QPaintEvent |

- passwordMode ( )

  returns bool

  Returns returns true if the lineedit is set to password mode echoing

- resizeEvent (a0)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  a0 | QResizeEvent |

  Re-implemented for internal reasons. API not affected.

  See QLineEdit.resizeEvent().

- returnPressed (a0)

  returns Nothing
  SIGNAL ("returnPressed (const QString&)")

  Argument | Type | Default
  --- | --- | ---
  a0 | QString |

  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 EchoMode is set to QLineEdit.EchoMode.

- rotateText (type)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  type | KCompletionBase.KeyBindingType |

  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.

  type - The key-binding invoked.

- setClearButtonShown (show)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  show | bool |

  This makes the line edit display an icon on one side of the line edit which, when clicked, clears the contents of the line edit. This is useful for such things as location or search bars.

- setClickMessage (msg)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  msg | QString |

  This makes the line edit display a grayed-out hinting text as long as the user didn't enter any text. It is often used as indication about the purpose of the line edit.

- setCompletedItems (items, autoSuggest)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  items | QStringList |
  autoSuggest | bool | 1

  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.

- setCompletedText (a0)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  a0 | QString |

  See KCompletionBase.setCompletedText.

- setCompletedText (a0, a1)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  a0 | QString |
  a1 | bool |

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

  text -

  marked -

- setCompletionBox (box)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  box | KCompletionBox |

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

  box - The KCompletionBox to set

- setCompletionMode (mode)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  mode | KGlobalSettings.Completion |

  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

- setCompletionModeDisabled (mode, disable)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  mode | KGlobalSettings.Completion |
  disable | bool | 1

  Disables completion modes by makeing them non-checkable.

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

- setCompletionObject (a0, hsig)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  a0 | KCompletion |
  hsig | bool | 1

  Reimplemented for internal reasons, the API is not affected.

- setContextMenuEnabled (showMenu)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  showMenu | bool |

  Enables/disables the popup (context) menu.

  Note that when this function is invoked with its argument set to true, then both the context menu and the completion menu item are enabled. If you do not want to the completion item to be visible simply invoke hideModechanger() right after calling this method. Also by default, the context menu is automatically created if this widget is editable. Thus you need to call this function with the argument set to false if you do not want this behavior.

  showMenu - If true, show the context menu. Deprecated use setContextMenuPolicy

- setPasswordMode (b)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  b | bool | 1

  set the line edit in password mode. this change the EchoMode according to KDE preferences.

  b - true to set in password mode

- setReadOnly (a0)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  a0 | bool |

  Re-implemented for internal reasons. API not changed.

- setSqueezedText (text)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  text | QString |

  Squeezes text into the line edit. This can only be used with read-only line-edits.

- setSqueezedTextEnabled (enable)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  enable | bool |

  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

- setText (a0)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  a0 | QString |

  Re-implemented to enable text squeezing. API is not affected.

- setTrapReturnKey (trap)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  trap | bool |

  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()

- setUrl (url)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |

  Sets url into the lineedit. It uses KUrl.prettyUrl() so that the url is properly decoded for displaying.

- setUrlDropsEnabled (enable)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  enable | bool |

  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.

  enable - If true, insert decoded URLs

- setUserSelection (userSelection)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  userSelection | bool |

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

- substringCompletion (a0)

  returns Nothing
  SIGNAL ("substringCompletion (const QString&)")

  Argument | Type | Default
  --- | --- | ---
  a0 | QString |

  Emitted when the shortcut for substring completion is pressed.

- textRotation (a0)

  returns Nothing
  SIGNAL ("textRotation (KeyBindingType)")

  Argument | Type | Default
  --- | --- | ---
  a0 | 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 KGlobalSettings.CompletionNone or echoMode() is not normal.

- trapReturnKey ( )

  returns bool

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

  See also setTrapReturnKey ()

- urlDropsEnabled ( )

  returns bool

  Returns true when decoded URL drops are enabled

- userCancelled (cancelText)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  cancelText | QString |

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