class KLineEdit

 An enhanced single line input widget. More...
Definition#include <klineedit.h>
InheritsKCompletionBase (kdecore), QLineEdit (qt)
Inherited byKListViewLineEdit, KRestrictedLine
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Slots

Signals

Protected Methods

Protected Slots

Detailed Description

An enhanced QLineEdit widget for inputting text.

Detail

This widget inherits from QLineEdit and implements the following additional functionalities: q 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 KGlobal::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.

Useage

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

void  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::Password.

Reimplemented from QLineEdit

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

void  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 CompletionNone or EchoMode is not normal.

void  completionModeChanged ( KGlobalSettings::Completion )

[signal]

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

void  rotateText ( KCompletionBase::KeyBindingType )

[slot]

Iterate 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:
typeThe key-binding invoked.

void  setCompletedText ( const QString& )

[virtual slot]

See KCompletionBase::setCompletionText.

Reimplemented from KCompletionBase

void  setCompletedItems ( const QStringList& items )

[slot]

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

void  makeCompletion ( const QString& )

[protected virtual slot]

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

void  slotAboutToShow ()

[protected slot]

void  slotCancelled ()

[protected slot]

void  keyPressEvent ( QKeyEvent * )

[protected virtual]

Re-implemented for internal reasons. API not affected.

See QLineEdit::keyPressEvent().

Reimplemented from QLineEdit

void  mousePressEvent ( QMouseEvent * )

[protected virtual]

Re-implemented for internal reasons. API not affected.

See QLineEdit::mousePressEvent().

Reimplemented from QLineEdit

void  dropEvent ( QDropEvent * )

[protected virtual]

Re-implemented to handle URI drops.

See QLineEdit::dropEvent().

Reimplemented from QWidget

void  create ( WId = 0, bool initializeWindow = true, bool destroyOldWindow = true )

[protected virtual]

Reimplemented for internal reasons, the API is not affected.

Reimplemented from QWidget