KisKActionCollection Class Reference

A container for a set of QAction objects. More...

#include <kactioncollection.h>

Inheritance diagram for KisKActionCollection:

Signals
QT_MOC_COMPAT void	actionHighlighted (QAction *action)
void	actionHovered (QAction *action)
void	actionTriggered (QAction *action)
void	inserted (QAction *action)

Public Member Functions
QAction *	action (const QString &name) const
QAction *	action (int index) const
const QList< QActionGroup * >	actionGroups () const
QList< QAction * >	actions () const
const QList< QAction * >	actionsWithoutGroup () const
template<class ActionType >
ActionType *	add (const QString &name, const QObject *receiver=0, const char *member=0)
QAction *	addAction (const QString &name, const QObject *receiver=0, const char *member=0)
Q_INVOKABLE QAction *	addAction (const QString &name, QAction *action)
QAction *	addAction (KStandardAction::StandardAction actionType, const QObject *receiver=0, const char *member=0)
QAction *	addAction (KStandardAction::StandardAction actionType, const QString &name, const QObject *receiver=0, const char *member=0)
void	addActions (const QList< QAction * > &actions)
void	addAssociatedWidget (QWidget *widget)
Q_INVOKABLE QAction *	addCategorizedAction (const QString &name, QAction *action, const QString &categoryName)
QList< QWidget * >	associatedWidgets () const
void	associateWidget (QWidget *widget) const
QList< KisKActionCategory * >	categories () const
void	clear ()
void	clearAssociatedWidgets ()
QString	componentDisplayName () const
QString	componentName () const
QString	configGroup () const
int	count () const
QKeySequence	defaultShortcut (QAction *action) const
QList< QKeySequence >	defaultShortcuts (QAction *action) const
KisKActionCategory *	getCategory (const QString &categoryName)
bool	isEmpty () const
bool	isShortcutsConfigurable (QAction *action) const
	KisKActionCollection (QObject *parent, const QString &cName=QString())
const KisKXMLGUIClient *	parentGUIClient () const
void	readSettings ()
void	removeAction (QAction *action)
void	removeAssociatedWidget (QWidget *widget)
void	setComponentDisplayName (const QString &displayName)
void	setComponentName (const QString &componentName)
void	setConfigGroup (const QString &group)
void	setDefaultShortcut (QAction *action, const QKeySequence &shortcut)
Q_INVOKABLE void	setDefaultShortcuts (QAction *action, const QList< QKeySequence > &shortcuts)
void	setShortcutsConfigurable (QAction *action, bool configurable)
QAction *	takeAction (QAction *action)
void	updateShortcuts ()
void	writeSettings (KConfigGroup *config=0, bool writeScheme=false, QAction *oneAction=0) const
	~KisKActionCollection () override

Static Public Member Functions
static const QList< KisKActionCollection * > &	allCollections ()

Protected Slots
virtual QT_MOC_COMPAT void	slotActionHighlighted ()
virtual void	slotActionTriggered ()

Protected Member Functions
void	connectNotify (const QMetaMethod &signal) override
	Overridden to perform connections when someone wants to know whether an action was highlighted or triggered.

Properties
QString	configGroup

Private Slots
void	slotActionHovered ()

Private Member Functions
	KisKActionCollection (const KisKXMLGUIClient *parent)

Private Attributes
class KisKActionCollectionPrivate *const	d

Friends
class	KisKActionCollectionPrivate
class	KisKXMLGUIClient

Detailed Description

A container for a set of QAction objects.

KisKActionCollection manages a set of QAction objects. It allows them to be grouped for organized presentation of configuration to the user, saving + loading of configuration, and optionally for automatic plugging into specified widget(s).

Additionally, KisKActionCollection provides several convenience functions for locating named actions, and actions grouped by QActionGroup.

Note

If you create your own action collection and need to assign shortcuts to the actions within, you have to call associateWidget() or addAssociatedWidget() to have them working.

Definition at line 43 of file kactioncollection.h.

Constructor & Destructor Documentation

KisKActionCollection() [1/2]

KisKActionCollection::KisKActionCollection ( QObject * parent, const QString & cName = QString() )

explicit

Constructor. Allows specification of a component name other than the default application name, where needed (remember to call setComponentDisplayName() too).

Definition at line 89 of file kactioncollection.cpp.

    : QObject(parent)
    , d(new KisKActionCollectionPrivate)
{
    d->q = this;
    KisKActionCollectionPrivate::s_allCollections.append(this);
 
    setComponentName(cName);
}

References d, KisKActionCollectionPrivate::q, KisKActionCollectionPrivate::s_allCollections, and setComponentName().

~KisKActionCollection()

KisKActionCollection::~KisKActionCollection ( )

override

Destructor.

Definition at line 110 of file kactioncollection.cpp.

{
    KisKActionCollectionPrivate::s_allCollections.removeAll(this);
 
    delete d;
}

References d, and KisKActionCollectionPrivate::s_allCollections.

KisKActionCollection() [2/2]

KisKActionCollection::KisKActionCollection ( const KisKXMLGUIClient * parent )

private

Definition at line 99 of file kactioncollection.cpp.

    : QObject(0)
    , d(new KisKActionCollectionPrivate)
{
    d->q = this;
    KisKActionCollectionPrivate::s_allCollections.append(this);
 
    d->m_parentGUIClient = parent;
    d->m_componentName = parent->componentName();
}

References d, KisKActionCollectionPrivate::m_componentName, KisKActionCollectionPrivate::m_parentGUIClient, KisKActionCollectionPrivate::q, and KisKActionCollectionPrivate::s_allCollections.

Member Function Documentation

action() [1/2]

QAction * KisKActionCollection::action

(

const QString &

name

)

const

Get the action with the given name from the action collection.

Parameters

name	Name of the QAction

Returns

A pointer to the QAction in the collection which matches the parameters or null if nothing matches.

Definition at line 145 of file kactioncollection.cpp.

{
    QAction *action = 0L;
 
    if (!name.isEmpty()) {
        action = d->actionByName.value(name);
    }
 
    return action;
}

References action(), KisKActionCollectionPrivate::actionByName, and d.

action() [2/2]

QAction * KisKActionCollection::action

(

int

index

)

const

Return the QAction* at position "index" in the action collection.

This is equivalent to actions().value(index);

Definition at line 156 of file kactioncollection.cpp.

{
    // ### investigate if any apps use this at all
    return actions().value(index);
}

References actions().

actionGroups()

const QList< QActionGroup * > KisKActionCollection::actionGroups

(

)

const

Returns the list of all QActionGroups associated with actions in this action collection.

Definition at line 232 of file kactioncollection.cpp.

{
    QSet<QActionGroup *> set;
    Q_FOREACH (QAction *action, d->actions)
        if (action->actionGroup()) {
            set.insert(action->actionGroup());
        }
    return QList<QActionGroup*>(set.begin(), set.end());
}

References action(), KisKActionCollectionPrivate::actions, and d.

actionHighlighted

QT_MOC_COMPAT void KisKActionCollection::actionHighlighted ( QAction * action )

signal

Indicates that action was highlighted (hovered over).

Deprecated

Replaced by actionHovered(QAction* action);

actionHovered

void KisKActionCollection::actionHovered ( QAction * action )

signal

Indicates that action was hovered.

actions()

QList< QAction * > KisKActionCollection::actions

(

)

const

Returns the list of QActions which belong to this action collection.

The list is guaranteed to be in the same order the action were put into the collection.

Definition at line 217 of file kactioncollection.cpp.

{
    return d->actions;
}

References KisKActionCollectionPrivate::actions, and d.

actionsWithoutGroup()

const QList< QAction * > KisKActionCollection::actionsWithoutGroup

(

)

const

Returns the list of QActions without an QAction::actionGroup() which belong to this action collection.

Definition at line 222 of file kactioncollection.cpp.

{
    QList<QAction *> ret;
    Q_FOREACH (QAction *action, d->actions)
        if (!action->actionGroup()) {
            ret.append(action);
        }
    return ret;
}

References action(), KisKActionCollectionPrivate::actions, and d.

actionTriggered

void KisKActionCollection::actionTriggered ( QAction * action )

signal

Indicates that action was triggered

add()

template<class ActionType >

ActionType * KisKActionCollection::add ( const QString & name, const QObject * receiver = 0, const char * member = 0 )

inline

Creates a new action under the given name, adds it to the collection and connects the action's triggered(bool) signal to the specified receiver/member. The receiver slot may accept either a bool or no parameters at all (i.e. slotTriggered(bool) or slotTriggered() ). The type of the action is specified by the template parameter ActionType.

NOTE: KDE prior to 4.2 connected the triggered() signal instead of the triggered(bool) signal.

Parameters

