KDE 3.5 API Reference kdeui
KCompletionBox Class Reference
A helper widget for "completion-widgets" (KLineEdit, KComboBox)). More...
#include <kcompletionbox.h>
Public Slots | |
| QString | cancelledText () const |
| void | down () |
| void | end () |
| virtual void | hide () |
| 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 | show () |
| void | up () |
Signals | |
| void | activated (const QString &) |
| void | userCancelled (const QString &) |
Public Member Functions | |
| bool | activateOnSelect () const |
| KCompletionBox (QWidget *parent, const char *name=0) | |
| virtual QSize | sizeHint () const |
| ~KCompletionBox () | |
Protected Slots | |
| virtual void | slotActivated (QListBoxItem *) |
Protected Member Functions | |
| QRect | calculateGeometry () const |
| virtual bool | eventFilter (QObject *, QEvent *) |
| void | sizeAndPosition () |
| virtual void | virtual_hook (int id, void *data) |
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.
Definition at line 43 of file kcompletionbox.h.
Constructor & Destructor Documentation
| KCompletionBox::KCompletionBox | ( | QWidget * | parent, | |
| const char * | name = 0 | |||
| ) |
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 47 of file kcompletionbox.cpp.
| KCompletionBox::~KCompletionBox | ( | ) |
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.
- Since:
- 3.4.1
| 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 332 of file kcompletionbox.cpp.
| QString KCompletionBox::cancelledText | ( | ) | const [slot] |
- Returns:
- the text set via setCancelledText() or QString::null.
| void KCompletionBox::down | ( | ) | [slot] |
Moves the selection one line down or select the first item if nothing is selected yet.
Definition at line 381 of file kcompletionbox.cpp.
| void KCompletionBox::end | ( | ) | [slot] |
Reimplemented from KListBox to get events from the viewport (to hide this widget on mouse-click, Escape-presses, etc.
Definition at line 108 of file kcompletionbox.cpp.
| void KCompletionBox::hide | ( | ) | [virtual, slot] |
Re-implemented for internal reasons.
API is unaffected.
Definition at line 324 of file kcompletionbox.cpp.
| void KCompletionBox::home | ( | ) | [slot] |
| 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 468 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.
- See also:
- setTabHandling
| QStringList KCompletionBox::items | ( | ) | const [slot] |
| void KCompletionBox::pageDown | ( | ) | [slot] |
| void KCompletionBox::pageUp | ( | ) | [slot] |
| 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 250 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.
- Since:
- 3.4.1
Definition at line 549 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 436 of file kcompletionbox.cpp.
| void KCompletionBox::setItems | ( | const QStringList & | items | ) | [slot] |
| void KCompletionBox::setTabHandling | ( | bool | enable | ) | [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
Definition at line 426 of file kcompletionbox.cpp.
| void KCompletionBox::show | ( | void | ) | [virtual, slot] |
Re-implemented for internal reasons.
API is unaffected.
Definition at line 300 of file kcompletionbox.cpp.
| void KCompletionBox::sizeAndPosition | ( | ) | [protected] |
| QSize KCompletionBox::sizeHint | ( | void | ) | const [virtual] |
Definition at line 376 of file kcompletionbox.cpp.
| void KCompletionBox::slotActivated | ( | QListBoxItem * | 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 396 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.
| void KCompletionBox::virtual_hook | ( | int | id, | |
| void * | data | |||
| ) | [protected, virtual] |
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:
