Search for usage in LXR

#include <KHistoryComboBox>

Inheritance diagram for KHistoryComboBox:


QStringList historyItems
- Properties inherited from KComboBox
bool autoCompletion
bool trapReturnKey
bool urlDropsEnabled
- Properties inherited from QComboBox
- Properties inherited from QWidget
- Properties inherited from QObject


void cleared ()
- Signals inherited from KComboBox
void aboutToShowContextMenu (QMenu *contextMenu)
void completion (const QString &)
void completionModeChanged (KCompletion::CompletionMode)
void returnPressed ()
void returnPressed (const QString &text)
void substringCompletion (const QString &)
void textRotation (KCompletionBase::KeyBindingType)

Public Slots

void addToHistory (const QString &item)
void clearHistory ()
void reset ()
- Public Slots inherited from KComboBox
void rotateText (KCompletionBase::KeyBindingType type)
void setCompletedItems (const QStringList &items, bool autoSuggest=true) override
void setCompletedText (const QString &) override
void setCurrentItem (const QString &item, bool insert=false, int index=-1)

Public Member Functions

 KHistoryComboBox (bool useCompletion, QWidget *parent=nullptr)
 KHistoryComboBox (QWidget *parent=nullptr)
 ~KHistoryComboBox () override
QStringList historyItems () const
void insertItems (int index, const QStringList &list)
KPixmapProviderpixmapProvider () const
bool removeFromHistory (const QString &item)
void setHistoryItems (const QStringList &items)
void setHistoryItems (const QStringList &items, bool setCompletionList)
void setIconProvider (std::function< QIcon(const QString &)> providerFunction)
void setPixmapProvider (KPixmapProvider *provider)
- Public Member Functions inherited from KComboBox
 KComboBox (bool rw, QWidget *parent=nullptr)
 KComboBox (QWidget *parent=nullptr)
 ~KComboBox () override
void addUrl (const QIcon &icon, const QUrl &url)
void addUrl (const QUrl &url)
bool autoCompletion () const
void changeURL (const QPixmap &pixmap, const QUrl &url, int index)
void changeURL (const QUrl &url, int index)
void changeUrl (int index, const QIcon &icon, const QUrl &url)
void changeUrl (int index, const QUrl &url)
KCompletionBoxcompletionBox (bool create=true)
bool contains (const QString &text) const
QMenucontextMenu () const
int cursorPosition () const
void insertURL (const QPixmap &pixmap, const QUrl &url, int index=-1)
void insertURL (const QUrl &url, int index=-1)
void insertUrl (int index, const QIcon &icon, const QUrl &url)
void insertUrl (int index, const QUrl &url)
virtual void setAutoCompletion (bool autocomplete)
virtual void setContextMenuEnabled (bool showMenu)
void setEditable (bool editable)
void setEditUrl (const QUrl &url)
virtual void setLineEdit (QLineEdit *)
void setTrapReturnKey (bool trap)
void setUrlDropsEnabled (bool enable)
bool trapReturnKey () const
bool urlDropsEnabled () const
- Public Member Functions inherited from QComboBox
 QComboBox (QWidget *parent)