name	The internal name of the action (e.g. "file-open").
receiver	The QObject to connect the triggered(bool) signal to. Leave 0 if no connection is desired.
member	The SLOT to connect the triggered(bool) signal to. Leave 0 if no connection is desired.

Returns

new action of the given type ActionType.

See also

addAction()

Definition at line 415 of file kactioncollection.h.

    {
        ActionType *a = new ActionType(this);
        if (receiver && member) {
            connect(a, SIGNAL(triggered(bool)), receiver, member);
        }
        addAction(name, a);
        return a;
    }

addAction() [1/4]

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

Creates a new action under the given name to the collection and connects the action's triggered(bool) signal to the specified receiver/member. The newly created action is returned.

NOTE: KDE prior to 4.2 used the triggered() signal instead of the triggered(bool) signal.

Inserting an action that was previously inserted under a different name will replace the old entry, i.e. the action will not be available under the old name anymore but only under the new one.

Inserting an action under a name that is already used for another action will replace the other action in the collection.

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 0 if no connection is desired.
member	The SLOT to connect the triggered(bool) signal to. Leave 0 if no connection is desired.

Returns

new action of the given type ActionType.

Definition at line 371 of file kactioncollection.cpp.

{
    QAction *a = new QAction(this);
    if (receiver && member) {
        connect(a, SIGNAL(triggered(bool)), receiver, member);
    }
    return addAction(name, a);
}

References addAction().

addAction() [2/4]

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

Add an action under the given name to the collection.

Inserting an action that was previously inserted under a different name will replace the old entry, i.e. the action will not be available under the old name anymore but only under the new one.

Inserting an action under a name that is already used for another action will replace the other action in the collection (but will not delete it).

Parameters

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

Returns

the same as the action given as parameter. This is just for convenience (chaining calls) and consistency with the other addAction methods, you can also simply ignore the return value.

Definition at line 247 of file kactioncollection.cpp.

{
    if (!action) {
        return action;
    }
 
    const QString objectName = action->objectName();
    QString indexName = name;
 
    if (indexName.isEmpty()) {
        // No name provided. Use the objectName.
        indexName = objectName;
 
    } else {
        // Set the new name
        action->setObjectName(indexName);
    }
 
    // No name provided and the action had no name. Make one up. This will not
    // work when trying to save shortcuts.
    if (indexName.isEmpty()) {
        QTextStream(&indexName) << (void *)action;
 
        action->setObjectName(indexName);
    }
 
    // From now on the objectName has to have a value. Else we cannot safely
    // remove actions.
    Q_ASSERT(!action->objectName().isEmpty());
 
    // look if we already have THIS action under THIS name ;)
    if (d->actionByName.value(indexName, 0) == action) {
        // This is not a multi map!
        Q_ASSERT(d->actionByName.count(indexName) == 1);
        return action;
    }
 
    // Check if we have another action under this name
    if (QAction *oldAction = d->actionByName.value(indexName)) {
        takeAction(oldAction);
    }
 
    // Check if we have this action under a different name.
    // Not using takeAction because we don't want to remove it from categories,
    // and because it has the new name already.
    const int oldIndex = d->actions.indexOf(action);
    if (oldIndex != -1) {
        d->actionByName.remove(d->actionByName.key(action));
        d->actions.removeAt(oldIndex);
    }
 
    // Add action to our lists.
    d->actionByName.insert(indexName, action);
    d->actions.append(action);
 
    Q_FOREACH (QWidget *widget, d->associatedWidgets) {
        widget->addAction(action);
    }
 
    connect(action, SIGNAL(destroyed(QObject*)), SLOT(_k_actionDestroyed(QObject*)));
 
    d->setComponentForAction(action);
 
    if (d->connectHovered) {
        connect(action, SIGNAL(hovered()), SLOT(slotActionHovered()));
    }
 
    if (d->connectTriggered) {
        connect(action, SIGNAL(triggered(bool)), SLOT(slotActionTriggered()));
    }
 
    Q_EMIT inserted(action);
    return action;
}

References action(), KisKActionCollectionPrivate::actionByName, KisKActionCollectionPrivate::actions, KisKActionCollectionPrivate::associatedWidgets, KisKActionCollectionPrivate::connectHovered, KisKActionCollectionPrivate::connectTriggered, d, inserted(), KisKActionCollectionPrivate::setComponentForAction(), slotActionHovered(), slotActionTriggered(), and takeAction().

addAction() [3/4]

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

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.

Note: Using KStandardAction::OpenRecent will cause a different signal than triggered(bool) to be used, see KStandardAction for more information.

