• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KCompletionBox Class Reference

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

#include <kcompletionbox.h>

Inheritance diagram for KCompletionBox:

Inheritance graph
[legend]

List of all members.


Public Slots

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

Signals

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

Public Member Functions

bool activateOnSelect () const
 KCompletionBox (QWidget *parent=0)
virtual QSize sizeHint () const
 ~KCompletionBox ()

Protected Slots

virtual void slotActivated (QListWidgetItem *)

Protected Member Functions

QRect calculateGeometry () const
virtual bool eventFilter (QObject *, QEvent *)
virtual QPoint globalPositionHint () const
void sizeAndPosition ()

Properties

bool activateOnSelect
QString cancelledText
bool isTabHandling

Detailed Description

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>

Definition at line 43 of file kcompletionbox.h.


Constructor & Destructor Documentation

KCompletionBox::KCompletionBox ( QWidget *  parent = 0  )  [explicit]

Constructs a KCompletionBox.

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

Definition at line 48 of file kcompletionbox.cpp.

KCompletionBox::~KCompletionBox (  ) 

Destroys the box.

Definition at line 79 of file kcompletionbox.cpp.


Member Function Documentation

void KCompletionBox::activated ( const QString &   )  [signal]

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

bool KCompletionBox::activateOnSelect (  )  const

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

QRect KCompletionBox::calculateGeometry (  )  const [protected]

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.

Definition at line 340 of file kcompletionbox.cpp.

QString KCompletionBox::cancelledText (  )  const [slot]

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

void KCompletionBox::down (  )  [slot]

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

Definition at line 396 of file kcompletionbox.cpp.

void KCompletionBox::end (  )  [slot]

Moves the selection down to the last item.

Definition at line 439 of file kcompletionbox.cpp.

bool KCompletionBox::eventFilter ( QObject *  o,
QEvent *  e 
) [protected, virtual]

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

Definition at line 108 of file kcompletionbox.cpp.

QPoint KCompletionBox::globalPositionHint (  )  const [protected, virtual]

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

Definition at line 302 of file kcompletionbox.cpp.

void KCompletionBox::home (  )  [slot]

Moves the selection up to the first item.

Definition at line 434 of file kcompletionbox.cpp.

void KCompletionBox::insertItems ( const QStringList &  items,
int  index = -1 
) [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)

Definition at line 486 of file kcompletionbox.cpp.

bool KCompletionBox::isTabHandling (  )  const [slot]

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

QStringList KCompletionBox::items (  )  const [slot]

Returns a list of all items currently in the box.

Definition at line 85 of file kcompletionbox.cpp.

void KCompletionBox::pageDown (  )  [slot]

Moves the selection one page down.

Definition at line 417 of file kcompletionbox.cpp.

void KCompletionBox::pageUp (  )  [slot]

Moves the selection one page up.

Definition at line 425 of file kcompletionbox.cpp.

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

Definition at line 252 of file kcompletionbox.cpp.

void KCompletionBox::setActivateOnSelect ( bool  state  )  [slot]

Set whether or not the selected signal should be emitted when an item is selected.

By default the selected() signal is emitted.

Parameters:
state false if the signal should not be emitted.

Definition at line 576 of file kcompletionbox.cpp.

void KCompletionBox::setCancelledText ( const QString &  txt  )  [slot]

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& )
Parameters:
txt the text to be emitted if the user cancels this box

Definition at line 454 of file kcompletionbox.cpp.

void KCompletionBox::setItems ( const QStringList &  items  )  [slot]

Clears the box and inserts items.

Definition at line 495 of file kcompletionbox.cpp.

void KCompletionBox::setTabHandling ( bool  enable  )  [slot]

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

Definition at line 444 of file kcompletionbox.cpp.

void KCompletionBox::setVisible ( bool  visible  )  [virtual, slot]

Re-implemented for internal reasons.

API is unaffected.

Definition at line 309 of file kcompletionbox.cpp.

void KCompletionBox::sizeAndPosition (  )  [protected]

This properly sizes and positions the listbox.

Definition at line 270 of file kcompletionbox.cpp.

QSize KCompletionBox::sizeHint ( void   )  const [virtual]

Definition at line 391 of file kcompletionbox.cpp.

void KCompletionBox::slotActivated ( QListWidgetItem *  item  )  [protected, virtual, slot]

Called when an item was activated.

Emits activated() with the item.

Definition at line 99 of file kcompletionbox.cpp.

void KCompletionBox::up (  )  [slot]

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

Definition at line 411 of file kcompletionbox.cpp.

void KCompletionBox::userCancelled ( const QString &   )  [signal]

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


Property Documentation

bool KCompletionBox::activateOnSelect [read, write]

Definition at line 48 of file kcompletionbox.h.

QString KCompletionBox::cancelledText [read, write]

Definition at line 47 of file kcompletionbox.h.

bool KCompletionBox::isTabHandling [read, write]

Definition at line 46 of file kcompletionbox.h.


The documentation for this class was generated from the following files:
  • kcompletionbox.h
  • kcompletionbox.cpp

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal