class KCompletionBox

# class KCompletionBox | A helper widget for "completion-widgets" (KLineEdit, KComboBox)). More...
Definition | `#include <kcompletionbox.h>`
Inherits | KListBox [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

#### Public Methods

- KCompletionBox ( QWidget *parent, const char *name = 0 )
- ~KCompletionBox ()
- virtual QSize sizeHint () const

#### Public Slots

- QStringList items () const
- void insertItems ( const QStringList& items, int index = -1 )
- void setItems ( const QStringList& items )
- virtual void popup ()
- void setTabHandling ( bool enable )
- bool isTabHandling () const
- void setCancelledText ( const QString& )
- QString cancelledText () const
- void down ()
- void up ()
- void pageDown ()
- void pageUp ()
- void home ()
- void end ()
- virtual void show ()
- virtual void hide ()

#### Signals

- void activated ( const QString& )
- void userCancelled ( const QString& )

#### Protected Methods

- virtual bool eventFilter ( QObject *, QEvent * )
- virtual void virtual_hook ( int id, void* data )

#### Protected Slots

- virtual void slotActivated ( QListBoxItem * )

## Detailed Description

A little utility class for "completion-widgets", like KLineEdit or KComboBox. KCompletionBox is a listbox, displayed as a rectangle without any window decoration, usually directly under the lineedit or combobox. It is filled with all possible matches for a completion, so the user can select the one he wants.

It is used when KGlobalSettings::Completion == CompletionPopup or CompletionPopupAuto.

KCompletionBox ( QWidget *parent, const char *name = 0 ) | ### KCompletionBox

Constructs a KCompletionBox.

Notice: the parent needs to be always 0L, so you can't specify it in the constructor. Because of that, Qt's auto-deletion does not take place, so you have to explicitly delete this widget when you don't need it anymore.

The parent widget is used to give the focus back when pressing the up-button on the very first item.

~KCompletionBox () | ### ~KCompletionBox

Destroys the box

QSize sizeHint () | ### sizeHint

[const virtual]

QStringList items () | ### items

[const slot]

Returns a list of all items currently in the box.

void insertItems ( const QStringList& items, int index = -1 ) | ### insertItems

[slot]

Inserts `items` into the box. Does not clear the items before. `index` determines at which position `items` will be inserted. (defaults to appending them at the end)

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

[slot]

Clears the box and inserts `items`.

void popup () | ### popup

[virtual slot]

Adjusts the size of the box to fit the width of the parent given in the constructor and pops it up at the most appropriate place, relative to the parent.

Depending on the screensize and the position of the parent, this may be a different place, however the default is to pop it up and the lower left corner of the parent.

Make sure to hide() the box when appropriate.

void setTabHandling ( bool enable ) | ### setTabHandling

[slot]

Makes this widget (when visible) capture Tab-key events to traverse the items in the dropdown list.

Default off, as it conflicts with the usual behavior of Tab to traverse widgets. It is useful for cases like Konqueror's Location Bar, though.

See also: isTabHandling

bool isTabHandling () | ### isTabHandling

[const slot]

Default is false.

Returns: true if this widget is handling Tab-key events to traverse the items in the dropdown list, otherwise false.

See also: setTabHandling

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

[slot]

Sets the text to be emitted if the user chooses not to pick from the available matches.

If the cancelled text is not set through this function, the userCancelled signal will not be emitted.

Parameters:

txt | the text to be emitted if the user cancels this box

See also: userCancelled(, const, QString&, )

QString cancelledText () | ### cancelledText

[const slot]

Returns: the text set via setCancelledText() or QString::null.

void down () | ### down

[slot]

Moves the selection one line down or select the first item if nothing is selected yet.

void up () | ### up

[slot]

Moves the selection one line up or select the first item if nothing is selected yet.

void pageDown () | ### pageDown

[slot]

Moves the selection one page down.

void pageUp () | ### pageUp

[slot]

Moves the selection one page up.

void home () | ### home

[slot]

Moves the selection up to the first item.

void end () | ### end

[slot]

Moves the selection down to the last item.

void show () | ### show

[virtual slot]

Re-implemented for internal reasons. API is unaffected.

void hide () | ### hide

[virtual slot]

Re-implemented for internal reasons. API is unaffected.

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

[signal]

Emitted when an item was selected, contains the text of the selected item.

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

[signal]

Emitted whenever the user chooses to ignore the available selections and close the this box.

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

[protected virtual]

Reimplemented from KListBox to get events from the viewport (to hide this widget on mouse-click, Escape-presses, etc.

void slotActivated ( QListBoxItem * ) | ### slotActivated

[protected slots virtual slot]

Called when an item was activated. Emits activated() with the item.

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

[protected virtual]

Reimplemented from KListBox.

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