The action can be retrieved later from the collection by its standard name as per KStandardAction::stdName.

Parameters

actionType	The standard action type of the action to create.
receiver	The QObject to connect the triggered(bool) signal to. Leave 0 if no connection is desired.
member	The SLOT to connect the triggered(bool) signal to. Leave 0 if no connection is desired.

Returns

new action of the given type ActionType.

Definition at line 350 of file kactioncollection.cpp.

{
    QAction *action = KStandardAction::create(actionType, receiver, member, this);
    return action;
}

References action(), and KStandardAction::create().

addAction() [4/4]

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

Creates a new standard action, adds to the collection under the given name and connects the action's triggered(bool) signal to the specified receiver/member. The newly created action is also returned.

Note: Using KStandardAction::OpenRecent will cause a different signal than triggered(bool) to be used, see KStandardAction for more information.

The action can be retrieved later from the collection by the specified name.

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 0 if no connection is desired.
member	The SLOT to connect the triggered(bool) signal to. Leave 0 if no connection is desired.

Returns

new action of the given type ActionType.

Definition at line 356 of file kactioncollection.cpp.

{
    // pass 0 as parent, because if the parent is a KisKActionCollection KStandardAction::create automatically
    // adds the action to it under the default name. We would trigger the
    // warning about renaming the action then.
    QAction *action = KStandardAction::create(actionType, receiver, member, 0);
    // Give it a parent for gc.
    action->setParent(this);
    // Remove the name to get rid of the "rename action" warning above
    action->setObjectName(name);
    // And now add it with the desired name.
    return addAction(name, action);
}

References action(), addAction(), and KStandardAction::create().

addActions()

void KisKActionCollection::addActions

(

const QList< QAction * > &

actions

)

Adds a list of actions to the collection.

The objectName of the actions is used as their internal name in the collection.

Uses addAction(QString, QAction*).

Parameters

actions

the list of the actions to add.

See also

addAction()

Since

5.0

Definition at line 322 of file kactioncollection.cpp.

{
    Q_FOREACH (QAction *action, actions) {
        addAction(action->objectName(), action);
    }
}

References action(), actions(), and addAction().

addAssociatedWidget()

void KisKActionCollection::addAssociatedWidget

(

QWidget *

widget

)

Associate all actions in this collection to the given widget, including any actions added after this association is made.

This does not change the action's shortcut context, so if you need to have the actions only trigger when the widget has focus, you'll need to set the shortcut context on each action to Qt::WidgetShortcut (or better still, Qt::WidgetWithChildrenShortcut with Qt 4.4+)

Definition at line 654 of file kactioncollection.cpp.

{
    if (!d->associatedWidgets.contains(widget)) {
        widget->addActions(actions());
 
        d->associatedWidgets.append(widget);
        connect(widget, SIGNAL(destroyed(QObject*)), this, SLOT(_k_associatedWidgetDestroyed(QObject*)));
    }
}

References actions(), KisKActionCollectionPrivate::associatedWidgets, and d.

addCategorizedAction()

QAction * KisKActionCollection::addCategorizedAction	(	const QString &	name,
		QAction *	action,
		const QString &	categoryName )

Adds a new action to the collection in category category.

The category will be created if it does not already exist.

Definition at line 242 of file kactioncollection.cpp.

{
    return getCategory(categoryName)->addAction(name, action);
}

References action(), KisKActionCategory::addAction(), and getCategory().

allCollections()

const QList< KisKActionCollection * > & KisKActionCollection::allCollections ( )

static

Access the list of all action collections in existence for this app

Definition at line 640 of file kactioncollection.cpp.

{
    return KisKActionCollectionPrivate::s_allCollections;
}

References KisKActionCollectionPrivate::s_allCollections.

associatedWidgets()

QList< QWidget * > KisKActionCollection::associatedWidgets

(

)

const

Return a list of all associated widgets.

Definition at line 720 of file kactioncollection.cpp.

{
    return d->associatedWidgets;
}

References KisKActionCollectionPrivate::associatedWidgets, and d.

associateWidget()

void KisKActionCollection::associateWidget

(

QWidget *

widget

)

const

Associate all actions in this collection to the given widget. Unlike addAssociatedWidget, this method only adds all current actions in the collection to the given widget. Any action added after this call will not be added to the given widget automatically. So this is just a shortcut for a foreach loop and a widget->addAction call.

Definition at line 645 of file kactioncollection.cpp.

