# class KCompletionBox

###

Module | kdeui
Namespace |
Class | KCompletionBox
Inherits | KListWidget

A helper widget for "completion-widgets" (KLineEdit, KComboBox))

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.

Author Carsten Pfeiffer <pfeiffer@kde.org>

### methods

- KCompletionBox (parent)

  returns ctor
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  parent | QWidget | 0

  Constructs a KCompletionBox.

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

- KCompletionBox (a0)

  returns ctor
  before KDE 4.1.0 only

  Argument | Type | Default
  --- | --- | ---
  a0 | QWidget | 0

- activateOnSelect ( )

  returns bool

  Returns true if selecting an item results in the emition of the selected() signal.

- activated (a0)

  returns Nothing
  SIGNAL ("activated (const QString&)")

  Argument | Type | Default
  --- | --- | ---
  a0 | QString |

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

- calculateGeometry ( )

  returns QRect

  This calculates the size of the dropdown and the relative position of the top left corner with respect to the parent widget. This matches the geometry and position normally used by K/QComboBox when used with one.

- cancelledText ( )

  returns QString

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

- down ( )

  returns Nothing

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

- end ( )

  returns Nothing

  Moves the selection down to the last item.

- eventFilter (a0, a1)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  a0 | QObject |
  a1 | QEvent |

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

- globalPositionHint ( )

  returns QPoint

  The preferred global coordinate at which the completion box's top left corner should be positioned.

- home ( )

  returns Nothing

  Moves the selection up to the first item.

- insertItems (items, index)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  items | QStringList |
  index | int | -1

  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)

- isTabHandling ( )

  returns bool

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

  Default is true.

  See also setTabHandling

- items ( )

  returns QStringList

  Returns a list of all items currently in the box.

- pageDown ( )

  returns Nothing

  Moves the selection one page down.

- pageUp ( )

  returns Nothing

  Moves the selection one page up.

- popup ( )

  returns Nothing

  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.

- setActivateOnSelect (state)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  state | bool |

  Set whether or not the selected signal should be emitted when an item is selected. By default the selected() signal is emitted.

  state - false if the signal should not be emitted.

- setCancelledText (txt)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  txt | QString |

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

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

  See also userCancelled( const QString& )

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

- setItems (items)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  items | QStringList |

  Clears the box and inserts items.

- setTabHandling (enable)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  enable | bool |

  Makes this widget (when visible) capture Tab-key events to traverse the items in the dropdown list (Tab goes down, Shift+Tab goes up).

  On by default, but should be turned off when used in combination with KUrlCompletion. When off, KLineEdit handles Tab itself, making it select the current item from the completion box, which is particularly useful when using KUrlCompletion.

  See also isTabHandling

- setVisible (visible)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  visible | bool |

  Re-implemented for internal reasons. API is unaffected.

- sizeAndPosition ( )

  returns Nothing

  This properly sizes and positions the listbox.

- sizeHint ( )

  returns QSize

- slotActivated (a0)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  a0 | QListWidgetItem |

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

- up ( )

  returns Nothing

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

- userCancelled (a0)

  returns Nothing
  SIGNAL ("userCancelled (const QString&)")

  Argument | Type | Default
  --- | --- | ---
  a0 | QString |

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