KCompletion

View on LXR

#include <KComboBox>

Inheritance diagram for KComboBox:

[legend]

Properties
bool	autoCompletion

bool	trapReturnKey

Properties inherited from QComboBox
	autoCompletion

	autoCompletionCaseSensitivity

	count

	currentData

	currentIndex

	currentText

	duplicatesEnabled

	editable

	frame

	iconSize

	insertPolicy

	maxCount

	maxVisibleItems

	minimumContentsLength

	modelColumn

	sizeAdjustPolicy

Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	toolTip

	toolTipDuration

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

Signals
void	aboutToShowContextMenu (QMenu *contextMenu)

void	completion (const QString &)

void	completionModeChanged (KCompletion::CompletionMode)

void	returnPressed ()

void	returnPressed (const QString &)

void	substringCompletion (const QString &)

void	textRotation (KCompletionBase::KeyBindingType)

Public Slots
void	rotateText (KCompletionBase::KeyBindingType type)

void	setCompletedItems (const QStringList &items, bool autosubject=true) override

void	setCompletedText (const QString &) override

void	setCurrentItem (const QString &item, bool insert=false, int index=-1)

Public Member Functions
	KComboBox (QWidget *parent=nullptr)

	KComboBox (bool rw, QWidget *parent=nullptr)

	~KComboBox () override

void	addUrl (const QUrl &url)

void	addUrl (const QIcon &icon, const QUrl &url)

bool	autoCompletion () const

void	changeUrl (int index, const QUrl &url)

void	changeUrl (int index, const QIcon &icon, const QUrl &url)

KCompletionBox *	completionBox (bool create=true)

bool	contains (const QString &text) const

int	cursorPosition () const

void	insertUrl (int index, const QUrl &url)

void	insertUrl (int index, const QIcon &icon, const QUrl &url)

virtual void	setAutoCompletion (bool autocomplete)

void	setEditable (bool editable)

void	setEditUrl (const QUrl &url)

virtual void	setLineEdit (QLineEdit *)

void	setTrapReturnKey (bool trap)

bool	trapReturnKey () const

bool	urlDropsEnabled () const

Public Member Functions inherited from QComboBox
	QComboBox (QWidget *parent)

void	activated (int index)

void	activated (const QString &text)

void	addItem (const QString &text, const QVariant &userData)

void	addItem (const QIcon &icon, const QString &text, const QVariant &userData)

void	addItems (const QStringList &texts)

bool	autoCompletion () const

Qt::CaseSensitivity	autoCompletionCaseSensitivity () const

void	clear ()

void	clearEditText ()

QCompleter *	completer () const

int	count () const

QVariant	currentData (int role) const

int	currentIndex () const

void	currentIndexChanged (int index)

void	currentIndexChanged (const QString &text)

QString	currentText () const

void	currentTextChanged (const QString &text)

bool	duplicatesEnabled () const

void	editTextChanged (const QString &text)

virtual bool	event (QEvent *event)

int	findData (const QVariant &data, int role, Qt::MatchFlags flags) const

int	findText (const QString &text, Qt::MatchFlags flags) const

bool	hasFrame () const

virtual void	hidePopup ()

void	highlighted (const QString &text)

void	highlighted (int index)

QSize	iconSize () const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

void	insertItem (int index, const QString &text, const QVariant &userData)

void	insertItem (int index, const QIcon &icon, const QString &text, const QVariant &userData)

void	insertItems (int index, const QStringList &list)

InsertPolicy	insertPolicy () const

void	insertSeparator (int index)

bool	isEditable () const

QVariant	itemData (int index, int role) const

QAbstractItemDelegate *	itemDelegate () const

QIcon	itemIcon (int index) const

QString	itemText (int index) const

QLineEdit *	lineEdit () const

int	maxCount () const

int	maxVisibleItems () const

int	minimumContentsLength () const

QAbstractItemModel *	model () const

int	modelColumn () const

void	removeItem (int index)

QModelIndex	rootModelIndex () 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 (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	setRootModelIndex (const QModelIndex &index)

void	setSizeAdjustPolicy (SizeAdjustPolicy policy)

void	setValidator (const QValidator *validator)

void	setView (QAbstractItemView *itemView)

virtual void	showPopup ()

SizeAdjustPolicy	sizeAdjustPolicy () const

virtual QSize	sizeHint () const

const QValidator *	validator () const

QAbstractItemView *	view () const

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, Qt::WindowFlags f)