void activated (const QString &text)
void activated (int index)
void addItem (const QIcon &icon, const QString &text, const QVariant &userData)
void addItem (const QString &text, const QVariant &userData)
void addItems (const QStringList &texts)
bool autoCompletion () const const
Qt::CaseSensitivity autoCompletionCaseSensitivity () const const
void clear ()
void clearEditText ()
QCompletercompleter () const const
int count () const const
QVariant currentData (int role) const const
int currentIndex () const const
void currentIndexChanged (const QString &text)
void currentIndexChanged (int index)
QString currentText () const const
void currentTextChanged (const QString &text)
bool duplicatesEnabled () const const
void editTextChanged (const QString &text)
virtual bool event (QEvent *event) override
int findData (const QVariant &data, int role, Qt::MatchFlags flags) const const
int findText (const QString &text, Qt::MatchFlags flags) const const
bool hasFrame () const const
virtual void hidePopup ()
void highlighted (const QString &text)
void highlighted (int index)
QSize iconSize () const const
virtual QVariant inputMethodQuery (Qt::InputMethodQuery query) const const override
void insertItem (int index, const QIcon &icon, const QString &text, const QVariant &userData)
void insertItem (int index, const QString &text, const QVariant &userData)
void insertItems (int index, const QStringList &list)
QComboBox::InsertPolicy insertPolicy () const const
void insertSeparator (int index)
bool isEditable () const const
QVariant itemData (int index, int role) const const
QAbstractItemDelegateitemDelegate () const const
QIcon itemIcon (int index) const const
QString itemText (int index) const const
QLineEditlineEdit () const const
int maxCount () const const
int maxVisibleItems () const const
int minimumContentsLength () const const
QAbstractItemModelmodel () const const
int modelColumn () const const
QString placeholderText () const const
void removeItem (int index)
QModelIndex rootModelIndex () const const
void setAutoCompletion (bool enable)
void setAutoCompletionCaseSensitivity (Qt::CaseSensitivity sensitivity)
void setCompleter (QCompleter *completer)
void setCurrentIndex (int index)
void setCurrentText (const QString &text)
void setDuplicatesEnabled (bool enable)
void setEditable (bool editable)
void setEditText (const QString &text)
void setFrame (bool)
void setIconSize (const QSize &size)
void setInsertPolicy (QComboBox::InsertPolicy policy)
void setItemData (int index, const QVariant &value, int role)
void setItemDelegate (QAbstractItemDelegate *delegate)
void setItemIcon (int index, const QIcon &icon)
void setItemText (int index, const QString &text)
void setLineEdit (QLineEdit *edit)
void setMaxCount (int max)
void setMaxVisibleItems (int maxItems)
void setMinimumContentsLength (int characters)
void setModel (QAbstractItemModel *model)
void setModelColumn (int visibleColumn)
void setPlaceholderText (const QString &placeholderText)
void setRootModelIndex (const QModelIndex &index)
void setSizeAdjustPolicy (QComboBox::SizeAdjustPolicy policy)
void setValidator (const QValidator *validator)
void setView (QAbstractItemView *itemView)
virtual void showPopup ()
QComboBox::SizeAdjustPolicy sizeAdjustPolicy () const const
virtual QSize sizeHint () const const override
void textActivated (const QString &text)
void textHighlighted (const QString &text)
const QValidatorvalidator () const const
QAbstractItemViewview () const const
- Public Member Functions inherited from QWidget
 QWidget (QWidget *parent, Qt::WindowFlags f)
