KActionCategory

#include <KActionCategory>

Inheritance diagram for KActionCategory:

Properties
QString	text

Properties inherited from QObject
	objectName

Public Member Functions
	KActionCategory (const QString &text, KActionCollection *parent=nullptr)

	~KActionCategory () override

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

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

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

Adding Actions
Add a action to the category. This methods are provided for your convenience. They call the corresponding method of KActionCollection.
QAction *	addAction (const QString &name, QAction *action)

QAction *	addAction (KStandardAction::StandardAction actionType, const QObject receiver=nullptr, const char member=nullptr)

QAction *	addAction (KStandardAction::StandardAction actionType, const QString &name, const QObject receiver=nullptr, const char member=nullptr)

QAction *	addAction (const QString &name, const QObject receiver=nullptr, const char member=nullptr)

template<class ActionType >
ActionType *	add (const QString &name, const QObject receiver, const char member)

QAction *	addAction (KStandardActions::StandardAction actionType, const Receiver *receiver, Func slot)

QAction *	addAction (KStandardActions::StandardAction actionType)

QAction *	addAction (KStandardActions::StandardAction actionType, const Receiver *receiver, Func slot)

QAction *	addAction (const Receiver *receiver, Func slot)

QAction *	add (const Receiver *receiver, Func slot)

template<class ActionType >
ActionType *	add (const QString &name)

const QList< QAction * >	actions () const

KActionCollection *	collection () const

QString	text () const

void	setText (const QString &text)

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList

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)

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

Categorize actions for KShortcutsEditor.

KActionCategory provides a second level to organize the actions in KShortcutsEditor.

The first possibility is using more than one action collection. Each actions collection becomes a top level node.

action collection 1
- first action
- second action
- third action
action collection 2
- first action
- second action
- third action

Using KActionCategory it's possible to group the actions of one collection.

action collection 1
- first action
- first category
  - action 1 in category
  - action 2 in category
- second action

Usage

The usage is analog to action collections. Just create a category and use it instead of the collection to create the actions.

The synchronization between KActionCollection and KActionCategory is done internally. There is for example no need to remove actions from a category. It is done implicitly if the action is removed from the associated collection.

KActionCategory *file = new KActionCategory(i18n("File"), actionCollection());
file->addAction(
     KStandardActions::New,   //< see KStandardAction
     this,                   //< Receiver
     &MyApp::fileNew);       //< Slot
 
... more actions added to file ...
 
KActionCategory *edit = new KActionCategory(i18n("Edit"), actionCollection());
edit->addAction(
     KStandardActions::Copy,  //< see KStandardAction
     this,                   //< Receiver
     &MyApp::fileNew);       //< Slot
 
...

Definition at line 84 of file kactioncategory.h.

Property Documentation

◆ text

QString KActionCategory::text

readwrite

Definition at line 88 of file kactioncategory.h.

Constructor & Destructor Documentation

◆ KActionCategory()

KActionCategory::KActionCategory	(	const QString &	text,
		KActionCollection *	parent = nullptr )

explicit

Default constructor.

Definition at line 25 of file kactioncategory.cpp.

◆ ~KActionCategory()

KActionCategory::~KActionCategory ( )

overridedefault

Destructor.

Member Function Documentation

◆ actions()

const QList< QAction * > KActionCategory::actions ( ) const

Returns the actions belonging to this category.

Definition at line 34 of file kactioncategory.cpp.

◆ add() [1/3]

template<class ActionType >

ActionType * KActionCategory::add ( const QString & name )

inline

Creates a new action and adds it to the collection.

The newly created action is also returned.

The KActionCollection takes ownership of the action object.

Parameters

name	The name by which the action be retrieved again from the collection.

Returns: the created action.

Since: 6.9

Definition at line 289 of file kactioncategory.h.

◆ add() [2/3]

template<class ActionType >

ActionType * KActionCategory::add	(	const QString &	name,
		const QObject *	receiver,
		const char *	member )

inline

Definition at line 143 of file kactioncategory.h.

◆ add() [3/3]

QAction * KActionCategory::add	(	const Receiver *	receiver,
		Func	slot )

inline

Creates a new action, adds it to the collection and connects the action's triggered(bool) signal to the specified receiver/member.

The newly created action is also returned.

The KActionCollection takes ownership of the action object.

Parameters

name	The name by which the action be retrieved again from the collection.
receiver	The QObject to connect the triggered(bool) signal to. Leave nullptr if no connection is desired.
slot	The slot or lambda to connect the triggered(bool) signal to.

Returns: the created action.

Since: 6.9