bool	acceptDrops () const

QString	accessibleDescription () const

QString	accessibleName () const

QList< QAction * >	actions () const

void	activateWindow ()

void	addAction (QAction *action)

void	addActions (QList< QAction * > actions)

void	adjustSize ()

bool	autoFillBackground () const

QPalette::ColorRole	backgroundRole () const

QBackingStore *	backingStore () const

QSize	baseSize () const

QWidget *	childAt (int x, int y) const

QWidget *	childAt (const QPoint &p) const

QRect	childrenRect () const

QRegion	childrenRegion () const

void	clearFocus ()

void	clearMask ()

bool	close ()

QMargins	contentsMargins () const

QRect	contentsRect () const

Qt::ContextMenuPolicy	contextMenuPolicy () const

QCursor	cursor () const

void	customContextMenuRequested (const QPoint &pos)

WId	effectiveWinId () const

void	ensurePolished () const

Qt::FocusPolicy	focusPolicy () const

QWidget *	focusProxy () const

QWidget *	focusWidget () const

const QFont &	font () const

QFontInfo	fontInfo () const

QFontMetrics	fontMetrics () const

QPalette::ColorRole	foregroundRole () const

QRect	frameGeometry () const

QSize	frameSize () const

const QRect &	geometry () const

void	getContentsMargins (int left, int top, int right, int bottom) 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)

QGraphicsEffect *	graphicsEffect () const

QGraphicsProxyWidget *	graphicsProxyWidget () const

bool	hasEditFocus () const

bool	hasFocus () const

virtual bool	hasHeightForWidth () const

bool	hasMouseTracking () const

int	height () const

virtual int	heightForWidth (int w) const

void	hide ()

Qt::InputMethodHints	inputMethodHints () const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, QList< QAction > actions)

bool	isActiveWindow () const

bool	isAncestorOf (const QWidget *child) const

bool	isEnabled () const

bool	isEnabledTo (const QWidget *ancestor) const

bool	isEnabledToTLW () const

bool	isFullScreen () const

bool	isHidden () const

bool	isMaximized () const

bool	isMinimized () const

bool	isModal () const

bool	isTopLevel () const

bool	isVisible () const

bool	isVisibleTo (const QWidget *ancestor) const

bool	isWindow () const

bool	isWindowModified () const

QLayout *	layout () const

Qt::LayoutDirection	layoutDirection () const

QLocale	locale () const

void	lower ()

Qt::HANDLE	macCGHandle () const

Qt::HANDLE	macQDHandle () const

QPoint	mapFrom (const QWidget *parent, const QPoint &pos) const

QPoint	mapFromGlobal (const QPoint &pos) const

QPoint	mapFromParent (const QPoint &pos) const

QPoint	mapTo (const QWidget *parent, const QPoint &pos) const

QPoint	mapToGlobal (const QPoint &pos) const

QPoint	mapToParent (const QPoint &pos) const

QRegion	mask () const

int	maximumHeight () const

QSize	maximumSize () const

int	maximumWidth () const

int	minimumHeight () const

QSize	minimumSize () const

int	minimumWidth () const

void	move (int x, int y)

void	move (const QPoint &)

QWidget *	nativeParentWidget () const

QWidget *	nextInFocusChain () const

QRect	normalGeometry () const

void	overrideWindowFlags (Qt::WindowFlags flags)

virtual QPaintEngine *	paintEngine () const

const QPalette &	palette () const

QWidget *	parentWidget () const

QPoint	pos () const

QWidget *	previousInFocusChain () const

void	raise ()

QRect	rect () const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	repaint ()

void	repaint (int x, int y, int w, int h)

void	repaint (const QRect &rect)

void	repaint (const QRegion &rgn)

void	resize (int w, int h)

void	resize (const QSize &)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () 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 (int basew, int baseh)

void	setBaseSize (const QSize &)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContentsMargins (const QMargins &margins)

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 (Qt::FocusReason reason)

void	setFocus ()

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, Qt::WindowFlags f)

void	setParent (QWidget *parent)

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::Policy horizontal, QSizePolicy::Policy vertical)

void	setSizePolicy (QSizePolicy)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

void	setStyleSheet (const QString &styleSheet)

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	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

