KisActionsSnapshot Class Reference

The KisActionsSnapshot class. More...

#include <KisActionsSnapshot.h>

Classes
struct	Private

Public Member Functions
QMap< QString, KisKActionCollection * >	actionCollections ()
void	addAction (const QString &name, QAction *action)
	registers the action in the snapshot and sorts it into a proper category. The action is not owned by the snapshot.
	KisActionsSnapshot ()
	~KisActionsSnapshot ()

Private Attributes
const QScopedPointer< Private >	m_d

Detailed Description

The KisActionsSnapshot class.

Definition at line 22 of file KisActionsSnapshot.h.

Constructor & Destructor Documentation

KisActionsSnapshot()

KisActionsSnapshot::KisActionsSnapshot

(

)

Definition at line 30 of file KisActionsSnapshot.cpp.

    : m_d(new Private)
{
    QList<QString> registeredShortcutIds = KisActionRegistry::instance()->registeredShortcutIds();
    m_d->nonRegisteredShortcuts = QSet<QString>(registeredShortcutIds.begin(), registeredShortcutIds.end());
}

References KisActionRegistry::instance(), m_d, and KisActionRegistry::registeredShortcutIds().

~KisActionsSnapshot()

KisActionsSnapshot::~KisActionsSnapshot

(

)

Definition at line 37 of file KisActionsSnapshot.cpp.

{
}

Member Function Documentation

actionCollections()

QMap< QString, KisKActionCollection * > KisActionsSnapshot::actionCollections

(

)

Returns all action collections of the current snapshot

WARNING: the collections are owned by the snapshot! Don't destroy the snapshot before you are done with the collections!

A small heuristics to show warnings only when unknown shortcuts appear in the non-registered list

Definition at line 67 of file KisActionsSnapshot.cpp.

{
    if (m_d->nonRegisteredShortcuts.size() > 4 &&
        m_d->nonRegisteredShortcuts.size() < 160) {
 
        warnKrita << "WARNING: The following shortcuts are not registered in the collection, "
                     "they might have wrong shortcuts in the end:";
        Q_FOREACH (const QString &str, m_d->nonRegisteredShortcuts) {
            warnKrita << str;
        }
        warnKrita << "=== end ===";
    }
 
    // try to workaround non-registered shortcuts by faking them manually
    Q_FOREACH (const QString &str, m_d->nonRegisteredShortcuts) {
        QAction *action = KisActionRegistry::instance()->makeQAction(str, 0);
        m_d->fakeActions << action;
        addAction(action->objectName(), action);
    }
 
    return m_d->actionCollections;
}

References addAction(), KisActionRegistry::instance(), m_d, KisActionRegistry::makeQAction(), and warnKrita.

addAction()

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

registers the action in the snapshot and sorts it into a proper category. The action is not owned by the snapshot.

Parameters

name	id string of the action
action	the action itself

Definition at line 41 of file KisActionsSnapshot.cpp.

{
    m_d->nonRegisteredShortcuts.remove(name);
    KisActionRegistry::ActionCategory cat = KisActionRegistry::instance()->fetchActionCategory(name);
 
    if (!cat.isValid()) {
        warnKrita << "WARNING: Uncategorized action" << name << "Dropping...";
        return;
    }
 
#ifdef ACTIONS_CHECKSUM_SANITY_CHECK
    if (!KisActionRegistry::instance()->sanityCheckPropertized(action->objectName())) {
        warnKrita << "WARNING: action" << name  << "was not propertized!"  << ppVar(action->property("isShortcutConfigurable").toBool());
    }
#endif /* ACTIONS_CHECKSUM_SANITY_CHECK */
 
    KisKActionCollection *collection =  m_d->actionCollections[cat.componentName];
 
    if (!collection) {
        collection = new KisKActionCollection(0, cat.componentName);
        m_d->actionCollections.insert(cat.componentName, collection);
    }
 
    collection->addCategorizedAction(name, action, cat.categoryName);
}

References KisKActionCollection::addCategorizedAction(), KisActionRegistry::ActionCategory::categoryName, KisActionRegistry::ActionCategory::componentName, KisActionRegistry::fetchActionCategory(), KisActionRegistry::instance(), KisActionRegistry::ActionCategory::isValid(), m_d, ppVar, and warnKrita.

Member Data Documentation

m_d

const QScopedPointer<Private> KisActionsSnapshot::m_d

private

Definition at line 47 of file KisActionsSnapshot.h.

---

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

• libs/widgetutils/KisActionsSnapshot.h
• libs/widgetutils/KisActionsSnapshot.cpp