KisActionRegistry Class Reference

#include <kis_action_registry.h>

Inheritance diagram for KisActionRegistry:

Classes
struct	ActionCategory

Signals
void	shortcutsUpdated ()

Public Member Functions
ActionInfoItem &	actionInfo (const QString &name)
void	applyShortcutScheme (const KConfigBase *config=0)
ActionCategory	fetchActionCategory (const QString &name) const
QString	getActionProperty (const QString &name, const QString &property)
bool	hasAction (const QString &name) const
	KisActionRegistry ()
void	loadActionFiles ()
void	loadCustomShortcuts ()
void	loadCustomShortcuts (QString filename=QStringLiteral("kritashortcutsrc"))
void	loadShortcutScheme (const QString &schemeName)
	loadShortcutScheme
QAction *	makeQAction (const QString &name, QObject *parent=0)
void	notifySettingsUpdated ()
	Private (KisActionRegistry *_q)
bool	propertizeAction (const QString &name, QAction *a)
QList< QString >	registeredShortcutIds () const
bool	sanityCheckPropertized (const QString &name)
void	settingsPageSaved ()
void	updateShortcut (const QString &name, QAction *ac)
	~KisActionRegistry ()

Static Public Member Functions
static KisActionRegistry *	instance ()

Public Attributes
QMap< QString, ActionInfoItem >	actionInfoList
KisActionRegistry *	q
QSet< QString >	sanityPropertizedShortcuts

Private Attributes
const QScopedPointer< Private >	d
Private Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Additional Inherited Members
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Detailed Description

KisActionRegistry is intended to manage the global action configuration data for Krita. The data come from four sources:

• .action files, containing static action configuration data in XML format,
• .rc configuration files, originally from XMLGUI and now in WidgetUtils,
• kritashortcutsrc, containing temporary shortcut configuration, and
• .shortcuts scheme files providing sets of default shortcuts, also from XMLGUI

This class can be used as a factory by calling makeQAction. It can be used to add standard properties such as default shortcuts and default tooltip to an existing action with propertizeAction. If you have a custom action class which needs to add other properties, you can use propertizeAction to add any sort of data you wish to the .action configuration file.

This class is also in charge of displaying the shortcut configuration dialog. The interplay between this class, KisKActionCollection, KisShortcutsEditor and so on can be complex, and is sometimes synchronized by file I/O by reading and writing the configuration files mentioned above.

It is a global static. Grab an instance().

Definition at line 146 of file kis_action_registry.cpp.

Constructor & Destructor Documentation

KisActionRegistry()

KisActionRegistry::KisActionRegistry

(

)

Constructor. Please don't touch!

Definition at line 186 of file kis_action_registry.cpp.

    : d(new KisActionRegistry::Private(this))
{
    KConfigGroup cg = KSharedConfig::openConfig()->group("Shortcut Schemes");
    QString schemeName = cg.readEntry("Current Scheme", "Default");
    QString schemeFileName = KisKShortcutSchemesHelper::schemeFileLocations().value(schemeName);
    if (!QFileInfo(schemeFileName).exists()) {
        schemeName = "Default";
    }
    loadShortcutScheme(schemeName);
    loadCustomShortcuts();
}

References loadCustomShortcuts(), loadShortcutScheme(), and KisKShortcutSchemesHelper::schemeFileLocations().

~KisActionRegistry()

KisActionRegistry::~KisActionRegistry

(

)

Definition at line 199 of file kis_action_registry.cpp.

{
}

Member Function Documentation

actionInfo()

ActionInfoItem & KisActionRegistry::actionInfo ( const QString & name )

inline

Definition at line 158 of file kis_action_registry.cpp.

                                                    {
        if (!actionInfoList.contains(name)) {
            dbgAction << "Tried to look up info for unknown action" << name;
        }
        return actionInfoList[name];
    }

References dbgAction.

applyShortcutScheme()

void KisActionRegistry::applyShortcutScheme

(

const KConfigBase *

config = 0

)

Definition at line 261 of file kis_action_registry.cpp.

{
    // First, update the things in KisActionRegistry
    d->actionInfoList.clear();
    d->loadActionFiles();
 
    if (config == 0) {
        // Use default shortcut scheme. Simplest just to reload everything.
        loadCustomShortcuts();
    } else {
        const auto schemeEntries = config->group(QStringLiteral("Shortcuts")).entryMap();
        // Load info item for each shortcut, reset custom shortcuts
        auto it = schemeEntries.constBegin();
        while (it != schemeEntries.end()) {
            ActionInfoItem &info = d->actionInfo(it.key());
            info.setDefaultShortcuts(QKeySequence::listFromString(it.value()));
            it++;
        }
    }
}

References d, and loadCustomShortcuts().

fetchActionCategory()

KisActionRegistry::ActionCategory KisActionRegistry::fetchActionCategory

(

const QString &

name

)

const

Definition at line 203 of file kis_action_registry.cpp.

{
    if (!d->actionInfoList.contains(name)) return ActionCategory();
 
    const ActionInfoItem info = d->actionInfoList.value(name);
    return ActionCategory(info.collectionName, info.categoryName);
}

References d.

getActionProperty()

QString KisActionRegistry::getActionProperty	(	const QString &	name,
		const QString &	property )

Returns

value property for an action name.

Allow flexible info structure for KisActions, etc.

Definition at line 356 of file kis_action_registry.cpp.

{
    ActionInfoItem info = d->actionInfo(name);
    QDomElement actionXml = info.xmlData;
    if (actionXml.text().isEmpty()) {
        dbgAction << "getActionProperty: No XML data found for action" << name;
        return QString();
    }
 
    return getChildContent(actionXml, property);
 
}

References d, and dbgAction.

hasAction()

bool KisActionRegistry::hasAction

(

const QString &

name

)

const

Returns

true if the given action exists

Definition at line 180 of file kis_action_registry.cpp.

{
    return d->actionInfoList.contains(name);
}

References d.

instance()

KisActionRegistry * KisActionRegistry::instance ( )

static

Definition at line 172 of file kis_action_registry.cpp.

{
    if (!s_instance.exists()) {
        dbgRegistry << "initializing KoActionRegistry";
    }
    return s_instance;
}

References dbgRegistry.

loadActionFiles()

void KisActionRegistry::loadActionFiles

(

)

loadCustomShortcuts() [1/2]

void KisActionRegistry::loadCustomShortcuts

(

)

Reload custom shortcuts from kritashortcutsrc

Definition at line 216 of file kis_action_registry.cpp.

{
    d->loadCustomShortcuts();
}

References d.

loadCustomShortcuts() [2/2]

void KisActionRegistry::loadCustomShortcuts

(

QString

filename = QStringLiteral("kritashortcutsrc")

)

loadShortcutScheme()

void KisActionRegistry::loadShortcutScheme

(

const QString &

schemeName

)

loadShortcutScheme

Parameters

schemeName

Definition at line 221 of file kis_action_registry.cpp.

{
    // Load scheme file
    if (schemeName != QStringLiteral("Default")) {
        QString schemeFileName = KisKShortcutSchemesHelper::schemeFileLocations().value(schemeName);
        if (schemeFileName.isEmpty() || !QFileInfo(schemeFileName).exists()) {
            applyShortcutScheme();
            return;
        }
        KConfig schemeConfig(schemeFileName, KConfig::SimpleConfig);
        applyShortcutScheme(&schemeConfig);
    } else {
        // Apply default scheme, updating KisActionRegistry data
        applyShortcutScheme();
    }
}

References applyShortcutScheme(), and KisKShortcutSchemesHelper::schemeFileLocations().

makeQAction()

QAction * KisActionRegistry::makeQAction	(	const QString &	name,
		QObject *	parent = 0 )

Produces a new QAction based on the .action data files.

N.B. this action will not be saved in the registry.

Definition at line 238 of file kis_action_registry.cpp.

{
    QAction * a = new QAction(parent);
    if (!d->actionInfoList.contains(name)) {
        qWarning() << "Warning: requested data for unknown action" << name;
        a->setObjectName(name);
        return a;
    }
 
    propertizeAction(name, a);
    return a;
}

References d, and propertizeAction().

notifySettingsUpdated()

void KisActionRegistry::notifySettingsUpdated

(

)

Call after settings are changed.

Definition at line 211 of file kis_action_registry.cpp.

{
    d->loadCustomShortcuts();
}

References d.

Private()

KisActionRegistry::Private ( KisActionRegistry * _q )

inline

Definition at line 150 of file kis_action_registry.cpp.

: q(_q) {}

propertizeAction()

bool KisActionRegistry::propertizeAction	(	const QString &	name,
		QAction *	a )

Fills the standard QAction properties of an action.

Returns

true if the action was loaded successfully.

Definition at line 312 of file kis_action_registry.cpp.