bool acceptDrops () const const
QString accessibleDescription () const const
QString accessibleName () const const
QList< QAction * > actions () const const
void activateWindow ()
void addAction (QAction *action)
void addActions (QList< QAction * > actions)
void adjustSize ()
bool autoFillBackground () const const
QPalette::ColorRole backgroundRole () const const
QBackingStorebackingStore () const const
QSize baseSize () const const
QWidgetchildAt (const QPoint &p) const const
QWidgetchildAt (int x, int y) const const
QRect childrenRect () const const
QRegion childrenRegion () const const
void clearFocus ()
void clearMask ()
bool close ()
QMargins contentsMargins () const const
QRect contentsRect () const const
Qt::ContextMenuPolicy contextMenuPolicy () const const
QCursor cursor () const const
void customContextMenuRequested (const QPoint &pos)
WId effectiveWinId () const const
void ensurePolished () const const
Qt::FocusPolicy focusPolicy () const const
QWidgetfocusProxy () const const
QWidgetfocusWidget () const const
const QFontfont () const const
QFontInfo fontInfo () const const
QFontMetrics fontMetrics () const const
QPalette::ColorRole foregroundRole () const const
QRect frameGeometry () const const
QSize frameSize () const const
const QRectgeometry () const const
void getContentsMargins (int *left, int *top, int *right, int *bottom) const const
QPixmap grab (const QRect &rectangle)
void grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)
void grabKeyboard ()
void grabMouse ()
void grabMouse (const QCursor &cursor)
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)
QGraphicsEffectgraphicsEffect () const const
QGraphicsProxyWidgetgraphicsProxyWidget () const const
bool hasEditFocus () const const
bool hasFocus () const const
virtual bool hasHeightForWidth () const const
bool hasMouseTracking () const const
bool hasTabletTracking () const const
int height () const const
virtual int heightForWidth (int w) const const
void hide ()
Qt::InputMethodHints inputMethodHints () const const
void insertAction (QAction *before, QAction *action)
void insertActions (QAction *before, QList< QAction * > actions)
bool isActiveWindow () const const
bool isAncestorOf (const QWidget *child) const const
bool isEnabled () const const
bool isEnabledTo (const QWidget *ancestor) const const
bool isEnabledToTLW () const const
bool isFullScreen () const const
bool isHidden () const const
bool isMaximized () const const
bool isMinimized () const const
bool isModal () const const
bool isTopLevel () const const
bool isVisible () const const
bool isVisibleTo (const QWidget *ancestor) const const
bool isWindow () const const
bool isWindowModified () const const
QLayoutlayout () const const
Qt::LayoutDirection layoutDirection () const const
QLocale locale () const const
void lower ()
QPoint mapFrom (const QWidget *parent, const QPoint &pos) const const
QPoint mapFromGlobal (const QPoint &pos) const const
QPoint mapFromParent (const QPoint &pos) const const
QPoint mapTo (const QWidget *parent, const QPoint &pos) const const
QPoint mapToGlobal (const QPoint &pos) const const
QPoint mapToParent (const QPoint &pos) const const
QRegion mask () const const
int maximumHeight () const const
QSize maximumSize () const const
int maximumWidth () const const
int minimumHeight () const const
QSize minimumSize () const const
int minimumWidth () const const
void move (const QPoint &)
void move (int x, int y)
QWidgetnativeParentWidget () const const
QWidgetnextInFocusChain () const const
QRect normalGeometry () const const
void overrideWindowFlags (Qt::WindowFlags flags)
virtual QPaintEnginepaintEngine () const const override
const QPalettepalette () const const
QWidgetparentWidget () const const
QPoint pos () const const
QWidgetpreviousInFocusChain () const const
void raise ()
QRect rect () const const
void releaseKeyboard ()
void releaseMouse ()
void releaseShortcut (int id)
void removeAction (QAction *action)
void render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
void render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
void repaint ()
void repaint (const QRect &rect)
void repaint (const QRegion &rgn)
void repaint (int x, int y, int w, int h)
void resize (const QSize &)
void resize (int w, int h)
bool restoreGeometry (const QByteArray &geometry)
QByteArray saveGeometry () const const
QScreenscreen () const const
void scroll (int dx, int dy)
void scroll (int dx, int dy, const QRect &r)
void setAcceptDrops (bool on)
void setAccessibleDescription (const QString &description)
void setAccessibleName (const QString &name)
void setAttribute (Qt::WidgetAttribute attribute, bool on)
void setAutoFillBackground (bool enabled)
void setBackgroundRole (QPalette::ColorRole role)
void setBaseSize (const QSize &)
void setBaseSize (int basew, int baseh)
void setContentsMargins (const QMargins &margins)
void setContentsMargins (int left, int top, int right, int bottom)
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
void setCursor (const QCursor &)
void setDisabled (bool disable)
void setEditFocus (bool enable)
void setEnabled (bool)
void setFixedHeight (int h)
void setFixedSize (const QSize &s)
void setFixedSize (int w, int h)
void setFixedWidth (int w)
void setFocus ()
void setFocus (Qt::FocusReason reason)
void setFocusPolicy (Qt::FocusPolicy policy)
void setFocusProxy (QWidget *w)
void setFont (const QFont &)
void setForegroundRole (QPalette::ColorRole role)
void setGeometry (const QRect &)
void setGeometry (int x, int y, int w, int h)
void setGraphicsEffect (QGraphicsEffect *effect)
void setHidden (bool hidden)
void setInputMethodHints (Qt::InputMethodHints hints)
void setLayout (QLayout *layout)
void setLayoutDirection (Qt::LayoutDirection direction)
void setLocale (const QLocale &locale)
void setMask (const QBitmap &bitmap)
void setMask (const QRegion &region)
void setMaximumHeight (int maxh)
void setMaximumSize (const QSize &)
void setMaximumSize (int maxw, int maxh)
void setMaximumWidth (int maxw)
void setMinimumHeight (int minh)
void setMinimumSize (const QSize &)
void setMinimumSize (int minw, int minh)
void setMinimumWidth (int minw)
void setMouseTracking (bool enable)
void setPalette (const QPalette &)
void setParent (QWidget *parent)
void setParent (QWidget *parent, Qt::WindowFlags f)
void setShortcutAutoRepeat (int id, bool enable)
void setShortcutEnabled (int id, bool enable)
void setSizeIncrement (const QSize &)
void setSizeIncrement (int w, int h)
void setSizePolicy (QSizePolicy)
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
void setStatusTip (const QString &)
void setStyle (QStyle *style)
void setStyleSheet (const QString &styleSheet)
void setTabletTracking (bool enable)
void setToolTip (const QString &)
void setToolTipDuration (int msec)
void setUpdatesEnabled (bool enable)
void setupUi (QWidget *widget)
virtual void setVisible (bool visible)
void setWhatsThis (const QString &)
void setWindowFilePath (const QString &filePath)
void setWindowFlag (Qt::WindowType flag, bool on)
void setWindowFlags (Qt::WindowFlags type)
void setWindowIcon (const QIcon &icon)
void setWindowIconText (const QString &)
void setWindowModality (Qt::WindowModality windowModality)
void setWindowModified (bool)
void setWindowOpacity (qreal level)
void setWindowRole (const QString &role)
void setWindowState (Qt::WindowStates windowState)
void setWindowTitle (const QString &)
void show ()
void showFullScreen ()
void showMaximized ()
void showMinimized ()
void showNormal ()
QSize size () const const
QSize sizeIncrement () const const
QSizePolicy sizePolicy () const const
void stackUnder (QWidget *w)
QString statusTip () const const
QStylestyle () const const
QString styleSheet () const const
bool testAttribute (Qt::WidgetAttribute attribute) const const
QString toolTip () const const
int toolTipDuration () const const
QWidgettopLevelWidget () const const
bool underMouse () const const
void ungrabGesture (Qt::GestureType gesture)
void unsetCursor ()
void unsetLayoutDirection ()
void unsetLocale ()
void update ()
void update (const QRect &rect)
void update (const QRegion &rgn)
void update (int x, int y, int w, int h)
void updateGeometry ()
bool updatesEnabled () const const
QRegion visibleRegion () const const
QString whatsThis () const const
int width () const const
QWidgetwindow () const const
QString windowFilePath () const const
Qt::WindowFlags windowFlags () const const
QWindowwindowHandle () const const
QIcon windowIcon () const const
void windowIconChanged (const QIcon &icon)
QString windowIconText () const const
void windowIconTextChanged (const QString &iconText)
Qt::WindowModality windowModality () const const
qreal windowOpacity () const const
QString windowRole () const const
Qt::WindowStates windowState () const const
QString windowTitle () const const
void windowTitleChanged (const QString &title)
Qt::WindowType windowType () const const
WId winId () const const
int x () const const
int y () const const
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
bool blockSignals (bool block)
const QObjectListchildren () const const
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void deleteLater ()
void destroyed (QObject *obj)
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool disconnect (const QObject *receiver, const char *method) const const
void dumpObjectInfo ()
void dumpObjectInfo () const const
void dumpObjectTree ()
void dumpObjectTree () const const
QList< QByteArraydynamicPropertyNames () const const
virtual bool eventFilter (QObject *watched, QEvent *event)
findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
bool inherits (const char *className) const const
void installEventFilter (QObject *filterObj)
bool isWidgetType () const const
bool isWindowType () const const
void killTimer (int id)
virtual const QMetaObjectmetaObject () const const
void moveToThread (QThread *targetThread)
QString objectName () const const
void objectNameChanged (const QString &objectName)
QObjectparent () const const
QVariant property (const char *name) const const
 Q_CLASSINFO (Name, Value)
 Q_ENUM (...)
 Q_ENUM_NS (...)
 Q_ENUMS (...)
 Q_FLAG (...)
 Q_FLAG_NS (...)
 Q_FLAGS (...)