{
    Q_FOREACH (QAction *action, actions()) {
        if (!widget->actions().contains(action)) {
            widget->addAction(action);
        }
    }
}

References action(), and actions().

categories()

QList< KisKActionCategory * > KisKActionCollection::categories

(

)

const

Returns the KActionCategories inside this collection

Definition at line 118 of file kactioncollection.cpp.

{
    return this->findChildren<KisKActionCategory *>();
}

clear()

void KisKActionCollection::clear

(

)

Clears the entire action collection, deleting all actions.

Definition at line 138 of file kactioncollection.cpp.

{
    d->actionByName.clear();
    qDeleteAll(d->actions);
    d->actions.clear();
}

References KisKActionCollectionPrivate::actionByName, KisKActionCollectionPrivate::actions, and d.

clearAssociatedWidgets()

void KisKActionCollection::clearAssociatedWidgets

(

)

Clear all associated widgets and remove the actions from those widgets.

Definition at line 725 of file kactioncollection.cpp.

{
    Q_FOREACH (QWidget *widget, d->associatedWidgets)
        Q_FOREACH (QAction *action, actions()) {
            widget->removeAction(action);
        }
 
    d->associatedWidgets.clear();
}

References action(), actions(), KisKActionCollectionPrivate::associatedWidgets, and d.

componentDisplayName()

QString KisKActionCollection::componentDisplayName

(

)

const

The display name for the associated component.

Definition at line 201 of file kactioncollection.cpp.

{
    if (!d->m_componentDisplayName.isEmpty()) {
        return d->m_componentDisplayName;
    }
    if (!QGuiApplication::applicationDisplayName().isEmpty()) {
        return QGuiApplication::applicationDisplayName();
    }
    return QCoreApplication::applicationName();
}

References d, isEmpty(), and KisKActionCollectionPrivate::m_componentDisplayName.

componentName()

QString KisKActionCollection::componentName

(

)

const

The component name with which this class is associated.

Definition at line 191 of file kactioncollection.cpp.

{
    return d->m_componentName;
}

References d, and KisKActionCollectionPrivate::m_componentName.

configGroup()

QString KisKActionCollection::configGroup

(

)

const

Returns the KConfig group with which settings will be loaded and saved.

Definition at line 414 of file kactioncollection.cpp.

{
    return d->configGroup;
}

References KisKActionCollectionPrivate::configGroup, and d.

connectNotify()

void KisKActionCollection::connectNotify ( const QMetaMethod & signal )

overrideprotected

Overridden to perform connections when someone wants to know whether an action was highlighted or triggered.

Definition at line 613 of file kactioncollection.cpp.

{
    if (d->connectHovered && d->connectTriggered) {
        return;
    }
 
    if (signal.methodSignature() == "actionHighlighted(QAction*)" ||
            signal.methodSignature() == "actionHovered(QAction*)") {
        if (!d->connectHovered) {
            d->connectHovered = true;
            Q_FOREACH (QAction *action, actions()) {
                connect(action, SIGNAL(hovered()), SLOT(slotActionHovered()));
            }
        }
 
    } else if (signal.methodSignature() == "actionTriggered(QAction*)") {
        if (!d->connectTriggered) {
            d->connectTriggered = true;
            Q_FOREACH (QAction *action, actions()) {
                connect(action, SIGNAL(triggered(bool)), SLOT(slotActionTriggered()));
            }
        }
    }
 
    QObject::connectNotify(signal);
}

References action(), actions(), KisKActionCollectionPrivate::connectHovered, KisKActionCollectionPrivate::connectTriggered, d, slotActionHovered(), and slotActionTriggered().

count()

int KisKActionCollection::count

(

)

const

Returns the number of actions in the collection.

This is equivalent to actions().count().

Definition at line 162 of file kactioncollection.cpp.

{
    return d->actions.count();
}

References KisKActionCollectionPrivate::actions, and d.

defaultShortcut()

QKeySequence KisKActionCollection::defaultShortcut

(

QAction *

action

)

const

Get the default primary shortcut for the given action.

Parameters

action

the action for which the default primary shortcut should be returned.

Returns

the default primary shortcut of the given action

Since

5.0

Definition at line 380 of file kactioncollection.cpp.

{
    const QList<QKeySequence> shortcuts = defaultShortcuts(action);
    return shortcuts.isEmpty() ? QKeySequence() : shortcuts.first();
}

References action(), and defaultShortcuts().

defaultShortcuts()

