KActionSelector

#include <KActionSelector>

Inheritance diagram for KActionSelector:

[legend]

Public Types
enum	InsertionPolicy { BelowCurrent , Sorted , AtTop , AtBottom }

enum	MoveButton { ButtonAdd , ButtonRemove , ButtonUp , ButtonDown }

Public Types inherited from QWidget
enum	RenderFlag

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric

Properties
InsertionPolicy	availableInsertionPolicy

QString	availableLabel

bool	keyboardEnabled

bool	moveOnDoubleClick

InsertionPolicy	selectedInsertionPolicy

QString	selectedLabel

bool	showUpDownButtons

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

	tabletTracking

	toolTip

	toolTipDuration

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

Signals
void	added (QListWidgetItem *item)

void	movedDown (QListWidgetItem *item)

void	movedUp (QListWidgetItem *item)

void	removed (QListWidgetItem *item)

Public Slots
void	setButtonsEnabled ()

Public Member Functions
	KActionSelector (QWidget *parent=nullptr)

InsertionPolicy	availableInsertionPolicy () const

QString	availableLabel () const

QListWidget *	availableListWidget () const

bool	keyboardEnabled () const

bool	moveOnDoubleClick () const

InsertionPolicy	selectedInsertionPolicy () const

QString	selectedLabel () const

QListWidget *	selectedListWidget () const

void	setAvailableInsertionPolicy (InsertionPolicy policy)

void	setAvailableLabel (const QString &text)

void	setButtonIcon (const QString &icon, MoveButton button)

void	setButtonIconSet (const QIcon &iconset, MoveButton button)

void	setButtonTooltip (const QString &tip, MoveButton button)

void	setButtonWhatsThis (const QString &text, MoveButton button)

void	setKeyboardEnabled (bool enable)

void	setMoveOnDoubleClick (bool enable)

void	setSelectedInsertionPolicy (InsertionPolicy policy)

void	setSelectedLabel (const QString &text)

void	setShowUpDownButtons (bool show)

bool	showUpDownButtons () 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 ()

QAction *	addAction (const QIcon &icon, const QString &text)

QAction *	addAction (const QIcon &icon, const QString &text, Args &&... args)

QAction *	addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut)

QAction *	addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, Args &&... args)

QAction *	addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, const QObject receiver, const char member, Qt::ConnectionType type)

QAction *	addAction (const QIcon &icon, const QString &text, const QObject receiver, const char member, Qt::ConnectionType type)

QAction *	addAction (const QString &text)

QAction *	addAction (const QString &text, Args &&... args)

QAction *	addAction (const QString &text, const QKeySequence &shortcut)

QAction *	addAction (const QString &text, const QKeySequence &shortcut, Args &&... args)

QAction *	addAction (const QString &text, const QKeySequence &shortcut, const QObject receiver, const char member, Qt::ConnectionType type)

QAction *	addAction (const QString &text, const QObject receiver, const char member, Qt::ConnectionType type)

void	addAction (QAction *action)

void	addActions (const QList< QAction * > &actions)

void	adjustSize ()

bool	autoFillBackground () const const

QPalette::ColorRole	backgroundRole () const const

QBackingStore *	backingStore () const const

QSize	baseSize () const const

QWidget *	childAt (const QPoint &p) const const

QWidget *	childAt (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

QWidget *	focusProxy () const const

QWidget *	focusWidget () const const

const QFont &	font () const const

QFontInfo	fontInfo () const const

QFontMetrics	fontMetrics () const const

QPalette::ColorRole	foregroundRole () const const

QRect	frameGeometry () const const

QSize	frameSize () const const

const QRect &	geometry () 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)

QGraphicsEffect *	graphicsEffect () const const

QGraphicsProxyWidget *	graphicsProxyWidget () 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

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, const 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	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

QLayout *	layout () const const

Qt::LayoutDirection	layoutDirection () const const

QLocale	locale () const const