QSize	sizeIncrement () const

QSizePolicy	sizePolicy () const

void	stackUnder (QWidget *w)

QString	statusTip () const

QStyle *	style () const

QString	styleSheet () const

bool	testAttribute (Qt::WidgetAttribute attribute) const

QString	toolTip () const

int	toolTipDuration () const

QWidget *	topLevelWidget () const

bool	underMouse () const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	update ()

void	updateGeometry ()

bool	updatesEnabled () const

QRegion	visibleRegion () const

QString	whatsThis () const

int	width () const

QWidget *	window () const

QString	windowFilePath () const

Qt::WindowFlags	windowFlags () const

QWindow *	windowHandle () const

QIcon	windowIcon () const

void	windowIconChanged (const QIcon &icon)

QString	windowIconText () const

void	windowIconTextChanged (const QString &iconText)

Qt::WindowModality	windowModality () const

qreal	windowOpacity () const

QString	windowRole () const

Qt::WindowStates	windowState () const

QString	windowTitle () const

void	windowTitleChanged (const QString &title)

Qt::WindowType	windowType () const

WId	winId () const

int	x () const

const QX11Info &	x11Info () const

Qt::HANDLE	x11PictureHandle () const

int	y () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const

bool	disconnect (const QObject receiver, const char method) const

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const

bool	inherits (const char *className) const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const

bool	isWindowType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

QString	objectName () const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const

QVariant	property (const char *name) const

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval, Qt::TimerType timerType)

QThread *	thread () const

Public Member Functions inherited from QPaintDevice
int	colorCount () const

int	depth () const

int	devicePixelRatio () const

int	height () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

virtual QPaintEngine *	paintEngine () const =0

bool	paintingActive () const

int	physicalDpiX () const

int	physicalDpiY () const

int	width () const

int	widthMM () const

Public Member Functions inherited from KCompletionBase
	KCompletionBase ()

virtual	~KCompletionBase ()

KCompletion::CompletionMode	completionMode () const

KCompletion *	completionObject (bool handleSignals=true)

KCompletion *	compObj () const

bool	emitSignals () const

bool	handleSignals () const

bool	isCompletionObjectAutoDeleted () const