QList< QKeySequence > KisKActionCollection::defaultShortcuts

(

QAction *

action

)

const

Get the default shortcuts for the given action.

Parameters

action

the action for which the default shortcuts should be returned.

Returns

the default shortcuts of the given action

Since

5.0

Definition at line 386 of file kactioncollection.cpp.

{
    return action->property("defaultShortcuts").value<QList<QKeySequence> >();
}

References action().

getCategory()

KisKActionCategory * KisKActionCollection::getCategory

(

const QString &

categoryName

)

Gets a category with name name inside this collection.

Creates a new category if one does not exist.

Definition at line 123 of file kactioncollection.cpp.

                                                                         {
    KisKActionCategory *category = 0;
    foreach (KisKActionCategory *c, categories()) {
        if (c->text() == name) {
            category = c;
        }
    }
 
    if (category == 0) {
        category = new KisKActionCategory(name, this);
    }
    return category;
}

References categories(), and KisKActionCategory::text.

inserted

void KisKActionCollection::inserted ( QAction * action )

signal

Indicates that action was inserted into this action collection.

isEmpty()

bool KisKActionCollection::isEmpty

(

)

const

Returns whether the action collection is empty or not.

Definition at line 167 of file kactioncollection.cpp.

{
    return count() == 0;
}

References count().

isShortcutsConfigurable()

bool KisKActionCollection::isShortcutsConfigurable

(

QAction *

action

)

const

Returns true if the given action's shortcuts may be configured by the user.

Parameters

action

the action for the hint should be verified.

Since

5.0

Definition at line 402 of file kactioncollection.cpp.

{
    // Considered as true by default
    const QVariant value = action->property("isShortcutConfigurable");
    return value.isValid() ? value.toBool() : true;
}

References action(), and value().

parentGUIClient()

const KisKXMLGUIClient * KisKActionCollection::parentGUIClient

(

)

const

The parent KisKXMLGUIClient, or null if not available.

Definition at line 212 of file kactioncollection.cpp.

{
    return d->m_parentGUIClient;
}

References d, and KisKActionCollectionPrivate::m_parentGUIClient.

readSettings()

void KisKActionCollection::readSettings

(

)

Read all key associations from config.

If config is zero, read all key associations from the application's configuration file KSharedConfig::openConfig(), in the group set by setConfigGroup().

Definition at line 435 of file kactioncollection.cpp.

{
    auto ar = KisActionRegistry::instance();
    ar->loadCustomShortcuts();
 
    for (QMap<QString, QAction *>::ConstIterator it = d->actionByName.constBegin();
            it != d->actionByName.constEnd(); ++it) {
        QAction *action = it.value();
        if (!action) {
            continue;
        }
 
        if (isShortcutsConfigurable(action)) {
            QString actionName = it.key();
            ar->updateShortcut(actionName, action);
        }
    }
}

References action(), KisKActionCollectionPrivate::actionByName, d, KisActionRegistry::instance(), and isShortcutsConfigurable().

removeAction()

void KisKActionCollection::removeAction

(

QAction *

action

)

Removes an action from the collection and deletes it.

Parameters

action

The action to remove.

Definition at line 329 of file kactioncollection.cpp.

{
    delete takeAction(action);
}

References action(), and takeAction().

removeAssociatedWidget()

void KisKActionCollection::removeAssociatedWidget

(

QWidget *

widget

)

Remove an association between all actions in this collection and the given widget, i.e. remove those actions from the widget, and stop associating newly added actions as well.

Definition at line 664 of file kactioncollection.cpp.

{
    Q_FOREACH (QAction *action, actions()) {
        widget->removeAction(action);
    }
 
    d->associatedWidgets.removeAll(widget);
    disconnect(widget, SIGNAL(destroyed(QObject*)), this, SLOT(_k_associatedWidgetDestroyed(QObject*)));
}

References action(), actions(), KisKActionCollectionPrivate::associatedWidgets, and d.

setComponentDisplayName()

void KisKActionCollection::setComponentDisplayName

(

const QString &

displayName

)

Set the component display name associated with this action collection. (e.g. for the toolbar editor) KXmlGuiClient::setComponentName takes care of calling this.

Definition at line 196 of file kactioncollection.cpp.

{
    d->m_componentDisplayName = displayName;
}

References d, and KisKActionCollectionPrivate::m_componentDisplayName.

setComponentName()

void KisKActionCollection::setComponentName

(

const QString &

componentName

)

Set the componentName associated with this action collection.

