class KLineEdit

# class KLineEdit | An enhanced single line input widget. More...
Definition | `#include <klineedit.h>`
Inherits | KCompletionBase (kdecore) [public ], QLineEdit (qt) [public ]
Inherited by | KListViewLineEdit, KRestrictedLine
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

#### 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
- KCompletionBox * completionBox ( bool create = true )
- virtual void setCompletionObject ( KCompletion *, bool hsig = true )
- virtual void copy () const

#### 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* )

#### 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 setCompletedText ( const QString& , bool )
- virtual void create ( WId = 0, bool initializeWindow = true, bool destroyOldWindow = true )
- virtual void virtual_hook ( int id, void* data )

#### Protected Slots

- virtual void makeCompletion ( const QString& )
- void slotAboutToShow ()
- void slotCancelled ()

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

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

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 ( QWidget *parent=0, const char *name=0 ) | ### KLineEdit

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.

~KLineEdit () | ### ~KLineEdit

[virtual]

Destructor.

void setURL ( const KURL& url ) | ### setURL

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

void cursorAtEnd () | ### cursorAtEnd

Puts the text cursor at the end of the string.

This method is deprecated. Use QLineEdit::end() instead.

QLineEdit::end()

void setCompletionMode ( KGlobalSettings::Completion mode ) | ### setCompletionMode

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

void setContextMenuEnabled ( bool showMenu ) | ### setContextMenuEnabled

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

bool isContextMenuEnabled () | ### isContextMenuEnabled

[const]

Returns `true` when the context menu is enabled.

void setURLDropsEnabled ( bool enable ) | ### setURLDropsEnabled

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

bool isURLDropsEnabled () | ### isURLDropsEnabled

[const]

Returns `true` when decoded URL drops are enabled

void setTrapReturnKey ( bool trap ) | ### setTrapReturnKey

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

bool trapReturnKey () | ### trapReturnKey

[const]

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

See also: setTrapReturnKey, ()

bool eventFilter ( QObject *, QEvent * ) | ### eventFilter

[virtual]

Re-implemented for internal reasons. API not affected.

KCompletionBox * completionBox ( bool create = true ) | ### completionBox

Parameters:

create | Set this to false if you don't want the box to be created i.e. to test if it is available.

Returns: the completion-box, that is used in completion mode KGlobalSettings::CompletionPopup. This method will create a completion-box if none is there, yet.

void setCompletionObject ( KCompletion *, bool hsig = true ) | ### setCompletionObject

[virtual]

Reimplemented for internal reasons, the API is not affected.

Reimplemented from KCompletionBase.

void copy () | ### copy

[const virtual]

Reimplemented for internal reasons, the API is not affected.

void completionBoxActivated (const QString &) | ### completionBoxActivated

[signal]

Emitted whenever the completion box is activated.

void returnPressed ( const QString& ) | ### returnPressed

[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 completion ( const QString& ) | ### completion

[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 substringCompletion ( const QString& ) | ### substringCompletion

[signal]

Emitted when the shortcut for substring completion is pressed.

void textRotation ( KCompletionBase::KeyBindingType ) | ### textRotation

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

void completionModeChanged ( KGlobalSettings::Completion ) | ### completionModeChanged

[signal]

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

void aboutToShowContextMenu ( QPopupMenu* ) | ### aboutToShowContextMenu

[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

void setReadOnly (bool) | ### setReadOnly

[virtual slot]

Re-implemented for internal reasons. API not changed.

void rotateText ( KCompletionBase::KeyBindingType ) | ### rotateText

[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 setCompletedText ( const QString& ) | ### setCompletedText

[virtual slot]

See KCompletionBase::setCompletedText.

Reimplemented from KCompletionBase.

void setCompletedItems ( const QStringList& items ) | ### setCompletedItems

[slot]

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

Reimplemented from KCompletionBase.

void clear () | ### clear

[virtual slot]

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

void setSqueezedText ( const QString &text) | ### setSqueezedText

[slot]

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

void makeCompletion ( const QString& ) | ### makeCompletion

[protected slots virtual slot]

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

void slotAboutToShow () | ### slotAboutToShow

[protected slots slot]

void slotCancelled () | ### slotCancelled

[protected slots slot]

void resizeEvent ( QResizeEvent * ) | ### resizeEvent

[protected virtual]

Re-implemented for internal reasons. API not affected.

See QLineEdit::resizeEvent().

void keyPressEvent ( QKeyEvent * ) | ### keyPressEvent

[protected virtual]

Re-implemented for internal reasons. API not affected.

See QLineEdit::keyPressEvent().

Reimplemented from QLineEdit.

void mousePressEvent ( QMouseEvent * ) | ### mousePressEvent

[protected virtual]

Re-implemented for internal reasons. API not affected.

See QLineEdit::mousePressEvent().

void mouseDoubleClickEvent ( QMouseEvent * ) | ### mouseDoubleClickEvent

[protected virtual]

Re-implemented for internal reasons. API not affected.

See QWidget::mouseDoubleClickEvent().

QPopupMenu * createPopupMenu () | ### createPopupMenu

[protected virtual]

Re-implemented for internal reasons. API not affected.

See QLineEdit::createPopupMenu().

Reimplemented from QLineEdit.

void dropEvent ( QDropEvent * ) | ### dropEvent

[protected virtual]

Re-implemented to handle URI drops.

See QLineEdit::dropEvent().

void setCompletedText ( const QString& , bool ) | ### setCompletedText

[protected virtual]

Reimplemented from KCompletionBase.

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

[protected virtual]

Reimplemented for internal reasons, the API is not affected.

void virtual_hook ( int id, void* data ) | ### virtual_hook

[protected virtual]

Reimplemented from KCompletionBase.

- Author: Dawit Alemayehu
- Generated: root on macppc.ports.openbsd.org on Sat Sep 6 10:36:37 2003, using kdoc 2.0a54.