qFindChild (const QObject *obj, const QString &name)
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T > qFindChildren (const QObject *obj, const QString &name)
qobject_cast (const QObject *object)
qobject_cast (QObject *object)
void removeEventFilter (QObject *obj)
void setObjectName (const QString &name)
void setParent (QObject *parent)
bool setProperty (const char *name, const QVariant &value)
bool signalsBlocked () const const
int startTimer (int interval, Qt::TimerType timerType)
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
QThreadthread () const const
- Public Member Functions inherited from QPaintDevice
int colorCount () const const
int depth () const const
int devicePixelRatio () const const
qreal devicePixelRatioF () const const
int height () const const
int heightMM () const const
int logicalDpiX () const const
int logicalDpiY () const const
bool paintingActive () const const
int physicalDpiX () const const
int physicalDpiY () const const
int width () const const
int widthMM () const const
- Public Member Functions inherited from KCompletionBase
 KCompletionBase ()
virtual ~KCompletionBase ()
KCompletion::CompletionMode completionMode () const
KCompletioncompletionObject (bool handleSignals=true)
KCompletioncompObj () const
bool emitSignals () const
QList< QKeySequencegetKeyBinding (KeyBindingType item) const
bool handleSignals () const
bool isCompletionObjectAutoDeleted () const
QList< QKeySequencekeyBinding (KeyBindingType item) const
void setAutoDeleteCompletionObject (bool autoDelete)
virtual void setCompletedItems (const QStringList &items, bool autoSuggest=true)=0
virtual void setCompletedText (const QString &text)=0
virtual void setCompletionMode (KCompletion::CompletionMode mode)
virtual void setCompletionObject (KCompletion *completionObject, bool handleSignals=true)
void setEmitSignals (bool emitRotationSignals)
void setEnableSignals (bool enable)
virtual void setHandleSignals (bool handle)
bool setKeyBinding (KeyBindingType item, const QList< QKeySequence > &key)
void useGlobalKeyBindings ()