Warning

Don't call this method on a KisKActionCollection that contains actions. This is not supported.

Parameters

componentName

the name which is to be associated with this action collection, or QString() to indicate the app name. This is used to load/save settings into XML files. KXmlGuiClient::setComponentName takes care of calling this.

Definition at line 172 of file kactioncollection.cpp.

{
    if (count() > 0) {
        // Its component name is part of an action's signature in the context of
        // global shortcuts and the semantics of changing an existing action's
        // signature are, as it seems, impossible to get right.
        // As of now this only matters for global shortcuts. We could
        // thus relax the requirement and only refuse to change the component data
        // if we have actions with global shortcuts in this collection.
        qWarning() << "this does not work on a KisKActionCollection containing actions!";
    }
 
    if (!cName.isEmpty()) {
        d->m_componentName = cName;
    } else {
        d->m_componentName = QCoreApplication::applicationName();
    }
}

References count(), d, and KisKActionCollectionPrivate::m_componentName.

setConfigGroup()

void KisKActionCollection::setConfigGroup

(

const QString &

group

)

Sets group as the KConfig group with which settings will be loaded and saved.

Definition at line 419 of file kactioncollection.cpp.

{
    d->configGroup = group;
}

References KisKActionCollectionPrivate::configGroup, and d.

setDefaultShortcut()

void KisKActionCollection::setDefaultShortcut	(	QAction *	action,
		const QKeySequence &	shortcut )

Set the default shortcut for the given action. Since 5.2, this also calls action->setShortcut(shortcut), i.e. the default shortcut is made active initially.

Parameters

action	the action for which the default shortcut should be set.
shortcut	the shortcut to use for the given action in its specified shortcutContext()

Since

5.0

Definition at line 391 of file kactioncollection.cpp.

{
    setDefaultShortcuts(action, QList<QKeySequence>() << shortcut);
}

References action(), and setDefaultShortcuts().

setDefaultShortcuts()

void KisKActionCollection::setDefaultShortcuts	(	QAction *	action,
		const QList< QKeySequence > &	shortcuts )

Set the default shortcuts for the given action. Since 5.2, this also calls action->setShortcuts(shortcuts), i.e. the default shortcut is made active initially.

Parameters

action	the action for which the default shortcut should be set.
shortcuts	the shortcuts to use for the given action in its specified shortcutContext()

Since

5.0

Definition at line 396 of file kactioncollection.cpp.

{
    action->setShortcuts(shortcuts);
    action->setProperty("defaultShortcuts", QVariant::fromValue(shortcuts));
}

References action().

setShortcutsConfigurable()

void KisKActionCollection::setShortcutsConfigurable	(	QAction *	action,
		bool	configurable )

Indicate whether the user may configure the action's shortcuts.

Parameters

action	the action for the hint should be verified.
configurable	set to true if the shortcuts of the given action may be configured by the user, otherwise false.

Since

5.0

Definition at line 409 of file kactioncollection.cpp.

{
    action->setProperty("isShortcutConfigurable", configurable);
}

References action().

slotActionHighlighted

void KisKActionCollection::slotActionHighlighted ( )

protectedvirtualslot

Definition at line 594 of file kactioncollection.cpp.

{
    slotActionHovered();
}

References slotActionHovered().

slotActionHovered

void KisKActionCollection::slotActionHovered ( )

privateslot

Definition at line 599 of file kactioncollection.cpp.

{
    QAction *action = qobject_cast<QAction *>(sender());
    if (action) {
        Q_EMIT actionHighlighted(action);
        Q_EMIT actionHovered(action);
    }
}

References action(), actionHighlighted(), and actionHovered().

slotActionTriggered

void KisKActionCollection::slotActionTriggered ( )

protectedvirtualslot

Definition at line 586 of file kactioncollection.cpp.

{
    QAction *action = qobject_cast<QAction *>(sender());
    if (action) {
        Q_EMIT actionTriggered(action);
    }
}

References action(), and actionTriggered().

takeAction()

QAction * KisKActionCollection::takeAction

(

QAction *

action

)

Removes an action from the collection.

Parameters

action

the action to remove.

Definition at line 334 of file kactioncollection.cpp.

{
    if (!d->unlistAction(action)) {
        return 0;
    }
 
    // Remove the action from all widgets
    Q_FOREACH (QWidget *widget, d->associatedWidgets) {
        widget->removeAction(action);
    }
 
    action->disconnect(this);
 
    return action;
}