{
    if (!d->actionInfoList.contains(name)) {
        warnAction << "propertizeAction: No XML data found for action" << name;
        return false;
    }
 
    const ActionInfoItem info = d->actionInfo(name);
 
    QDomElement actionXml = info.xmlData;
    if (!actionXml.text().isEmpty()) {
        // i18n requires converting format from QString.
        auto getChildContent_i18n = [=](QString node){return quietlyTranslate(getChild(actionXml, node));};
 
        // Note: the fields in the .action documents marked for translation are determined by extractrc.
        QString icon      = getChildContent(actionXml, "icon");
        QString text      = getChildContent_i18n("text");
        QString whatsthis = getChildContent_i18n("whatsThis");
        // tooltip is set in updateShortcut() because shortcut gets appended to the tooltip
        //QString toolTip   = getChildContent_i18n("toolTip");
        QString statusTip = getChildContent_i18n("statusTip");
        QString iconText  = getChildContent_i18n("iconText");
        bool isCheckable  = getChildContent(actionXml, "isCheckable") == QString("true");
 
        a->setObjectName(name); // This is helpful, should be added more places in Krita
        if (!icon.isEmpty()) {
            a->setIcon(KisIconUtils::loadIcon(icon.toLatin1()));
            a->setProperty("iconName", QVariant::fromValue(icon)); // test
        }
        a->setText(text);
        a->setObjectName(name);
        a->setWhatsThis(whatsthis);
 
        a->setStatusTip(statusTip);
        a->setIconText(iconText);
        a->setCheckable(isCheckable);
    }
 
    updateShortcut(name, a);
    return true;
}

References d, KisIconUtils::loadIcon(), updateShortcut(), and warnAction.

registeredShortcutIds()

QList< QString > KisActionRegistry::registeredShortcutIds

(

)

const

Definition at line 307 of file kis_action_registry.cpp.

{
    return d->actionInfoList.keys();
}

References d.

sanityCheckPropertized()

bool KisActionRegistry::sanityCheckPropertized

(

const QString &

name

)

Definition at line 302 of file kis_action_registry.cpp.

{
    return d->sanityPropertizedShortcuts.contains(name);
}

References d.

settingsPageSaved()

void KisActionRegistry::settingsPageSaved

(

)

Called when "OK" button is pressed in settings dialog.

Definition at line 251 of file kis_action_registry.cpp.

{
   // For now, custom shortcuts are dealt with by writing to file and reloading.
   loadCustomShortcuts();
 
   // Announce UI should reload current shortcuts.
   Q_EMIT shortcutsUpdated();
}

References loadCustomShortcuts(), and shortcutsUpdated().

shortcutsUpdated

void KisActionRegistry::shortcutsUpdated ( )

signal

updateShortcut()

void KisActionRegistry::updateShortcut	(	const QString &	name,
		QAction *	ac )

Definition at line 282 of file kis_action_registry.cpp.

{
    const ActionInfoItem &info = d->actionInfo(name);
    action->setShortcuts(info.effectiveShortcuts());
    action->setProperty("defaultShortcuts", QVariant::fromValue(info.defaultShortcuts()));
 
    d->sanityPropertizedShortcuts.insert(name);
 
    // TODO: KisShortcutsEditor overwrites shortcuts as you edit them, so we cannot know here
    // if the old shortcut is indeed "old" and must regenerate the tooltip unconditionally.
 
    QString plainTip = quietlyTranslate(getChild(info.xmlData, "toolTip"));
    if (action->shortcut().isEmpty()) {
        action->setToolTip(plainTip);
    } else {
        //qDebug() << "action with shortcut:" << name << action->shortcut();
        action->setToolTip(plainTip + " (" + action->shortcut().toString(QKeySequence::NativeText) + ")");
    }
}

References d.

Member Data Documentation

actionInfoList

QMap<QString, ActionInfoItem> KisActionRegistry::actionInfoList

Definition at line 153 of file kis_action_registry.cpp.

d

const QScopedPointer<Private> KisActionRegistry::d

private

Definition at line 136 of file kis_action_registry.h.

q

KisActionRegistry* KisActionRegistry::q

Definition at line 165 of file kis_action_registry.cpp.

sanityPropertizedShortcuts

QSet<QString> KisActionRegistry::sanityPropertizedShortcuts

Definition at line 166 of file kis_action_registry.cpp.

---

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

• libs/widgetutils/kis_action_registry.cpp
• libs/widgetutils/kis_action_registry.h