Protected Member Functions

void insertItems (const QStringList &items)
void keyPressEvent (QKeyEvent *) override
bool useCompletion () const
void wheelEvent (QWheelEvent *ev) override
- Protected Member Functions inherited from KComboBox
KCOMPLETION_NO_EXPORT KComboBox (KComboBoxPrivate &dd, QWidget *parent)
QSize minimumSizeHint () const override
virtual void setCompletedText (const QString &text, bool marked)
- Protected Member Functions inherited from QComboBox
virtual void changeEvent (QEvent *e) override
virtual void contextMenuEvent (QContextMenuEvent *e) override
virtual void focusInEvent (QFocusEvent *e) override
virtual void focusOutEvent (QFocusEvent *e) override
virtual void hideEvent (QHideEvent *e) override
void initStyleOption (QStyleOptionComboBox *option) const const
virtual void inputMethodEvent (QInputMethodEvent *e) override
virtual void keyReleaseEvent (QKeyEvent *e) override
virtual void mousePressEvent (QMouseEvent *e) override
virtual void mouseReleaseEvent (QMouseEvent *e) override
virtual void paintEvent (QPaintEvent *e) override
virtual void resizeEvent (QResizeEvent *e) override
virtual void showEvent (QShowEvent *e) override
- Protected Member Functions inherited from QWidget
virtual void actionEvent (QActionEvent *event)
virtual void closeEvent (QCloseEvent *event)
void create (WId window, bool initializeWindow, bool destroyOldWindow)
void destroy (bool destroyWindow, bool destroySubWindows)
virtual void dragEnterEvent (QDragEnterEvent *event)
virtual void dragLeaveEvent (QDragLeaveEvent *event)
virtual void dragMoveEvent (QDragMoveEvent *event)
virtual void dropEvent (QDropEvent *event)
virtual void enterEvent (QEvent *event)
bool focusNextChild ()
virtual bool focusNextPrevChild (bool next)
bool focusPreviousChild ()
virtual void initPainter (QPainter *painter) const const override
virtual void leaveEvent (QEvent *event)
virtual int metric (QPaintDevice::PaintDeviceMetric m) const const override
virtual void mouseDoubleClickEvent (QMouseEvent *event)
virtual void mouseMoveEvent (QMouseEvent *event)
virtual void moveEvent (QMoveEvent *event)
virtual bool nativeEvent (const QByteArray &eventType, void *message, long *result)
virtual void tabletEvent (QTabletEvent *event)
void updateMicroFocus ()
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
virtual void connectNotify (const QMetaMethod &signal)
virtual void customEvent (QEvent *event)
virtual void disconnectNotify (const QMetaMethod &signal)
bool isSignalConnected (const QMetaMethod &signal) const const
int receivers (const char *signal) const const
QObjectsender () const const
int senderSignalIndex () const const
virtual void timerEvent (QTimerEvent *event)
- Protected Member Functions inherited from KCompletionBase
KCompletionBasedelegate () const
KeyBindingMap getKeyBindings () const
KeyBindingMap keyBindingMap () const
void setDelegate (KCompletionBase *delegate)
void setKeyBindingMap (KeyBindingMap keyBindingMap)
virtual void virtual_hook (int id, void *data)

