KActionCategory

Search for usage in LXR

KActionCategory Class Reference

#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< QStringbindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo () const const
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
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 QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_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
 
qobject_cast (const QObject *object)
 
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)
 
QThreadthread () const const
 

Adding Actions

Add a action to the category.

This methods are provided for your convenience. They call the corresponding method of KActionCollection.

QActionaddAction (const QString &name, QAction *action)
 
QActionaddAction (KStandardAction::StandardAction actionType, const QObject *receiver=nullptr, const char *member=nullptr)
 
QActionaddAction (KStandardAction::StandardAction actionType, const QString &name, const QObject *receiver=nullptr, const char *member=nullptr)
 
QActionaddAction (const QString &name, const QObject *receiver=nullptr, const char *member=nullptr)
 
template<class ActionType >
ActionType * add (const QString &name, const QObject *receiver=nullptr, const char *member=nullptr)
 
const QList< QAction * > actions () const
 
KActionCollectioncollection () const
 
QString text () const
 
void setText (const QString &text)
 

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 QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

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(
KStandardAction::New, //< see KStandardAction
this, //< Receiver
SLOT(fileNew())); //< SLOT
... more actions added to file ...
KActionCategory *edit = new KActionCategory(i18n("Edit"), actionCollection());
edit->addAction(
KStandardAction::Copy, //< see KStandardAction
this, //< Receiver
SLOT(fileNew())); //< SLOT
...
Categorize actions for KShortcutsEditor.
const QList< QAction * > actions() const
Returns the actions belonging to this category.
KActionCategory(const QString &text, KActionCollection *parent=nullptr)
Default constructor.
QString i18n(const char *text, const TYPE &arg...)
QList< T > findChildren(Qt::FindChildOptions options) const const

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

template<class ActionType >
ActionType * KActionCategory::add ( const QString & name,
const QObject * receiver = nullptr,
const char * member = nullptr )
inline

Definition at line 119 of file kactioncategory.h.

◆ addAction() [1/4]

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

Definition at line 60 of file kactioncategory.cpp.

◆ addAction() [2/4]

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

Definition at line 39 of file kactioncategory.cpp.

◆ addAction() [3/4]

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

Definition at line 46 of file kactioncategory.cpp.

◆ addAction() [4/4]

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

Definition at line 53 of file kactioncategory.cpp.

◆ collection()

KActionCollection * KActionCategory::collection ( ) const

The action collection this category is associated with.

Definition at line 75 of file kactioncategory.cpp.

◆ setText()

void KActionCategory::setText ( const QString & text)

Set the action categorys descriptive text.

Definition at line 85 of file kactioncategory.cpp.

◆ text()

QString KActionCategory::text ( ) const

The action categorys descriptive text.

Definition at line 80 of file kactioncategory.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 24 2024 11:54:18 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.