void	lower ()

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

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

QPoint	mapFromGlobal (const QPoint &pos) const const

QPointF	mapFromGlobal (const QPointF &pos) const const

QPoint	mapFromParent (const QPoint &pos) const const

QPointF	mapFromParent (const QPointF &pos) const const

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

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

QPoint	mapToGlobal (const QPoint &pos) const const

QPointF	mapToGlobal (const QPointF &pos) const const

QPoint	mapToParent (const QPoint &pos) const const

QPointF	mapToParent (const QPointF &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

virtual QSize	minimumSizeHint () const const

int	minimumWidth () const const

void	move (const QPoint &)

void	move (int x, int y)

QWidget *	nativeParentWidget () const const

QWidget *	nextInFocusChain () const const

QRect	normalGeometry () const const

void	overrideWindowFlags (Qt::WindowFlags flags)

virtual QPaintEngine *	paintEngine () const const override

const QPalette &	palette () const const

QWidget *	parentWidget () const const

QPoint	pos () const const

QWidget *	previousInFocusChain () const const

	QWIDGETSIZE_MAX QWIDGETSIZE_MAX

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, RenderFlags renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, 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

QScreen *	screen () 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	setScreen (QScreen *screen)

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

virtual QSize	sizeHint () const const

QSize	sizeIncrement () const const

QSizePolicy	sizePolicy () const const

void	stackUnder (QWidget *w)

QString	statusTip () const const

QStyle *	style () const const

QString	styleSheet () const const

bool	testAttribute (Qt::WidgetAttribute attribute) const const

QString	toolTip () const const

int	toolTipDuration () const const

QWidget *	topLevelWidget () 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

QWidget *	window () const const

QString	windowFilePath () const const

Qt::WindowFlags	windowFlags () const const

QWindow *	windowHandle () 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)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () 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 () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

T	findChild (const QString &name, 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

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

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

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

bool	signalsBlocked () const const

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

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Public Member Functions inherited from QPaintDevice
int	colorCount () const const

int	depth () const const

qreal	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

Protected Member Functions
bool	eventFilter (QObject , QEvent ) override

void	keyPressEvent (QKeyEvent *) override

Protected Member Functions inherited from QWidget
virtual void	actionEvent (QActionEvent *event)

virtual void	changeEvent (QEvent *event)

virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *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 (QEnterEvent *event)

virtual bool	event (QEvent *event) override

virtual void	focusInEvent (QFocusEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	initPainter (QPainter *painter) const const override

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	leaveEvent (QEvent *event)

virtual int	metric (PaintDeviceMetric m) const const override

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual bool	nativeEvent (const QByteArray &eventType, void message, qintptr result)

virtual void	paintEvent (QPaintEvent *event)

virtual void	resizeEvent (QResizeEvent *event)

virtual void	showEvent (QShowEvent *event)

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus (Qt::InputMethodQuery query)

virtual void	wheelEvent (QWheelEvent *event)

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

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
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)

void	setTabOrder (std::initializer_list< QWidget * > widgets)

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)

Public Attributes inherited from QWidget
	DrawChildren

	DrawWindowBackground

	IgnoreMask

typedef	RenderFlags

Public Attributes inherited from QObject
typedef	QObjectList

Public Attributes inherited from QPaintDevice
	PdmDepth

	PdmDevicePixelRatio

	PdmDevicePixelRatioScaled

	PdmDpiX

	PdmDpiY

	PdmHeight

	PdmHeightMM

	PdmNumColors

	PdmPhysicalDpiX

	PdmPhysicalDpiY

	PdmWidth

	PdmWidthMM

Detailed Description

A widget for selecting and arranging actions/objects.

This widget allows the user to select from a set of objects and arrange the order of the selected ones using two list boxes labeled "Available" and "Used" with horizontal arrows in between to move selected objects between the two, and vertical arrows on the right to arrange the order of the selected objects.

