KHistoryCombo Class Reference
A combobox which implements a history like a unix shell. A combobox for offering a history and completion. More...
#include <kcombobox.h>
Inheritance diagram for KHistoryCombo:

Public Slots | |
void | addToHistory (const QString &item) |
void | clearHistory () |
Signals | |
void | cleared () |
Public Member Functions | |
KHistoryCombo (QWidget *parent=0L, const char *name=0L) | |
KHistoryCombo (bool useCompletion, QWidget *parent=0L, const char *name=0L) | |
~KHistoryCombo () | |
void | setHistoryItems (QStringList items) |
void | setHistoryItems (QStringList items, bool setCompletionList) |
QStringList | historyItems () const |
bool | removeFromHistory (const QString &item) |
void | setPixmapProvider (KPixmapProvider *prov) |
KPixmapProvider * | pixmapProvider () const |
void | reset () |
Protected Member Functions | |
virtual void | keyPressEvent (QKeyEvent *) |
virtual void | wheelEvent (QWheelEvent *ev) |
void | insertItems (const QStringList &items) |
bool | useCompletion () const |
virtual void | virtual_hook (int id, void *data) |
Properties | |
QStringList | historyItems |
Detailed Description
A combobox which implements a history like a unix shell. A combobox for offering a history and completion.You can navigate through all the items by using the Up or Down arrows (configurable of course). Additionally, weighted completion is available. So you should load and save the completion list to preserve the weighting between sessions.
KHistoryCombo obeys the HISTCONTROL environment variable to determine whether duplicates in the history should be tolerated in addToHistory() or not. During construction of KHistoryCombo, duplicates will be disabled when HISTCONTROL is set to "ignoredups" or "ignoreboth". Otherwise, duplicates are enabled by default.
- Author:
- Carsten Pfeiffer <pfeiffer@kde.org>
Definition at line 515 of file kcombobox.h.
Constructor & Destructor Documentation
|
Constructs a "read-write" combobox. A read-only history combobox doesn't make much sense, so it is only available as read-write. Completion will be used automatically for the items in the combo. The insertion-policy is set to NoInsertion, you have to add the items yourself via the slot addToHistory. If you want every item added, use
Use QComboBox::setMaxCount() to limit the history.
Definition at line 352 of file kcombobox.cpp. References KHistoryCombo(). Referenced by KHistoryCombo(). |
|
Same as the previous constructor, but additionally has the option to specify whether you want to let KHistoryCombo handle completion or not.
If set to Definition at line 359 of file kcombobox.cpp. References KHistoryCombo(). |
|
Destructs the combo, the completion-object and the pixmap-provider.
Definition at line 387 of file kcombobox.cpp. |
Member Function Documentation
|
Inserts
Definition at line 563 of file kcombobox.h. Referenced by setHistoryItems(). |
|
Inserts
Set
Be sure to use different names for saving with KConfig if you have more than one KHistoryCombo.
Note: When
Definition at line 392 of file kcombobox.cpp. References QComboBox::clear(), QComboBox::clearEdit(), insertItems(), QComboBox::maxCount(), setHistoryItems(), KCompletion::setItems(), KCompletion::setOrder(), and useCompletion(). |
|
Returns the list of history items. Empty, when this is not a read-write combobox.
Referenced by setPixmapProvider(). |
|
Removes all items named
Definition at line 489 of file kcombobox.cpp. References QComboBox::count(), QComboBox::currentText(), QString::isEmpty(), removeFromHistory(), KCompletion::removeItem(), and useCompletion(). Referenced by removeFromHistory(). |
|
Sets a pixmap provider, so that items in the combobox can have a pixmap. KPixmapProvider is just an abstract class with the one pure virtual method KPixmapProvider::pixmapFor(). This method is called whenever an item is added to the KHistoryComboBox. Implement it to return your own custom pixmaps, or use the KURLPixmapProvider from libkio, which uses KMimeType::pixmapForURL to resolve icons.
Set
Definition at line 616 of file kcombobox.cpp. References QComboBox::clear(), QComboBox::count(), historyItems(), insertItems(), and setPixmapProvider(). Referenced by setPixmapProvider(). |
|
Definition at line 646 of file kcombobox.h. |
|
Resets the current position of the up/down history. Call this when you manually call setCurrentItem() or clearEdit(). Definition at line 652 of file kcombobox.h. |
|
Adds an item to the end of the history list and to the completion list. If maxCount() is reached, the first item of the list will be removed.
If the last inserted item is the same as
If duplicatesEnabled() is false, any equal existing item will be removed before Note: By using this method and not the Q and KComboBox insertItem() methods, you make sure that the combobox stays in sync with the completion. It would be annoying if completion would give an item not in the combobox, and vice versa.
Definition at line 443 of file kcombobox.cpp. References KCompletion::addItem(), addToHistory(), QComboBox::count(), QComboBox::currentItem(), QComboBox::duplicatesEnabled(), QString::isEmpty(), QComboBox::maxCount(), KPixmapProvider::pixmapFor(), KCompletion::removeItem(), and useCompletion(). Referenced by addToHistory(). |
|
Clears the history and the completion list.
Definition at line 423 of file kcombobox.cpp. References KCompletion::clear(), QComboBox::clear(), QComboBox::currentText(), and useCompletion(). |
|
Emitted when the history was cleared by the entry in the popup menu.
|
|
Handling key-events, the shortcuts to rotate the items.
Definition at line 575 of file kcombobox.cpp. References keyPressEvent(). Referenced by keyPressEvent(). |
|
Handling wheel-events, to rotate the items.
Reimplemented from KComboBox. Definition at line 591 of file kcombobox.cpp. References QWheelEvent::accept(), QWheelEvent::delta(), QComboBox::listBox(), and wheelEvent(). Referenced by wheelEvent(). |
|
Inserts Note: duplicatesEnabled() is not honored here. Called from setHistoryItems() and setPixmapProvider() Definition at line 634 of file kcombobox.cpp. References insertItems(), QString::isEmpty(), and KPixmapProvider::pixmapFor(). Referenced by insertItems(), setHistoryItems(), and setPixmapProvider(). |
|
Definition at line 711 of file kcombobox.h. References KCompletionBase::compObj(). Referenced by addToHistory(), clearHistory(), removeFromHistory(), and setHistoryItems(). |
The documentation for this class was generated from the following files: