---

KLineEdit Class Reference

An enhanced single line input widget. More...

#include <klineedit.h>

Inheritance diagram for KLineEdit:

List of all members.

Public Slots
virtual void	setReadOnly (bool)
void	rotateText (KCompletionBase::KeyBindingType)
virtual void	setCompletedText (const QString &)
void	setCompletedItems (const QStringList &items)
virtual void	clear ()
void	setSqueezedText (const QString &text)
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 *)
Public Methods
	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
Protected Slots
virtual void	makeCompletion (const QString &)
void	slotAboutToShow ()
void	slotCancelled ()
Protected Methods
virtual void	resizeEvent (QResizeEvent *)
virtual void	keyPressEvent (QKeyEvent *)
virtual void	mousePressEvent (QMouseEvent *)
virtual void	mouseDoubleClickEvent (QMouseEvent *)
virtual QPopupMenu *	createPopupMenu ()
virtual void	dropEvent (QDropEvent *)
virtual void	create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)
virtual void	virtual_hook (int id, void *data)

---

Detailed Description

An enhanced single line input widget.

An enhanced QLineEdit widget for inputting text.

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

@sect 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 );

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

KLineEdit::KLineEdit (  const QString &    string, QWidget *    parent, const char *    name = 0 )

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 object of this widget. name  the name of this widget

KLineEdit::KLineEdit (  QWidget *    parent = 0, const char *    name = 0 )

Constructs a KLineEdit object with a parent and a name. Parameters: string  Text to be shown in the edit widget. parent  The parent object of this widget. name  The name of this widget.

virtual KLineEdit::~KLineEdit (    )  [virtual]

Destructor.

---

Member Function Documentation

void KLineEdit::aboutToShowContextMenu (  QPopupMenu *    )  [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: the  context menu about to be displayed

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

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

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.

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

Emitted whenever the completion box is activated. Since: 3.1

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

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

virtual void KLineEdit::copy (    )  [virtual]

Reimplemented for internal reasons, the API is not affected.

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

Reimplemented for internal reasons, the API is not affected.

virtual QPopupMenu* KLineEdit::createPopupMenu (    )  [protected, virtual]

Re-implemented for internal reasons. API not affected. See QLineEdit::createPopupMenu().

void KLineEdit::cursorAtEnd (    )  [inline]

Puts the text cursor at the end of the string. This method is deprecated. Use QLineEdit::end() instead. Deprecated: QLineEdit::end() Reimplemented in KABC::AddressLineEdit. Definition at line 185 of file klineedit.h. References KStdAccel::end().

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

Re-implemented to handle URI drops. See QLineEdit::dropEvent(). Reimplemented in KABC::AddressLineEdit.

virtual bool KLineEdit::eventFilter (  QObject *   , QEvent *    )  [virtual]

Re-implemented for internal reasons. API not affected. @reimplemented

bool KLineEdit::isContextMenuEnabled (    )  const [inline]

Returns true when the context menu is enabled. Definition at line 216 of file klineedit.h.

bool KLineEdit::isURLDropsEnabled (    )

Returns true when decoded URL drops are enabled

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

Re-implemented for internal reasons. API not affected. See QLineEdit::keyPressEvent(). Reimplemented in KListViewLineEdit, KRestrictedLine, and KABC::AddressLineEdit.

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

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

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

Re-implemented for internal reasons. API not affected. See QWidget::mouseDoubleClickEvent().

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

Re-implemented for internal reasons. API not affected. See QLineEdit::mousePressEvent().

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

Re-implemented for internal reasons. API not affected. See QLineEdit::resizeEvent().

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

void KLineEdit::setCompletedItems (  const QStringList &    items )  [virtual, slot]

Sets items into the completion-box if completionMode() is CompletionPopup. The popup will be shown immediately. Implements KCompletionBase.

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

See KCompletionBase::setCompletedText. Implements KCompletionBase.

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

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

Reimplemented for internal reasons, the API is not affected. Reimplemented from KCompletionBase.

virtual void KLineEdit::setContextMenuEnabled (  bool    showMenu )  [inline, 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 behaviour. Parameters: showMenu  If true, show the context menu. Definition at line 211 of file klineedit.h.

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

Re-implemented for internal reasons. API not changed.

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

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

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

void KLineEdit::setURL (  const KURL &    url )

Sets url into the lineedit. It uses KURL::prettyURL() so that the url is properly decoded for displaying.

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 behaviour of QLineEdit is used, which inserts the encoded URL. Parameters: enable  If true, insert decoded URLs

void KLineEdit::slotAboutToShow (    )  [inline, protected, slot]

Deprecated: . Will be removed in the next major release! Definition at line 397 of file klineedit.h.

void KLineEdit::slotCancelled (    )  [inline, protected, slot]

Deprecated: . Will be removed in the next major release! Definition at line 402 of file klineedit.h.

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

Returns: true if keyevents of Key_Return or Key_Enter will be stopped or if they will be propagated. See also: setTrapReturnKey ()

---

The documentation for this class was generated from the following file:

• klineedit.h

---