Additional Inherited Members

- Public Types inherited from QComboBox
enum  InsertPolicy
enum  SizeAdjustPolicy
- Public Types inherited from QWidget
enum  RenderFlag
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric
- Public Types inherited from KCompletionBase
typedef QMap< KeyBindingType, QList< QKeySequence > > KeyBindingMap
enum  KeyBindingType { TextCompletion, PrevCompletionMatch, NextCompletionMatch, SubstringCompletion }
- Static Public Member Functions inherited from QWidget
QWidgetcreateWindowContainer (QWindow *window, QWidget *parent, Qt::WindowFlags flags)
QWidgetfind (WId id)
QWidgetkeyboardGrabber ()
QWidgetmouseGrabber ()
void setTabOrder (QWidget *first, QWidget *second)
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool disconnect (const QMetaObject::Connection &connection)
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString tr (const char *sourceText, const char *disambiguation, int n)
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
- Public Attributes inherited from QComboBox
- Public Attributes inherited from QWidget
typedef RenderFlags
- Public Attributes inherited from QObject
typedef QObjectList
- Public Attributes inherited from QPaintDevice
- Protected Slots inherited from KComboBox
virtual void makeCompletion (const QString &)

Detailed Description

A combobox for offering a history and completion.

A combobox which implements a history like a unix shell. 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.

KHistoryComboBox obeys the HISTCONTROL environment variable to determine whether duplicates in the history should be tolerated in addToHistory() or not. During construction of KHistoryComboBox, duplicates will be disabled when HISTCONTROL is set to "ignoredups" or "ignoreboth". Otherwise, duplicates are enabled by default.

KHistoryComboBox widget
Carsten Pfeiffer pfeif.nosp@m.fer@.nosp@m.kde.o.nosp@m.rg

Definition at line 42 of file khistorycombobox.h.

Constructor & Destructor Documentation

◆ KHistoryComboBox() [1/2]

KHistoryComboBox::KHistoryComboBox ( QWidget parent = nullptr)

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 NoInsert, you have to add the items yourself via the slot addToHistory. If you want every item added, use

connect( combo, SIGNAL( activated( const QString& )),
combo, SLOT( addToHistory( const QString& )));

Use QComboBox::setMaxCount() to limit the history.

parent the parent object of this widget.

Definition at line 120 of file khistorycombobox.cpp.

◆ KHistoryComboBox() [2/2]