Definition at line 265 of file kactioncategory.h.

◆ addAction() [1/8]

QAction * KActionCategory::addAction	(	const QString &	name,
		const QObject *	receiver = nullptr,
		const char *	member = nullptr )

Deprecated: since 6.9, use PMF overload

Definition at line 65 of file kactioncategory.cpp.

◆ addAction() [2/8]

QAction * KActionCategory::addAction	(	const QString &	name,
		QAction *	action )

Definition at line 39 of file kactioncategory.cpp.

◆ addAction() [3/8]

QAction * KActionCategory::addAction	(	const Receiver *	receiver,
		Func	slot )

inline

Creates a new action, adds it to the collection and connects the action's triggered(bool) signal to the specified receiver/member.

The newly created action is also returned.

The KActionCollection takes ownership of the action object.

Parameters

name	The name by which the action be retrieved again from the collection.
receiver	The QObject to connect the triggered(bool) signal to. Leave nullptr if no connection is desired.
slot	The slot or lambda to connect the triggered(bool) signal to.

Returns: the created action.

Since: 6.9

Definition at line 237 of file kactioncategory.h.

◆ addAction() [4/8]

QAction * KActionCategory::addAction	(	KStandardAction::StandardAction	actionType,
		const QObject *	receiver = nullptr,
		const char *	member = nullptr )

Definition at line 47 of file kactioncategory.cpp.

◆ addAction() [5/8]

QAction * KActionCategory::addAction	(	KStandardAction::StandardAction	actionType,
		const QString &	name,
		const QObject *	receiver = nullptr,
		const char *	member = nullptr )

Definition at line 56 of file kactioncategory.cpp.

◆ addAction() [6/8]

QAction * KActionCategory::addAction ( KStandardActions::StandardAction actionType )

Creates a new standard action and adds it to the collection.

The newly created action is also returned.

The KActionCollection takes ownership of the action object.

Parameters

actionType The standard action type of the action to create.

Returns: the created action.

Since: 6.9

Definition at line 73 of file kactioncategory.cpp.

◆ addAction() [7/8]

QAction * KActionCategory::addAction	(	KStandardActions::StandardAction	actionType,
		const Receiver *	receiver,
		Func	slot )

inline

Creates a new standard action, adds it to the collection and connects the action's triggered(bool) signal to the specified receiver/member.

The newly created action is also returned.

The KActionCollection takes ownership of the action object.

Parameters

actionType	The standard action type of the action to create.
receiver	The QObject to connect the triggered(bool) signal to. Leave nullptr if no connection is desired.
slot	The slot or lambda to connect the triggered(bool) signal to.

Returns: the created action.

Since: 6.9

Definition at line 167 of file kactioncategory.h.

◆ addAction() [8/8]

QAction * KActionCategory::addAction	(	KStandardActions::StandardAction	actionType,
		const Receiver *	receiver,
		Func	slot )

inline

Creates a new standard action, adds it to the collection and connects the action's triggered(bool) signal to the specified receiver/member.

The newly created action is also returned.

The KActionCollection takes ownership of the action object.

Parameters

actionType	The standard action type of the action to create.
name	The name by which the action be retrieved again from the collection.
receiver	The QObject to connect the triggered(bool) signal to. Leave nullptr if no connection is desired.
slot	The slot or lambda to connect the triggered(bool) signal to.

Returns: the created action.

Since: 6.9

Definition at line 209 of file kactioncategory.h.

◆ collection()

KActionCollection * KActionCategory::collection ( ) const

The action collection this category is associated with.

Definition at line 88 of file kactioncategory.cpp.

◆ setText()

void KActionCategory::setText ( const QString & text )

Set the action categorys descriptive text.

Definition at line 98 of file kactioncategory.cpp.

◆ text()

QString KActionCategory::text ( ) const

The action categorys descriptive text.

Definition at line 93 of file kactioncategory.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KXmlGui

KActionCategory

Properties

Public Member Functions

Adding Actions

Additional Inherited Members

Detailed Description

Usage

Property Documentation

◆ text

Constructor & Destructor Documentation

◆ KActionCategory()

◆ ~KActionCategory()

Member Function Documentation

◆ actions()

◆ add() [1/3]

◆ add() [2/3]

◆ add() [3/3]

◆ addAction() [1/8]

◆ addAction() [2/8]

◆ addAction() [3/8]

◆ addAction() [4/8]

◆ addAction() [5/8]

◆ addAction() [6/8]

◆ addAction() [7/8]

◆ addAction() [8/8]

◆ collection()

◆ setText()

◆ text()