References action(), KisKActionCollectionPrivate::associatedWidgets, d, and KisKActionCollectionPrivate::unlistAction().

updateShortcuts()

void KisKActionCollection::updateShortcuts

(

)

Update shortcuts from the KisActionRegistry.

Definition at line 424 of file kactioncollection.cpp.

{
    auto actionRegistry = KisActionRegistry::instance();
 
    for (QMap<QString, QAction *>::ConstIterator it = d->actionByName.constBegin();
         it != d->actionByName.constEnd(); ++it) {
        actionRegistry->updateShortcut(it.key(), it.value());
    }
}

References KisKActionCollectionPrivate::actionByName, d, and KisActionRegistry::instance().

writeSettings()

void KisKActionCollection::writeSettings	(	KConfigGroup *	config = 0,
		bool	writeScheme = false,
		QAction *	oneAction = 0 ) const

Write the current configurable key associations. If is nonzero, use that configuration group.

Otherwise, the output file is determined as follows. If this action collection belongs to a KXMLGuiClient the setting are saved to the kxmlgui definition file. If not the settings are written to the applications config file.

Note

oneAction() and writeDefaults() have no meaning for the kxmlgui configuration file.

Parameters

config	Config object to save to, or null (see above)
writeScheme	set to true if we export all settings as new shortcut scheme
oneAction	pass an action here if you just want to save the values for one action, eg. if you know that action is the only one which has changed.

Definition at line 517 of file kactioncollection.cpp.

{
    // If the caller didn't provide a config group we try to save the KisKXMLGUI
    // Configuration file. (This will work if the parentGUI was set and has a
    // valid configuration file.)
    if (config == 0 && d->writeKisKXMLGUIConfigFile()) {
        return;
    }
 
 
    KConfigGroup cg(KSharedConfig::openConfig(), configGroup());
    if (!config) {
        config = &cg;
    }
 
    QList<QAction *> writeActions;
    if (oneAction) {
        writeActions.append(oneAction);
    } else {
        writeActions = actions();
    }
 
    for (QMap<QString, QAction *>::ConstIterator it = d->actionByName.constBegin();
            it != d->actionByName.constEnd(); ++it) {
 
        QAction *action = it.value();
        if (!action) {
            continue;
        }
 
        QString actionName = it.key();
 
        // If the action name starts with unnamed- spit out a warning and ignore
        // it. That name will change at will and will break loading writing
        if (actionName.startsWith(QLatin1String("unnamed-"))) {
            qCritical() << "Skipped saving shortcut for action without name " \
                        << action->text() << "!";
            continue;
        }
 
        // Write the shortcut
        if (isShortcutsConfigurable(action)) {
            bool bConfigHasAction = !config->readEntry(actionName, QString()).isEmpty();
            bool bSameAsDefault = (action->shortcuts() == defaultShortcuts(action));
            // If the current shortcut differs from the default, we want to write.
 
            KConfigGroup::WriteConfigFlags flags = KConfigGroup::Persistent;
 
            if (writeScheme || !bSameAsDefault) {
                // We are instructed to write all shortcuts or the shortcut is
                // not set to its default value. Write it
                QString s = QKeySequence::listToString(action->shortcuts());
                if (s.isEmpty()) {
                    s = QStringLiteral("none");
                }
                config->writeEntry(actionName, s, flags);
            } else if (bConfigHasAction) {
                // This key is the same as default but exists in config file.
                // Remove it.
                config->deleteEntry(actionName, flags);
            }
        }
    }
 
    config->sync();
}

References action(), KisKActionCollectionPrivate::actionByName, actions(), configGroup, d, defaultShortcuts(), isShortcutsConfigurable(), and KisKActionCollectionPrivate::writeKisKXMLGUIConfigFile().

Friends And Related Symbol Documentation

KisKActionCollectionPrivate

friend class KisKActionCollectionPrivate

friend

Definition at line 489 of file kactioncollection.h.

KisKXMLGUIClient

friend class KisKXMLGUIClient

friend

Definition at line 45 of file kactioncollection.h.

Member Data Documentation

d

class KisKActionCollectionPrivate* const KisKActionCollection::d

private

Definition at line 490 of file kactioncollection.h.

Property Documentation

configGroup

QString KisKActionCollection::configGroup

readwrite

Definition at line 49 of file kactioncollection.h.

---

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

• libs/widgetutils/xmlgui/kactioncollection.h
• libs/widgetutils/xmlgui/kactioncollection.cpp