KHistoryComboBox::KHistoryComboBox ( bool  useCompletion,
QWidget parent = nullptr 

Same as the previous constructor, but additionally has the option to specify whether you want to let KHistoryComboBox handle completion or not.

If set to true, KHistoryComboBox will sync the completion to the contents of the combobox.

Definition at line 129 of file khistorycombobox.cpp.

◆ ~KHistoryComboBox()

KHistoryComboBox::~KHistoryComboBox ( )

Destructs the combo, the completion-object and the pixmap-provider.

Definition at line 137 of file khistorycombobox.cpp.

Member Function Documentation

◆ addToHistory

void KHistoryComboBox::addToHistory ( const QString item)

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 item, it will not be inserted again.

If duplicatesEnabled() is false, any equal existing item will be removed before item is added.

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.
See also

Definition at line 222 of file khistorycombobox.cpp.

◆ cleared

void KHistoryComboBox::cleared ( )

Emitted when the history was cleared by the entry in the popup menu.

◆ clearHistory

void KHistoryComboBox::clearHistory ( )

Clears the history and the completion list.

Definition at line 197 of file khistorycombobox.cpp.

◆ historyItems()

QStringList KHistoryComboBox::historyItems ( ) const

Returns the list of history items.

Empty, when this is not a read-write combobox.

See also

◆ insertItems()

void KHistoryComboBox::insertItems ( const QStringList items)

Inserts items into the combo, honoring pixmapProvider() Does not update the completionObject.

duplicatesEnabled() is not honored here.

Called from setHistoryItems() and setPixmapProvider()

Definition at line 448 of file khistorycombobox.cpp.

◆ keyPressEvent()

void KHistoryComboBox::keyPressEvent ( QKeyEvent e)

Handling key-events, the shortcuts to rotate the items.

Reimplemented from QComboBox.

Definition at line 388 of file khistorycombobox.cpp.

◆ pixmapProvider()

KPixmapProvider * KHistoryComboBox::pixmapProvider ( ) const
the current pixmap provider.
See also
since 5.66, unused

Definition at line 511 of file khistorycombobox.cpp.

◆ removeFromHistory()

bool KHistoryComboBox::removeFromHistory ( const QString item)

Removes all items named item.

true if at least one item was removed.
See also

Definition at line 284 of file khistorycombobox.cpp.

◆ reset

void KHistoryComboBox::reset ( )

Resets the current position of the up/down history.

Call this when you manually call setCurrentItem() or clearEdit().

Definition at line 518 of file khistorycombobox.cpp.

◆ setHistoryItems() [1/2]

void KHistoryComboBox::setHistoryItems ( const QStringList items)

Inserts items into the combobox.

items might get truncated if it is longer than maxCount()

See also

Definition at line 145 of file khistorycombobox.cpp.

◆ setHistoryItems() [2/2]

void KHistoryComboBox::setHistoryItems ( const QStringList items,
bool  setCompletionList 

Inserts items into the combobox.

items might get truncated if it is longer than maxCount()

Set setCompletionList to true, if you don't have a list of completions. This tells KHistoryComboBox to use all the items for the completion object as well. You won't have the benefit of weighted completion though, so normally you should do something like

// load the history and completion list after creating the history combo
list = config.readEntry("Completion list", QStringList());
list = config.readEntry("History list", QStringList());
// save the history and completion list when the history combo is
// destroyed
list = combo->completionObject()->items();
config.writeEntry("Completion list", list);
list = combo->historyItems();
config.writeEntry("History list", list);

Be sure to use different names for saving with KConfig if you have more than one KHistoryComboBox.

When setCompletionList is true, the items are inserted into the KCompletion object with mode KCompletion::Insertion and the mode is set to KCompletion::Weighted afterwards.
See also

Definition at line 150 of file khistorycombobox.cpp.

◆ setIconProvider()

void KHistoryComboBox::setIconProvider ( std::function< QIcon(const QString &)>  providerFunction)

Sets an icon provider, so that items in the combobox can have an icon.

The provider is a function that takes a QString and returns a QIcon


Definition at line 442 of file khistorycombobox.cpp.

◆ setPixmapProvider()

void KHistoryComboBox::setPixmapProvider ( KPixmapProvider provider)

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 KHistoryComboBoxBox. Implement it to return your own custom pixmaps, or use the KUrlPixmapProvider from KIO, which uses KMimeType::pixmapForUrl to resolve icons.

Set provider to nullptr if you want to disable pixmaps. Default no pixmaps.

See also
since 5.66, use setIconProvider

Definition at line 421 of file khistorycombobox.cpp.

◆ useCompletion()

bool KHistoryComboBox::useCompletion ( ) const
if we can modify the completion object or not.

Definition at line 192 of file khistorycombobox.cpp.

◆ wheelEvent()

void KHistoryComboBox::wheelEvent ( QWheelEvent ev)

Handling wheel-events, to rotate the items.

Reimplemented from QComboBox.

Definition at line 402 of file khistorycombobox.cpp.

The documentation for this class was generated from the following files:
void addToHistory(const QString &item)
Adds an item to the end of the history list and to the completion list.
virtual void setItems(const QStringList &itemList)
Sets the list of items available for completion.
KIOFILEWIDGETS_EXPORT QStringList list(const QString &fileClass)
QMetaObject::Connection connect(const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
static KSharedConfig::Ptr openConfig(const QString &fileName=QString(), OpenFlags mode=FullConfig, QStandardPaths::StandardLocation type=QStandardPaths::GenericConfigLocation)
KSharedConfigPtr config()
KCompletion * completionObject(bool handleSignals=true)
Returns a pointer to the current completion object.
void activated(int index)
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Dec 11 2023 04:10:21 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.