• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KLineEdit Class Reference

#include <klineedit.h>

Inheritance diagram for KLineEdit:

Inheritance graph
[legend]

List of all members.


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

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 :

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

Definition at line 147 of file klineedit.h.


Public Slots

virtual void clear ()
bool passwordMode () const
void rotateText (KCompletionBase::KeyBindingType type)
void setCompletedItems (const QStringList &items, bool autoSuggest=true)
virtual void setCompletedText (const QString &)
void setPasswordMode (bool b=true)
virtual void setReadOnly (bool)
void setSqueezedText (const QString &text)
virtual void setText (const QString &)

Signals

void aboutToShowContextMenu (QMenu *p)
void clearButtonClicked ()
void completion (const QString &)
void completionBoxActivated (const QString &)
void completionModeChanged (KGlobalSettings::Completion)
void returnPressed (const QString &)
void substringCompletion (const QString &)
void textRotation (KCompletionBase::KeyBindingType)

Public Member Functions

QSize clearButtonUsedSize () const
QString clickMessage () const
KCompletionBox * completionBox (bool create=true)
virtual void copy () const
bool isClearButtonShown () const
bool isContextMenuEnabled () const
bool isSqueezedTextEnabled () const
 KLineEdit (QWidget *parent=0)
 KLineEdit (const QString &string, QWidget *parent=0)
QString originalText () const
void setClearButtonShown (bool show)
void setClickMessage (const QString &msg)
void setCompletionBox (KCompletionBox *box)
virtual void setCompletionMode (KGlobalSettings::Completion mode)
void setCompletionModeDisabled (KGlobalSettings::Completion mode, bool disable=true)
virtual void setCompletionObject (KCompletion *, bool hsig=true)
virtual void setContextMenuEnabled (bool showMenu)
void setSqueezedTextEnabled (bool enable)
void setTrapReturnKey (bool trap)
void setUrl (const KUrl &url)
void setUrlDropsEnabled (bool enable)
bool trapReturnKey () const
bool urlDropsEnabled () const
virtual ~KLineEdit ()

Protected Slots

virtual void makeCompletion (const QString &)
void userCancelled (const QString &cancelText)

Protected Member Functions

bool autoSuggest () const
virtual void contextMenuEvent (QContextMenuEvent *)
virtual void create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)
QMenu * createStandardContextMenu ()
virtual void dropEvent (QDropEvent *)
virtual bool event (QEvent *)
virtual void focusInEvent (QFocusEvent *ev)
virtual void focusOutEvent (QFocusEvent *ev)
virtual void keyPressEvent (QKeyEvent *)
virtual void mouseDoubleClickEvent (QMouseEvent *)
virtual void mousePressEvent (QMouseEvent *)
virtual void mouseReleaseEvent (QMouseEvent *)
virtual void paintEvent (QPaintEvent *ev)
virtual void resizeEvent (QResizeEvent *)
virtual void setCompletedText (const QString &, bool)
void setUserSelection (bool userSelection)

Properties

QString clickMessage
bool contextMenuEnabled
bool passwordMode
bool showClearButton
bool squeezedTextEnabled
bool trapEnterKeyEvent
bool urlDropsEnabled

Constructor & Destructor Documentation

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

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 185 of file klineedit.cpp.

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

Constructs a line edit.

Parameters:
parent The parent widget of the line edit.

Definition at line 191 of file klineedit.cpp.

KLineEdit::~KLineEdit (  )  [virtual]

Destructor.

Definition at line 198 of file klineedit.cpp.


Member Function Documentation

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

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.

Parameters:
p the context menu about to be displayed

bool KLineEdit::autoSuggest (  )  const [protected]

Whether in current state text should be auto-suggested.

Definition at line 1593 of file klineedit.cpp.

void KLineEdit::clear (  )  [virtual, slot]

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

Reimplemented from QLineEdit.

Reimplemented in KListWidgetSearchLine.

Definition at line 1571 of file klineedit.cpp.

void KLineEdit::clearButtonClicked (  )  [signal]

Emitted when the user clicked on the clear button.

QSize KLineEdit::clearButtonUsedSize (  )  const

Returns:
the size used by the clear button

Since:
KDE 4.1

Definition at line 264 of file klineedit.cpp.