QList< QKeySequence >	keyBinding (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 Slots
virtual void	makeCompletion (const QString &)

Protected Member Functions
QSize	minimumSizeHint () const override

virtual void	setCompletedText (const QString &text, bool marked)

Protected Member Functions inherited from QComboBox
virtual void	changeEvent (QEvent *e)

virtual void	contextMenuEvent (QContextMenuEvent *e)

virtual void	focusInEvent (QFocusEvent *e)

virtual void	focusOutEvent (QFocusEvent *e)

virtual void	hideEvent (QHideEvent *e)

void	initStyleOption (QStyleOptionComboBox *option) const

virtual void	inputMethodEvent (QInputMethodEvent *e)

virtual void	keyPressEvent (QKeyEvent *e)

virtual void	keyReleaseEvent (QKeyEvent *e)

virtual void	mousePressEvent (QMouseEvent *e)

virtual void	mouseReleaseEvent (QMouseEvent *e)

virtual void	paintEvent (QPaintEvent *e)

virtual void	resizeEvent (QResizeEvent *e)

virtual void	showEvent (QShowEvent *e)

virtual void	wheelEvent (QWheelEvent *e)

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

virtual void	leaveEvent (QEvent *event)

virtual int	metric (PaintDeviceMetric m) const

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 QPaintDevice *	redirected (QPoint *offset) const

virtual QPainter *	sharedPainter () const

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

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Protected Member Functions inherited from KCompletionBase
KCompletionBase *	delegate () 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 KCompletionBase
typedef QMap< KeyBindingType, QList< QKeySequence > >	KeyBindingMap

enum	KeyBindingType { TextCompletion, PrevCompletionMatch, NextCompletionMatch, SubstringCompletion }

Static Public Member Functions inherited from QWidget
QWidget *	createWindowContainer (QWindow window, QWidget parent, Qt::WindowFlags flags)

QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

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 receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

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, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &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 QWidget
typedef	RenderFlags

Detailed Description

A combo box with completion support.

This widget inherits from QComboBox and implements the following additional features:

a completion object that provides both automatic and manual text completion as well as text rotation
configurable key bindings to activate these features
a popup menu item that can be used to allow the user to change the text completion mode on the fly.

To support these new features, KComboBox emits a few additional signals such as completion(const QString&) and textRotation(KeyBindingType). The completion signal can be connected to a slot that will assist the user in filling out the remaining text while the rotation signal can be used to traverse through all possible matches whenever text completion results in multiple matches. Additionally, the returnPressed() and returnPressed(const QString&) signals are emitted when the user presses the Enter/Return key.

KCombobox by default creates a completion object when you invoke the completionObject(bool) member function for the first time or explicitly use setCompletionObject(KCompletion*, bool) to assign your own completion object. Additionally, to make this widget more functional, KComboBox will by default handle text rotation and completion events internally whenever a completion object is created through either one of the methods mentioned above. If you do not need this functionality, simply use KCompletionBase::setHandleSignals(bool) or alternatively set the boolean parameter in the setCompletionObject call to false.

Beware: The completion object can be deleted on you, especially if a call such as setEditable(false) is made. Store the pointer at your own risk, and consider using QPointer<KCompletion>.

The default key bindings for completion and rotation are determined from the global settings in KStandardShortcut. These values, however, can be overridden locally by invoking KCompletionBase::setKeyBinding(). The values can easily be reverted back to the default settings by calling useGlobalSettings(). An alternate method would be to default individual key bindings by using setKeyBinding() with the default second argument.

A non-editable combo box only has one completion mode, CompletionAuto. Unlike an editable combo box, the CompletionAuto mode works by matching any typed key with the first letter of entries in the combo box. Please note that if you call setEditable(false) to change an editable combo box to a non-editable one, the text completion object associated with the combo box will no longer exist unless you created the completion object yourself and assigned it to this widget or you called setAutoDeleteCompletionObject(false). In other words do not do the following:

KComboBox* combo = new KComboBox(true, this);
KCompletion* comp = combo->completionObject();
combo->setEditable(false);
comp->clear(); // CRASH: completion object does not exist anymore.

A read-only KComboBox will have the same background color as a disabled KComboBox, but its foreground color will be the one used for the editable mode. This differs from QComboBox's implementation and is done to give visual distinction between the three different modes: disabled, read-only, and editable.

Usage
To enable the basic completion feature:

KComboBox *combo = new KComboBox(true, this);
KCompletion *comp = combo->completionObject();
// Connect to the return pressed signal - optional
connect(combo,SIGNAL(returnPressed(const QString&)),comp,SLOT(addItem(const QString&)));
// Provide the to be completed strings. Note that those are separate from the combo's
// contents.
comp->insertItems(someQStringList);

To use your own completion object:

KComboBox *combo = new KComboBox(this);
KUrlCompletion *comp = new KUrlCompletion();
combo->setCompletionObject(comp);
// Connect to the return pressed signal - optional
connect(combo,SIGNAL(returnPressed(const QString&)),comp,SLOT(addItem(const QString&)));

Note that you have to either delete the allocated completion object when you don't need it anymore, or call setAutoDeleteCompletionObject(true);

Miscellaneous function calls:

// Tell the widget not to handle completion and rotation
combo->setHandleSignals(false);
// Set your own completion key for manual completions.
combo->setKeyBinding(KCompletionBase::TextCompletion, Qt::End);

KComboBox widgets, one non-editable, one editable with KUrlCompletion

Author: Dawit Alemayehu adawi[email protected][email protected][email protected]e.org

Definition at line 145 of file kcombobox.h.

Constructor & Destructor Documentation

KComboBox::KComboBox ( QWidget * parent = nullptr )

explicit

Constructs a read-only (or rather select-only) combo box.

Parameters

parent The parent object of this widget

Definition at line 76 of file kcombobox.cpp.

KComboBox::KComboBox	(	bool	rw,
		QWidget *	parent = `nullptr`
	)

explicit

Constructs an editable or read-only combo box.

Parameters

rw	When `true`, widget will be editable.
parent	The parent object of this widget.

Definition at line 84 of file kcombobox.cpp.

KComboBox::~KComboBox ( )

override

Destructor.

Definition at line 93 of file kcombobox.cpp.

Member Function Documentation

void KComboBox::aboutToShowContextMenu ( QMenu * contextMenu )

signal

Emitted before the context menu is displayed.

The signal allows you to add your own entries into the context menu. Note that you must not store the pointer to the QPopupMenu since it is created and deleted on demand. Otherwise, you can crash your app.

Parameters

contextMenu the context menu about to be displayed

void KComboBox::addUrl ( const QUrl & url )

Appends url to the combo box.

QUrl::toDisplayString() is used so that the url is properly decoded for displaying.

Definition at line 225 of file kcombobox.cpp.

void KComboBox::addUrl	(	const QIcon &	icon,
		const QUrl &	url
	)

Appends url with the icon to the combo box.

QUrl::toDisplayString() is used so that the url is properly decoded for displaying.

Definition at line 230 of file kcombobox.cpp.

bool KComboBox::autoCompletion ( ) const

Reimplemented from QComboBox.

Returns true if the current completion mode is set to automatic. See its more comprehensive replacement completionMode().

Returns: true when completion mode is automatic.

void KComboBox::changeUrl	(	int	index,
		const QUrl &	url
	)

Replaces the item at position index with url.

QUrl::toDisplayString() is used so that the url is properly decoded for displaying.

Definition at line 245 of file kcombobox.cpp.

void KComboBox::changeUrl	(	int	index,
		const QIcon &	icon,
		const QUrl &	url
	)

Replaces the item at position index with url and icon.

QUrl::toDisplayString() is used so that the url is properly decoded for displaying.

Definition at line 250 of file kcombobox.cpp.

void KComboBox::completion ( const QString & )

signal

Emitted when the completion key is pressed.

The argument is the current text being edited.

Note that this signal is not available when the widget is non-editable or the completion mode is set to CompletionNone.

KCompletionBox * KComboBox::completionBox ( bool create = true )

Returns: the completion box that is used in completion mode CompletionPopup and CompletionPopupAuto.

This method will create a completion box by calling KLineEdit::completionBox, if none is there yet.

Parameters

create Set this to false if you don't want the box to be created i.e. to test if it is available.

Definition at line 264 of file kcombobox.cpp.

void KComboBox::completionModeChanged ( KCompletion::CompletionMode )

signal

Emitted whenever the completion mode is changed by the user through the context menu.

bool KComboBox::contains ( const QString & text ) const

Convenience method which iterates over all items and checks if any of them is equal to text.

If text is an empty string, false is returned.

Returns: true if an item with the string text is in the combo box.

Definition at line 97 of file kcombobox.cpp.

int KComboBox::cursorPosition ( ) const

Returns the current cursor position.

This method always returns a -1 if the combo box is not editable (read-only).

Returns: Current cursor position.

Definition at line 112 of file kcombobox.cpp.

void KComboBox::insertUrl	(	int	index,
		const QUrl &	url
	)

Inserts url at position index into the combo box.

QUrl::toDisplayString() is used so that the url is properly decoded for displaying.

Definition at line 235 of file kcombobox.cpp.

void KComboBox::insertUrl	(	int	index,
		const QIcon &	icon,
		const QUrl &	url
	)

Inserts url with the icon at position index into the combo box.

QUrl::toDisplayString() is used so that the url is properly decoded for displaying.

Definition at line 240 of file kcombobox.cpp.

void KComboBox::makeCompletion ( const QString & text )

protectedvirtualslot

Completes text according to the completion mode.

Note: this method is not invoked if the completion mode is set to CompletionNone. Also if the mode is set to CompletionShell and multiple matches are found, this method will complete the text to the first match with a beep to indicate that there are more matches. Then any successive completion key event iterates through the remaining matches. This way the rotation functionality is left to iterate through the list as usual.

Definition at line 178 of file kcombobox.cpp.

void KComboBox::returnPressed ( )

signal

Emitted when the user presses the Enter key.

Note that this signal is only emitted when the widget is editable.

void KComboBox::returnPressed ( const QString & )

signal

Emitted when the user presses the Enter key.

The argument is the current text being edited. This signal is just like returnPressed() except that it contains the current text as its argument.

Note that this signal is only emitted when the widget is editable.

void KComboBox::rotateText ( KCompletionBase::KeyBindingType type )

slot

Iterates through all possible matches of the completed text or the history list.

Depending on the value of the argument, this function either iterates through the history list of this widget or all the possible matches in whenever multiple matches result from a text completion request. Note that the all-possible-match iteration will not work if there are no previous matches, i.e. no text has been completed and the *nix shell history list rotation is only available if the insertion policy for this widget is set either QComobBox::AtTop or QComboBox::AtBottom. For other insertion modes whatever has been typed by the user when the rotation event was initiated will be lost.

Parameters

type	The key binding invoked.

Definition at line 194 of file kcombobox.cpp.

void KComboBox::setAutoCompletion ( bool autocomplete )

virtual

Reimplemented from QComboBox.

If true, the completion mode will be set to automatic. Otherwise, it is defaulted to the global setting. This method has been replaced by the more comprehensive setCompletionMode().

Parameters

autocomplete Flag to enable/disable automatic completion mode.

Definition at line 117 of file kcombobox.cpp.

void KComboBox::setCompletedItems	(	const QStringList &	items,
		bool	autosubject = `true`
	)

overrideslot

Sets items into the completion box if completionMode() is CompletionPopup.

The popup will be shown immediately.

Definition at line 256 of file kcombobox.cpp.

void KComboBox::setCompletedText ( const QString & text )

overrideslot

Sets the completed text in the line edit appropriately.

This function is an implementation for KCompletionBase::setCompletedText.

Definition at line 170 of file kcombobox.cpp.

void KComboBox::setCompletedText	(	const QString &	text,
		bool	marked
	)

protectedvirtual

This function sets the line edit text and highlights the text appropriately if the boolean value is set to true.

Parameters

text	The text to be set in the line edit
marked	Whether the text inserted should be highlighted

Definition at line 162 of file kcombobox.cpp.

void KComboBox::setCurrentItem	(	const QString &	item,
		bool	insert = `false`,
		int	index = `-1`
	)

slot

Selects the first item that matches item.

If there is no such item, it is inserted at position index if insert is true. Otherwise, no item is selected.

Definition at line 368 of file kcombobox.cpp.

void KComboBox::setEditable ( bool editable )

Reimplemented so that setEditable(true) creates a KLineEdit instead of QLineEdit.

Note that QComboBox::setEditable is not virtual, so do not use a KComboBox in a QComboBox pointer.

Definition at line 392 of file kcombobox.cpp.

void KComboBox::setEditUrl ( const QUrl & url )

Sets url into the edit field of the combo box.

It uses QUrl::toDisplayString() so that the url is properly decoded for displaying.

Definition at line 220 of file kcombobox.cpp.

void KComboBox::setLineEdit ( QLineEdit * edit )

virtual

Reimplemented for internal reasons.

API remains unaffected. Note that QComboBox::setLineEdit is not virtual in Qt4, do not use a KComboBox in a QComboBox pointer.

NOTE: Only editable combo boxes can have a line editor. As such any attempt to assign a line edit to a non-editable combo box will simply be ignored.

Definition at line 290 of file kcombobox.cpp.

void KComboBox::setTrapReturnKey ( bool trap )

By default, KComboBox recognizes Key_Return and Key_Enter and emits the returnPressed() signals, but it also lets the event pass, for example causing a dialog's default button to be called.

Call this method with trap equal to true to make KComboBox stop these events. The signals will still be emitted of course.

Only affects editable combo boxes.

See also: setTrapReturnKey()

Definition at line 202 of file kcombobox.cpp.

void KComboBox::substringCompletion ( const QString & )

signal

Emitted when the shortcut for substring completion is pressed.

void KComboBox::textRotation ( KCompletionBase::KeyBindingType )

signal

Emitted when the text rotation key bindings are pressed.

The argument indicates which key binding was pressed. In this case this can be either one of four values: PrevCompletionMatch, NextCompletionMatch, RotateUp or RotateDown.

Note that this signal is not emitted if the completion mode is set to CompletionNone.

See also: KCompletionBase::setKeyBinding() for details

bool KComboBox::trapReturnKey ( ) const

Returns: true if key events of Key_Return or Key_Enter will be stopped; false if they will be propagated.

See also: setTrapReturnKey ()

bool KComboBox::urlDropsEnabled ( ) const

Returns true when decoded URL drops are enabled.

Definition at line 156 of file kcombobox.cpp.

The documentation for this class was generated from the following files:

KDE's Doxygen guidelines are available online.

Quick Links

Class Picker

About

Properties

Signals

Public Slots

Public Member Functions

Protected Slots

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation