KToolBarPopupAction Class Reference

#include <KToolBarPopupAction>

Inheritance diagram for KToolBarPopupAction:

Public Types
enum	PopupMode { NoPopup = -1 , DelayedPopup = QToolButton::DelayedPopup , MenuButtonPopup = QToolButton::MenuButtonPopup , InstantPopup = QToolButton::InstantPopup }
Public Types inherited from QAction
enum	ActionEvent
enum	MenuRole
enum	Priority
Public Types inherited from QObject
typedef	QObjectList

Properties
PopupMode	popupMode
Properties inherited from QAction
	autoRepeat
	checkable
	checked
	enabled
	font
	icon
	iconText
	iconVisibleInMenu
	menuRole
	priority
	shortcut
	shortcutContext
	shortcutVisibleInContextMenu
	statusTip
	text
	toolTip
	visible
	whatsThis
Properties inherited from QObject
	objectName

Public Member Functions
	KToolBarPopupAction (const QIcon &icon, const QString &text, QObject *parent)
	~KToolBarPopupAction () override
QWidget *	createWidget (QWidget *parent) override
QMenu *	popupMenu () const
PopupMode	popupMode () const
void	setPopupMode (PopupMode popupMode)
Public Member Functions inherited from QWidgetAction
	QWidgetAction (QObject *parent)
QWidget *	defaultWidget () const const
void	releaseWidget (QWidget *widget)
QWidget *	requestWidget (QWidget *parent)
void	setDefaultWidget (QWidget *widget)
Public Member Functions inherited from QAction
	QAction (const QIcon &icon, const QString &text, QObject *parent)
	QAction (const QString &text, QObject *parent)
	QAction (QObject *parent)
QActionGroup *	actionGroup () const const
void	activate (ActionEvent event)
QList< QGraphicsWidget * >	associatedGraphicsWidgets () const const
QList< QObject * >	associatedObjects () const const
QList< QWidget * >	associatedWidgets () const const
bool	autoRepeat () const const
void	changed ()
void	checkableChanged (bool checkable)
QVariant	data () const const
void	enabledChanged (bool enabled)
QFont	font () const const
void	hover ()
void	hovered ()
QIcon	icon () const const
QString	iconText () const const
bool	isCheckable () const const
bool	isChecked () const const
bool	isEnabled () const const
bool	isIconVisibleInMenu () const const
bool	isSeparator () const const
bool	isShortcutVisibleInContextMenu () const const
bool	isVisible () const const
QMenu *	menu () const const
MenuRole	menuRole () const const
QWidget *	parentWidget () const const
Priority	priority () const const
void	resetEnabled ()
void	setActionGroup (QActionGroup *group)
void	setAutoRepeat (bool)
void	setCheckable (bool)
void	setChecked (bool)
void	setData (const QVariant &data)
void	setDisabled (bool b)
void	setEnabled (bool)
void	setFont (const QFont &font)
void	setIcon (const QIcon &icon)
void	setIconText (const QString &text)
void	setIconVisibleInMenu (bool visible)
void	setMenu (QMenu *menu)
void	setMenuRole (MenuRole menuRole)
void	setPriority (Priority priority)
void	setSeparator (bool b)
void	setShortcut (const QKeySequence &shortcut)
void	setShortcutContext (Qt::ShortcutContext context)
void	setShortcuts (const QList< QKeySequence > &shortcuts)
void	setShortcuts (QKeySequence::StandardKey key)
void	setShortcutVisibleInContextMenu (bool show)
void	setStatusTip (const QString &statusTip)
void	setText (const QString &text)
void	setToolTip (const QString &tip)
void	setVisible (bool)
void	setWhatsThis (const QString &what)
QKeySequence	shortcut () const const
Qt::ShortcutContext	shortcutContext () const const
QList< QKeySequence >	shortcuts () const const
bool	showStatusText (QObject *object)
QString	statusTip () const const
QString	text () const const
void	toggle ()
void	toggled (bool checked)
QString	toolTip () const const
void	trigger ()
void	triggered (bool checked)
void	visibleChanged ()
QString	whatsThis () 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

Additional Inherited Members
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 QAction
	AboutQtRole
	AboutRole
	ApplicationSpecificRole
	HighPriority
	Hover
	LowPriority
	NormalPriority
	NoRole
	PreferencesRole
	QuitRole
	TextHeuristicRole
	Trigger
Protected Member Functions inherited from QWidgetAction
QList< QWidget * >	createdWidgets () const const
virtual void	deleteWidget (QWidget *widget)
virtual bool	event (QEvent *event) override
virtual bool	eventFilter (QObject *obj, QEvent *event) override
Protected Member Functions inherited from QAction
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)

Detailed Description

This action is a normal action everywhere, except in a toolbar where it also has a popupmenu (optionally delayed).

This action is designed for history actions (back/forward, undo/redo) and for any other action that has more detail in a toolbar than in a menu (e.g. tool chooser with "Other" leading to a dialog...).

In contrast to KActionMenu, this action is a simple menuitem when plugged into a menu, and has a popup only in a toolbar.

Use cases include Back/Forward, and Undo/Redo. Simple click is what's most commonly used, and enough for menus, but in toolbars there is also an optional popup to go back N steps or undo N steps.

Note

Add actions to the popupMenu(), don't use setMenu().

Definition at line 46 of file ktoolbarpopupaction.h.

Member Enumeration Documentation

PopupMode

enum KToolBarPopupAction::PopupMode

The menu popup mode.

Default is MenuButtonPopup.

See also

QToolButton::ToolButtonPopupMode

Since

6.0

Enumerator
NoPopup	Behave as if the button had no menu.
DelayedPopup	Clicking anywhere on the toolbar button triggers the default action. Clicking and holding the toolbar button opens the popup menu instead.
MenuButtonPopup	The toolbar button is split in a main button (triggers default action) and an arrow button (opens the popup menu).
InstantPopup	Clicking anywhere on the toolbar button opens the popup menu.

Definition at line 61 of file ktoolbarpopupaction.h.

Property Documentation

popupMode

PopupMode KToolBarPopupAction::popupMode

readwrite

Definition at line 49 of file ktoolbarpopupaction.h.

Constructor & Destructor Documentation

KToolBarPopupAction()

KToolBarPopupAction::KToolBarPopupAction	(	const QIcon &	icon,
		const QString &	text,
		QObject *	parent )

Create a KToolBarPopupAction, with a text, an icon, a parent and a name.

Parameters

icon	The icon to display.
text	The text that will be displayed.
parent	This action's parent.

Definition at line 55 of file ktoolbarpopupaction.cpp.

~KToolBarPopupAction()

KToolBarPopupAction::~KToolBarPopupAction ( )

overridedefault

Destroys the toolbar popup action.

Member Function Documentation

createWidget()

QWidget * KToolBarPopupAction::createWidget ( QWidget * parent )

overridevirtual

Reimplemented from QWidgetAction.

Reimplemented from QWidgetAction.

Definition at line 65 of file ktoolbarpopupaction.cpp.

popupMenu()

QMenu * KToolBarPopupAction::popupMenu

(

)

const

The popup menu that is shown when clicking (some time) on the toolbar button.

You may want to plug items into it on creation, or connect to aboutToShow for a more dynamic menu.

Note

menu() is null on this action by default and using setMenu() will effectively turn this action into a regular action with a submenu.

Since

6.0

Definition at line 103 of file ktoolbarpopupaction.cpp.

popupMode()

KToolBarPopupAction::PopupMode KToolBarPopupAction::popupMode

(

)

const

The popup mode of the toolbar button.

See also

setPopupMode()

Since

6.0

Definition at line 86 of file ktoolbarpopupaction.cpp.

setPopupMode()

void KToolBarPopupAction::setPopupMode

(

KToolBarPopupAction::PopupMode

popupMode

)

Determines the popup mode of the toolbar button.

See also

PopupMode

Since

6.0

Definition at line 91 of file ktoolbarpopupaction.cpp.

---

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

• ktoolbarpopupaction.h
• ktoolbarpopupaction.cpp