QString KLineEdit::clickMessage (  )  const

Returns:
the message set with setClickMessage

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

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.

KCompletionBox * KLineEdit::completionBox ( bool  create = true  ) 

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

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.

Definition at line 1510 of file klineedit.cpp.

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

Emitted whenever the completion box is activated.

void KLineEdit::completionModeChanged ( KGlobalSettings::Completion   )  [signal]

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

void KLineEdit::contextMenuEvent ( QContextMenuEvent *  e  )  [protected, virtual]

Re-implemented for internal reasons.

API not affected.

See QLineEdit::contextMenuEvent().

Reimplemented from QLineEdit.

Reimplemented in KTreeWidgetSearchLine.

Definition at line 1153 of file klineedit.cpp.

void KLineEdit::copy (  )  const [virtual]

Reimplemented for internal reasons, the API is not affected.

Definition at line 604 of file klineedit.cpp.

void KLineEdit::create ( WId  id = 0,
bool  initializeWindow = true,
bool  destroyOldWindow = true 
) [protected, virtual]

Reimplemented for internal reasons, the API is not affected.

Definition at line 1536 of file klineedit.cpp.

QMenu * KLineEdit::createStandardContextMenu (  )  [protected]

Re-implemented for internal reasons.

API not affected.

See QLineEdit::createStandardContextMenu().

Reimplemented from QLineEdit.

Definition at line 1081 of file klineedit.cpp.

void KLineEdit::dropEvent ( QDropEvent *  e  )  [protected, virtual]

Re-implemented to handle URI drops.

See QLineEdit::dropEvent().

Definition at line 1213 of file klineedit.cpp.

bool KLineEdit::event ( QEvent *  ev  )  [protected, virtual]

Re-implemented for internal reasons.

API not affected.

Reimplemented in KListWidgetSearchLine, and KTreeWidgetSearchLine.

Definition at line 1240 of file klineedit.cpp.

void KLineEdit::focusInEvent ( QFocusEvent *  ev  )  [protected, virtual]

Definition at line 1633 of file klineedit.cpp.

void KLineEdit::focusOutEvent ( QFocusEvent *  ev  )  [protected, virtual]

Definition at line 1643 of file klineedit.cpp.

bool KLineEdit::isClearButtonShown (  )  const

Returns:
whether or not the clear button is shown

Definition at line 259 of file klineedit.cpp.

bool KLineEdit::isContextMenuEnabled (  )  const

Returns true when the context menu is enabled.

Deprecated:
use contextMenuPolicy

Definition at line 1666 of file klineedit.cpp.

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 511 of file klineedit.cpp.

void KLineEdit::keyPressEvent ( QKeyEvent *  e  )  [protected, virtual]

Re-implemented for internal reasons.

API not affected.

See QLineEdit::keyPressEvent().

Reimplemented from QLineEdit.

Reimplemented in KRestrictedLine.

Definition at line 648 of file klineedit.cpp.

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

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

Definition at line 421 of file klineedit.cpp.

void KLineEdit::mouseDoubleClickEvent ( QMouseEvent *  e  )  [protected, virtual]

Re-implemented for internal reasons.

API not affected.

See QWidget::mouseDoubleClickEvent().

Definition at line 1013 of file klineedit.cpp.

void KLineEdit::mousePressEvent ( QMouseEvent *  e  )  [protected, virtual]

Re-implemented for internal reasons.

API not affected.

See QLineEdit::mousePressEvent().

Definition at line 1024 of file klineedit.cpp.

void KLineEdit::mouseReleaseEvent ( QMouseEvent *  e  )  [protected, virtual]

Re-implemented for internal reasons.

API not affected.

See QLineEdit::mouseReleaseEvent().

Definition at line 1045 of file klineedit.cpp.

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 1585 of file klineedit.cpp.

void KLineEdit::paintEvent ( QPaintEvent *  ev  )  [protected, virtual]

Definition at line 1598 of file klineedit.cpp.

bool KLineEdit::passwordMode (  )  const [slot]

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

void KLineEdit::resizeEvent ( QResizeEvent *  ev  )  [protected, virtual]

Re-implemented for internal reasons.

API not affected.

See QLineEdit::resizeEvent().