The widget moves objects to the other listbox when doubleclicked if the property moveOnDoubleClick is set to true (default). See moveOnDoubleClick() and setMoveOnDoubleClick().

The user control the widget using the keyboard if enabled (default), see keyboardEnabled.

Note that this may conflict with keyboard selection in the selected list box, if you set that to anything else than QListWidget::Single (which is the default).

To use it, simply construct an instance and then add items to the two listboxes, available through lbAvailable() and lbSelected(). Whenever you want, you can retrieve the selected options using QListWidget methods on lbSelected().

This way, you can use your own QListWidgetItem class, allowing you to easily store object data in those.

When an item is moved to a listbox, it is placed below the current item of that listbox.

Standard arrow icons are used, but you can use icons of your own choice if desired, see setButtonIcon(). It is also possible to set tooltips and whatsthis help for the buttons. See setButtonTooltip() and setButtonWhatsThis().

To set whatsthis or tooltips for the listboxes, access them through availableListWidget() and selectedListWidget().

All the moving buttons are automatically set enabled as expected.

Signals are sent each time an item is moved, allowing you to follow the users actions if you need to. See addedToSelection(), removedFromSelection(), movedUp() and movedDown()

KActionSelector Widget

Author: Anders Lund ander.nosp@m.s@al.nosp@m.web.d.nosp@m.k

Definition at line 69 of file kactionselector.h.

Member Enumeration Documentation

◆ InsertionPolicy

enum KActionSelector::InsertionPolicy

This enum defines policies for where to insert moved items in a listbox.

See also: availableInsertionPolicy(), setAvailableInsertionPolicy(), selectedInsertionPolicy(), setSelectedInsertionPolicy()

Enumerator
BelowCurrent	The item is inserted below the listbox' currentItem() or at the end if there is no current item.
Sorted	The listbox is sort()ed after one or more items are inserted.
AtTop	The item is inserted at index 0 in the listbox.
AtBottom	The item is inserted at the end of the listbox.

Definition at line 111 of file kactionselector.h.

◆ MoveButton

enum KActionSelector::MoveButton

This enum identifies the moving buttons.

Definition at line 97 of file kactionselector.h.

Property Documentation

◆ availableInsertionPolicy

InsertionPolicy KActionSelector::availableInsertionPolicy

readwrite

Definition at line 76 of file kactionselector.h.

◆ availableLabel

QString KActionSelector::availableLabel

readwrite

Definition at line 74 of file kactionselector.h.

◆ keyboardEnabled

bool KActionSelector::keyboardEnabled

readwrite

Definition at line 73 of file kactionselector.h.

◆ moveOnDoubleClick

bool KActionSelector::moveOnDoubleClick

readwrite

Definition at line 72 of file kactionselector.h.

◆ selectedInsertionPolicy

InsertionPolicy KActionSelector::selectedInsertionPolicy

readwrite

Definition at line 77 of file kactionselector.h.

◆ selectedLabel

QString KActionSelector::selectedLabel

readwrite

Definition at line 75 of file kactionselector.h.

◆ showUpDownButtons

bool KActionSelector::showUpDownButtons

readwrite

Definition at line 78 of file kactionselector.h.

Constructor & Destructor Documentation

◆ KActionSelector()

KActionSelector::KActionSelector ( QWidget * parent = nullptr )

explicit

Definition at line 79 of file kactionselector.cpp.

Member Function Documentation

◆ added

void KActionSelector::added ( QListWidgetItem * item )

signal

Emitted when an item is moved to the "selected" listbox.

◆ availableInsertionPolicy()

KActionSelector::InsertionPolicy KActionSelector::availableInsertionPolicy ( ) const

Returns: The current insertion policy for the available listbox. The default policy for the available listbox is Sorted.

See also: InsertionPolicy, setAvailableInsertionPolicy()

Definition at line 308 of file kactionselector.cpp.

◆ availableLabel()

QString KActionSelector::availableLabel ( ) const

Returns: The text of the label for the available items listbox.

Definition at line 288 of file kactionselector.cpp.

◆ availableListWidget()

QListWidget * KActionSelector::availableListWidget ( ) const

Returns: The QListWidget holding the available actions

Definition at line 162 of file kactionselector.cpp.

◆ eventFilter()

bool KActionSelector::eventFilter	(	QObject *	o,
		QEvent *	e )

overrideprotectedvirtual

Reimplemented for internal reasons.

Reimplemented from QObject.

Definition at line 387 of file kactionselector.cpp.

◆ keyboardEnabled()

bool KActionSelector::keyboardEnabled ( ) const

Returns: Whether keyboard control is enabled.

When Keyboard control is enabled, the widget will react to the following keyboard actions:

CTRL + Right - simulate clicking the add button
CTRL + Left - simulate clicking the remove button
CTRL + Up - simulate clicking the up button
CTRL + Down - simulate clicking the down button

Additionally, pressing RETURN or ENTER on one of the list boxes will cause the current item of that listbox to be moved to the other listbox.

The keyboard actions are enabled by default.

See also: setKeyboardEnabled()

Definition at line 278 of file kactionselector.cpp.

◆ keyPressEvent()

void KActionSelector::keyPressEvent ( QKeyEvent * e )

overrideprotectedvirtual

Reimplemented for internal reasons.

Reimplemented from QWidget.

Definition at line 361 of file kactionselector.cpp.

◆ movedDown

void KActionSelector::movedDown ( QListWidgetItem * item )

signal

Emitted when an item is moved downwards in the "selected" listbox.

◆ movedUp

void KActionSelector::movedUp ( QListWidgetItem * item )

signal

Emitted when an item is moved upwards in the "selected" listbox.

◆ moveOnDoubleClick()

bool KActionSelector::moveOnDoubleClick ( ) const

Returns: Whether moveOnDoubleClcik is enabled.

If enabled, an item in any listbox will be moved to the other one whenever double-clicked. This feature is enabled by default.

See also: setMoveOnDoubleClick()

Definition at line 268 of file kactionselector.cpp.

◆ removed

void KActionSelector::removed ( QListWidgetItem * item )

signal

Emitted when an item is moved out of the "selected" listbox.

◆ selectedInsertionPolicy()

KActionSelector::InsertionPolicy KActionSelector::selectedInsertionPolicy ( ) const

Returns: The current insertion policy for the selected listbox. The default policy for the selected listbox is BelowCurrent.

See also: InsertionPolicy, setSelectedInsertionPolicy()

Definition at line 318 of file kactionselector.cpp.

◆ selectedLabel()

QString KActionSelector::selectedLabel ( ) const

Returns: the label of the selected items listbox.

Definition at line 298 of file kactionselector.cpp.

◆ selectedListWidget()

QListWidget * KActionSelector::selectedListWidget ( ) const

Returns: The QListWidget holding the selected actions

Definition at line 167 of file kactionselector.cpp.

◆ setAvailableInsertionPolicy()

void KActionSelector::setAvailableInsertionPolicy ( InsertionPolicy policy )

Sets the insertion policy for the available listbox.

See also: InsertionPolicy, availableInsertionPolicy()

Definition at line 313 of file kactionselector.cpp.

◆ setAvailableLabel()

void KActionSelector::setAvailableLabel ( const QString & text )

Sets the label for the available items listbox to text.

Note that this label has the listbox as its buddy, so that if you have a single ampersand in the text, the following character will become the accelerator to focus the listbox.

Definition at line 293 of file kactionselector.cpp.

◆ setButtonIcon()

void KActionSelector::setButtonIcon	(	const QString &	icon,
		MoveButton	button )

Sets the pixmap of the button button to icon.

It calls SmallIconSet(pm) to generate the icon set.

Definition at line 172 of file kactionselector.cpp.

◆ setButtonIconSet()

void KActionSelector::setButtonIconSet	(	const QIcon &	iconset,
		MoveButton	button )

Sets the iconset for button button to iconset.

You can use this method to set a custom icon set. Either created by QIconSet, or use the application instance of KIconLoader (recommended).

Definition at line 197 of file kactionselector.cpp.

◆ setButtonsEnabled

void KActionSelector::setButtonsEnabled ( )

slot

Emitted when an item is moved to the "selected" listbox.

Sets the enabled state of all moving buttons to reflect the current options.

Be sure to call this if you add or removes items to either listbox after the widget is shown

Definition at line 349 of file kactionselector.cpp.

◆ setButtonTooltip()

void KActionSelector::setButtonTooltip	(	const QString &	tip,
		MoveButton	button )

Sets the tooltip for the button button to tip.

Definition at line 218 of file kactionselector.cpp.

◆ setButtonWhatsThis()

void KActionSelector::setButtonWhatsThis	(	const QString &	text,
		MoveButton	button )

Sets the whatsthis help for button button to text.

Definition at line 243 of file kactionselector.cpp.

◆ setKeyboardEnabled()

void KActionSelector::setKeyboardEnabled ( bool enable )

Sets the keyboard enabled depending on enable.

See also: keyboardEnabled()

Definition at line 283 of file kactionselector.cpp.

◆ setMoveOnDoubleClick()

void KActionSelector::setMoveOnDoubleClick ( bool enable )

Sets moveOnDoubleClick to enable.

See also: moveOnDoubleClick()

Definition at line 273 of file kactionselector.cpp.

◆ setSelectedInsertionPolicy()

void KActionSelector::setSelectedInsertionPolicy ( InsertionPolicy policy )

Sets the insertion policy for the selected listbox.

See also: InsertionPolicy, selectedInsertionPolicy()

Definition at line 323 of file kactionselector.cpp.

◆ setSelectedLabel()

void KActionSelector::setSelectedLabel ( const QString & text )

Sets the label for the selected items listbox to text.

Note that this label has the listbox as its buddy, so that if you have a single ampersand in the text, the following character will become the accelerator to focus the listbox.

Definition at line 303 of file kactionselector.cpp.

◆ setShowUpDownButtons()

void KActionSelector::setShowUpDownButtons ( bool show )

Sets whether the Up and Down buttons should be displayed according to show.

Definition at line 333 of file kactionselector.cpp.

◆ showUpDownButtons()

bool KActionSelector::showUpDownButtons ( ) const

Returns: whether the Up and Down buttons should be displayed.

Definition at line 328 of file kactionselector.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KWidgetsAddons

KActionSelector

Public Types

Properties

Signals

Public Slots

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ InsertionPolicy

◆ MoveButton

Property Documentation

◆ availableInsertionPolicy

◆ availableLabel

◆ keyboardEnabled

◆ moveOnDoubleClick

◆ selectedInsertionPolicy

◆ selectedLabel

◆ showUpDownButtons

Constructor & Destructor Documentation

◆ KActionSelector()

Member Function Documentation

◆ added

◆ availableInsertionPolicy()

◆ availableLabel()

◆ availableListWidget()

◆ eventFilter()

◆ keyboardEnabled()

◆ keyPressEvent()

◆ movedDown

◆ movedUp

◆ moveOnDoubleClick()

◆ removed

◆ selectedInsertionPolicy()

◆ selectedLabel()

◆ selectedListWidget()

◆ setAvailableInsertionPolicy()

◆ setAvailableLabel()

◆ setButtonIcon()

◆ setButtonIconSet()

◆ setButtonsEnabled

◆ setButtonTooltip()

◆ setButtonWhatsThis()

◆ setKeyboardEnabled()

◆ setMoveOnDoubleClick()

◆ setSelectedInsertionPolicy()

◆ setSelectedLabel()

◆ setShowUpDownButtons()

◆ showUpDownButtons()