Definition at line 639 of file klineedit.cpp.

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

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.

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

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.

Parameters:
type The key-binding invoked.

Definition at line 400 of file klineedit.cpp.

void KLineEdit::setClearButtonShown ( bool  show  ) 

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.

Definition at line 236 of file klineedit.cpp.

void KLineEdit::setClickMessage ( const QString &  msg  ) 

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.

Definition at line 1653 of file klineedit.cpp.

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

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.

Implements KCompletionBase.

Definition at line 1437 of file klineedit.cpp.

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

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 371 of file klineedit.cpp.

void KLineEdit::setCompletedText ( const QString &  text  )  [virtual, slot]

See KCompletionBase::setCompletedText.

Implements KCompletionBase.

Definition at line 390 of file klineedit.cpp.

void KLineEdit::setCompletionBox ( KCompletionBox *  box  ) 

Set the completion-box to be used in completion mode KGlobalSettings::CompletionPopup.

This will do nothing if a completion-box already exists.

Parameters:
box The KCompletionBox to set

Definition at line 1325 of file klineedit.cpp.

void KLineEdit::setCompletionMode ( KGlobalSettings::Completion  mode  )  [virtual]

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 339 of file klineedit.cpp.

void KLineEdit::setCompletionModeDisabled ( KGlobalSettings::Completion  mode,
bool  disable = true 
)

Disables completion modes by makeing them non-checkable.

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

Definition at line 366 of file klineedit.cpp.

void KLineEdit::setCompletionObject ( KCompletion *  comp,
bool  hsig = true 
) [virtual]

Reimplemented for internal reasons, the API is not affected.

Reimplemented from KCompletionBase.

Definition at line 1521 of file klineedit.cpp.

void KLineEdit::setContextMenuEnabled ( bool  showMenu  )  [virtual]

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.

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

Definition at line 1661 of file klineedit.cpp.

void KLineEdit::setPasswordMode ( bool  b = true  )  [slot]

set the line edit in password mode.

this change the EchoMode according to KDE preferences.

Parameters:
b true to set in password mode

Definition at line 1671 of file klineedit.cpp.

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

Re-implemented for internal reasons.

API not changed.

Definition at line 460 of file klineedit.cpp.

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

Squeezes text into the line edit.

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

Definition at line 500 of file klineedit.cpp.

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 506 of file klineedit.cpp.

void KLineEdit::setText ( const QString &  text  )  [virtual, slot]

Re-implemented to enable text squeezing.

API is not affected.

Definition at line 516 of file klineedit.cpp.

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 1310 of file klineedit.cpp.

void KLineEdit::setUrl ( const KUrl &  url  ) 

Sets url into the lineedit.

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

Definition at line 1320 of file klineedit.cpp.

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.

Parameters:
enable If true, insert decoded URLs

Definition at line 1300 of file klineedit.cpp.

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

Sets the widget in userSelection mode or in automatic completion selection mode.

This changes the colors of selections.

Definition at line 1542 of file klineedit.cpp.

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

Emitted when the shortcut for substring completion is pressed.

void KLineEdit::textRotation ( KCompletionBase::KeyBindingType   )  [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 KGlobalSettings::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 ()

Definition at line 1315 of file klineedit.cpp.

bool KLineEdit::urlDropsEnabled (  )  const

Returns true when decoded URL drops are enabled.

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

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 1344 of file klineedit.cpp.


Property Documentation

QString KLineEdit::clickMessage [read, write]

Definition at line 157 of file klineedit.h.

bool KLineEdit::contextMenuEnabled [read, write]

Definition at line 153 of file klineedit.h.

bool KLineEdit::passwordMode [read, write]

Definition at line 159 of file klineedit.h.

bool KLineEdit::showClearButton [read, write]

Definition at line 158 of file klineedit.h.

bool KLineEdit::squeezedTextEnabled [read, write]

Definition at line 156 of file klineedit.h.

bool KLineEdit::trapEnterKeyEvent [read, write]

Definition at line 155 of file klineedit.h.

bool KLineEdit::urlDropsEnabled [read, write]

Definition at line 154 of file klineedit.h.


The documentation for this class was generated from the following files:
  • klineedit.h
  • klineedit.cpp

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • KIO
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal