cf12defd28
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
734 lines
24 KiB
C++
734 lines
24 KiB
C++
/*
|
|
This file is part of the KDE libraries
|
|
SPDX-FileCopyrightText: 1999, 2000 Simon Hausmann <hausmann@kde.org>
|
|
SPDX-FileCopyrightText: 2000 Kurt Granroth <granroth@kde.org>
|
|
|
|
SPDX-License-Identifier: LGPL-2.0-or-later
|
|
*/
|
|
|
|
#include "config-xmlgui.h"
|
|
|
|
#include "kxmlguifactory.h"
|
|
|
|
#include "debug.h"
|
|
#include "kactioncollection.h"
|
|
#include "kshortcutschemeshelper_p.h"
|
|
#include "kshortcutsdialog.h"
|
|
#include "kxmlguibuilder.h"
|
|
#include "kxmlguiclient.h"
|
|
#include "kxmlguifactory_p.h"
|
|
|
|
#include <QAction>
|
|
#include <QCoreApplication>
|
|
#include <QDir>
|
|
#include <QDomDocument>
|
|
#include <QFile>
|
|
#include <QStandardPaths>
|
|
#include <QTextStream>
|
|
#include <QVariant>
|
|
#include <QWidget>
|
|
|
|
#include <KConfigGroup>
|
|
#include <KSharedConfig>
|
|
#if HAVE_GLOBALACCEL
|
|
#include <KGlobalAccel>
|
|
#endif
|
|
|
|
using namespace KXMLGUI;
|
|
|
|
class KXMLGUIFactoryPrivate : public BuildState
|
|
{
|
|
public:
|
|
enum ShortcutOption { SetActiveShortcut = 1, SetDefaultShortcut = 2 };
|
|
|
|
KXMLGUIFactoryPrivate()
|
|
{
|
|
m_rootNode = new ContainerNode(nullptr, QString(), QString());
|
|
attrName = QStringLiteral("name");
|
|
}
|
|
~KXMLGUIFactoryPrivate()
|
|
{
|
|
delete m_rootNode;
|
|
}
|
|
|
|
void pushState()
|
|
{
|
|
m_stateStack.push(*this);
|
|
}
|
|
|
|
void popState()
|
|
{
|
|
BuildState::operator=(m_stateStack.pop());
|
|
}
|
|
|
|
bool emptyState() const
|
|
{
|
|
return m_stateStack.isEmpty();
|
|
}
|
|
|
|
QWidget *findRecursive(KXMLGUI::ContainerNode *node, bool tag);
|
|
QList<QWidget *> findRecursive(KXMLGUI::ContainerNode *node, const QString &tagName);
|
|
void applyActionProperties(const QDomElement &element, ShortcutOption shortcutOption = KXMLGUIFactoryPrivate::SetActiveShortcut);
|
|
void configureAction(QAction *action, const QDomNamedNodeMap &attributes, ShortcutOption shortcutOption = KXMLGUIFactoryPrivate::SetActiveShortcut);
|
|
void configureAction(QAction *action, const QDomAttr &attribute, ShortcutOption shortcutOption = KXMLGUIFactoryPrivate::SetActiveShortcut);
|
|
|
|
void applyShortcutScheme(const QString &schemeName, KXMLGUIClient *client, const QList<QAction *> &actions);
|
|
void refreshActionProperties(KXMLGUIClient *client, const QList<QAction *> &actions, const QDomDocument &doc);
|
|
void saveDefaultActionProperties(const QList<QAction *> &actions);
|
|
|
|
ContainerNode *m_rootNode;
|
|
|
|
/*
|
|
* Contains the container which is searched for in ::container .
|
|
*/
|
|
QString m_containerName;
|
|
|
|
/*
|
|
* List of all clients
|
|
*/
|
|
QList<KXMLGUIClient *> m_clients;
|
|
|
|
QString attrName;
|
|
|
|
BuildStateStack m_stateStack;
|
|
};
|
|
|
|
QString KXMLGUIFactory::readConfigFile(const QString &filename, const QString &_componentName)
|
|
{
|
|
QString componentName = _componentName.isEmpty() ? QCoreApplication::applicationName() : _componentName;
|
|
QString xml_file;
|
|
|
|
if (!QDir::isRelativePath(filename)) {
|
|
xml_file = filename;
|
|
} else {
|
|
// first look for any custom user config, admin config or the default deployed as file
|
|
xml_file = QStandardPaths::locate(QStandardPaths::GenericDataLocation, QLatin1String("kxmlgui5/") + componentName + QLatin1Char('/') + filename);
|
|
if (!QFile::exists(xml_file)) {
|
|
// fall-back to any built-in resource file
|
|
xml_file = QLatin1String(":/kxmlgui5/") + componentName + QLatin1Char('/') + filename;
|
|
}
|
|
}
|
|
|
|
QFile file(xml_file);
|
|
if (xml_file.isEmpty() || !file.open(QIODevice::ReadOnly)) {
|
|
qCCritical(DEBUG_KXMLGUI) << "No such XML file" << filename;
|
|
return QString();
|
|
}
|
|
|
|
QByteArray buffer(file.readAll());
|
|
return QString::fromUtf8(buffer.constData(), buffer.size());
|
|
}
|
|
|
|
bool KXMLGUIFactory::saveConfigFile(const QDomDocument &doc, const QString &filename, const QString &_componentName)
|
|
{
|
|
QString componentName = _componentName.isEmpty() ? QCoreApplication::applicationName() : _componentName;
|
|
QString xml_file(filename);
|
|
|
|
if (QDir::isRelativePath(xml_file)) {
|
|
xml_file = QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation) + QLatin1String("/kxmlgui5/%1/%2").arg(componentName, filename);
|
|
}
|
|
|
|
QFileInfo fileInfo(xml_file);
|
|
QDir().mkpath(fileInfo.absolutePath());
|
|
QFile file(xml_file);
|
|
if (xml_file.isEmpty() || !file.open(QIODevice::WriteOnly)) {
|
|
qCCritical(DEBUG_KXMLGUI) << "Could not write to" << filename;
|
|
return false;
|
|
}
|
|
|
|
// write out our document
|
|
QTextStream ts(&file);
|
|
ts << doc;
|
|
|
|
file.close();
|
|
return true;
|
|
}
|
|
|
|
KXMLGUIFactory::KXMLGUIFactory(KXMLGUIBuilder *builder, QObject *parent)
|
|
: QObject(parent)
|
|
, d(new KXMLGUIFactoryPrivate)
|
|
{
|
|
Q_INIT_RESOURCE(kxmlgui);
|
|
|
|
d->builder = builder;
|
|
d->guiClient = nullptr;
|
|
if (d->builder) {
|
|
d->builderContainerTags = d->builder->containerTags();
|
|
d->builderCustomTags = d->builder->customTags();
|
|
}
|
|
}
|
|
|
|
KXMLGUIFactory::~KXMLGUIFactory()
|
|
{
|
|
for (KXMLGUIClient *client : std::as_const(d->m_clients)) {
|
|
client->setFactory(nullptr);
|
|
}
|
|
}
|
|
|
|
void KXMLGUIFactory::addClient(KXMLGUIClient *client)
|
|
{
|
|
// qCDebug(DEBUG_KXMLGUI) << client;
|
|
if (client->factory()) {
|
|
if (client->factory() == this) {
|
|
return;
|
|
} else {
|
|
client->factory()->removeClient(client); // just in case someone does stupid things ;-)
|
|
}
|
|
}
|
|
|
|
if (d->emptyState()) {
|
|
Q_EMIT makingChanges(true);
|
|
}
|
|
d->pushState();
|
|
|
|
// QTime dt; dt.start();
|
|
|
|
d->guiClient = client;
|
|
|
|
// add this client to our client list
|
|
if (!d->m_clients.contains(client)) {
|
|
d->m_clients.append(client);
|
|
}
|
|
// else
|
|
// qCDebug(DEBUG_KXMLGUI) << "XMLGUI client already added " << client;
|
|
|
|
// Tell the client that plugging in is process and
|
|
// let it know what builder widget its mainwindow shortcuts
|
|
// should be attached to.
|
|
client->beginXMLPlug(d->builder->widget());
|
|
|
|
// try to use the build document for building the client's GUI, as the build document
|
|
// contains the correct container state information (like toolbar positions, sizes, etc.) .
|
|
// if there is non available, then use the "real" document.
|
|
QDomDocument doc = client->xmlguiBuildDocument();
|
|
if (doc.documentElement().isNull()) {
|
|
doc = client->domDocument();
|
|
}
|
|
|
|
QDomElement docElement = doc.documentElement();
|
|
|
|
d->m_rootNode->index = -1;
|
|
|
|
// cache some variables
|
|
|
|
d->clientName = docElement.attribute(d->attrName);
|
|
d->clientBuilder = client->clientBuilder();
|
|
|
|
if (d->clientBuilder) {
|
|
d->clientBuilderContainerTags = d->clientBuilder->containerTags();
|
|
d->clientBuilderCustomTags = d->clientBuilder->customTags();
|
|
} else {
|
|
d->clientBuilderContainerTags.clear();
|
|
d->clientBuilderCustomTags.clear();
|
|
}
|
|
|
|
// load shortcut schemes, user-defined shortcuts and other action properties
|
|
d->saveDefaultActionProperties(client->actionCollection()->actions());
|
|
if (!doc.isNull()) {
|
|
d->refreshActionProperties(client, client->actionCollection()->actions(), doc);
|
|
}
|
|
|
|
BuildHelper(*d, d->m_rootNode).build(docElement);
|
|
|
|
// let the client know that we built its GUI.
|
|
client->setFactory(this);
|
|
|
|
// call the finalizeGUI method, to fix up the positions of toolbars for example.
|
|
// Note: the client argument is ignored
|
|
d->builder->finalizeGUI(d->guiClient);
|
|
|
|
// reset some variables, for safety
|
|
d->BuildState::reset();
|
|
|
|
client->endXMLPlug();
|
|
|
|
d->popState();
|
|
|
|
Q_EMIT clientAdded(client);
|
|
|
|
// build child clients
|
|
const auto children = client->childClients();
|
|
for (KXMLGUIClient *child : children) {
|
|
addClient(child);
|
|
}
|
|
|
|
if (d->emptyState()) {
|
|
Q_EMIT makingChanges(false);
|
|
}
|
|
/*
|
|
QString unaddedActions;
|
|
Q_FOREACH (KActionCollection* ac, KActionCollection::allCollections())
|
|
Q_FOREACH (QAction* action, ac->actions())
|
|
if (action->associatedWidgets().isEmpty())
|
|
unaddedActions += action->objectName() + ' ';
|
|
|
|
if (!unaddedActions.isEmpty())
|
|
qCWarning(DEBUG_KXMLGUI) << "The following actions are not plugged into the gui (shortcuts will not work): " << unaddedActions;
|
|
*/
|
|
|
|
// qCDebug(DEBUG_KXMLGUI) << "addClient took " << dt.elapsed();
|
|
}
|
|
|
|
void KXMLGUIFactory::refreshActionProperties()
|
|
{
|
|
for (KXMLGUIClient *client : std::as_const(d->m_clients)) {
|
|
d->guiClient = client;
|
|
QDomDocument doc = client->xmlguiBuildDocument();
|
|
if (doc.documentElement().isNull()) {
|
|
client->reloadXML();
|
|
doc = client->domDocument();
|
|
}
|
|
d->refreshActionProperties(client, client->actionCollection()->actions(), doc);
|
|
}
|
|
d->guiClient = nullptr;
|
|
}
|
|
|
|
static QString currentShortcutScheme()
|
|
{
|
|
const KConfigGroup cg = KSharedConfig::openConfig()->group(QStringLiteral("Shortcut Schemes"));
|
|
return cg.readEntry("Current Scheme", "Default");
|
|
}
|
|
|
|
// Find the right ActionProperties element, otherwise return null element
|
|
static QDomElement findActionPropertiesElement(const QDomDocument &doc)
|
|
{
|
|
const QLatin1String tagActionProp("ActionProperties");
|
|
const QString schemeName = currentShortcutScheme();
|
|
QDomElement e = doc.documentElement().firstChildElement();
|
|
for (; !e.isNull(); e = e.nextSiblingElement()) {
|
|
if (QString::compare(e.tagName(), tagActionProp, Qt::CaseInsensitive) == 0
|
|
&& (e.attribute(QStringLiteral("scheme"), QStringLiteral("Default")) == schemeName)) {
|
|
return e;
|
|
}
|
|
}
|
|
return QDomElement();
|
|
}
|
|
|
|
void KXMLGUIFactoryPrivate::refreshActionProperties(KXMLGUIClient *client, const QList<QAction *> &actions, const QDomDocument &doc)
|
|
{
|
|
// try to find and apply shortcuts schemes
|
|
const QString schemeName = KShortcutSchemesHelper::currentShortcutSchemeName();
|
|
// qCDebug(DEBUG_KXMLGUI) << client->componentName() << ": applying shortcut scheme" << schemeName;
|
|
|
|
if (schemeName != QLatin1String("Default")) {
|
|
applyShortcutScheme(schemeName, client, actions);
|
|
} else {
|
|
// apply saved default shortcuts
|
|
for (QAction *action : actions) {
|
|
QVariant savedDefaultShortcut = action->property("_k_DefaultShortcut");
|
|
if (savedDefaultShortcut.isValid()) {
|
|
QList<QKeySequence> shortcut = savedDefaultShortcut.value<QList<QKeySequence>>();
|
|
action->setShortcuts(shortcut);
|
|
action->setProperty("defaultShortcuts", QVariant::fromValue(shortcut));
|
|
// qCDebug(DEBUG_KXMLGUI) << "scheme said" << action->shortcut().toString() << "for action" << action->objectName();
|
|
} else {
|
|
action->setShortcuts(QList<QKeySequence>());
|
|
}
|
|
}
|
|
}
|
|
|
|
// try to find and apply user-defined shortcuts
|
|
const QDomElement actionPropElement = findActionPropertiesElement(doc);
|
|
if (!actionPropElement.isNull()) {
|
|
applyActionProperties(actionPropElement);
|
|
}
|
|
}
|
|
|
|
void KXMLGUIFactoryPrivate::saveDefaultActionProperties(const QList<QAction *> &actions)
|
|
{
|
|
// This method is called every time the user activated a new
|
|
// kxmlguiclient. We only want to execute the following code only once in
|
|
// the lifetime of an action.
|
|
for (QAction *action : actions) {
|
|
// Skip nullptr actions or those we have seen already.
|
|
if (!action || action->property("_k_DefaultShortcut").isValid()) {
|
|
continue;
|
|
}
|
|
|
|
// Check if the default shortcut is set
|
|
QList<QKeySequence> defaultShortcut = action->property("defaultShortcuts").value<QList<QKeySequence>>();
|
|
QList<QKeySequence> activeShortcut = action->shortcuts();
|
|
// qCDebug(DEBUG_KXMLGUI) << action->objectName() << "default=" << defaultShortcut.toString() << "active=" << activeShortcut.toString();
|
|
|
|
// Check if we have an empty default shortcut and an non empty
|
|
// custom shortcut. Print out a warning and correct the mistake.
|
|
if ((!activeShortcut.isEmpty()) && defaultShortcut.isEmpty()) {
|
|
qCCritical(DEBUG_KXMLGUI) << "Shortcut for action " << action->objectName() << action->text()
|
|
<< "set with QAction::setShortcut()! Use KActionCollection::setDefaultShortcut(s) instead.";
|
|
action->setProperty("_k_DefaultShortcut", QVariant::fromValue(activeShortcut));
|
|
} else {
|
|
action->setProperty("_k_DefaultShortcut", QVariant::fromValue(defaultShortcut));
|
|
}
|
|
}
|
|
}
|
|
|
|
void KXMLGUIFactory::changeShortcutScheme(const QString &scheme)
|
|
{
|
|
qCDebug(DEBUG_KXMLGUI) << "Changing shortcut scheme to" << scheme;
|
|
KConfigGroup cg = KSharedConfig::openConfig()->group(QStringLiteral("Shortcut Schemes"));
|
|
cg.writeEntry("Current Scheme", scheme);
|
|
|
|
refreshActionProperties();
|
|
}
|
|
|
|
void KXMLGUIFactory::forgetClient(KXMLGUIClient *client)
|
|
{
|
|
d->m_clients.erase(std::remove(d->m_clients.begin(), d->m_clients.end(), client), d->m_clients.end());
|
|
}
|
|
|
|
void KXMLGUIFactory::removeClient(KXMLGUIClient *client)
|
|
{
|
|
// qCDebug(DEBUG_KXMLGUI) << client;
|
|
|
|
// don't try to remove the client's GUI if we didn't build it
|
|
if (!client || client->factory() != this) {
|
|
return;
|
|
}
|
|
|
|
if (d->emptyState()) {
|
|
Q_EMIT makingChanges(true);
|
|
}
|
|
|
|
// remove this client from our client list
|
|
forgetClient(client);
|
|
|
|
// remove child clients first (create a copy of the list just in case the
|
|
// original list is modified directly or indirectly in removeClient())
|
|
const QList<KXMLGUIClient *> childClients(client->childClients());
|
|
for (KXMLGUIClient *child : childClients) {
|
|
removeClient(child);
|
|
}
|
|
|
|
// qCDebug(DEBUG_KXMLGUI) << "calling removeRecursive";
|
|
|
|
d->pushState();
|
|
|
|
// cache some variables
|
|
|
|
d->guiClient = client;
|
|
d->clientName = client->domDocument().documentElement().attribute(d->attrName);
|
|
d->clientBuilder = client->clientBuilder();
|
|
|
|
client->setFactory(nullptr);
|
|
|
|
// if we don't have a build document for that client, yet, then create one by
|
|
// cloning the original document, so that saving container information in the
|
|
// DOM tree does not touch the original document.
|
|
QDomDocument doc = client->xmlguiBuildDocument();
|
|
if (doc.documentElement().isNull()) {
|
|
doc = client->domDocument().cloneNode(true).toDocument();
|
|
client->setXMLGUIBuildDocument(doc);
|
|
}
|
|
|
|
d->m_rootNode->destruct(doc.documentElement(), *d);
|
|
|
|
// reset some variables
|
|
d->BuildState::reset();
|
|
|
|
// This will destruct the KAccel object built around the given widget.
|
|
client->prepareXMLUnplug(d->builder->widget());
|
|
|
|
d->popState();
|
|
|
|
if (d->emptyState()) {
|
|
Q_EMIT makingChanges(false);
|
|
}
|
|
|
|
Q_EMIT clientRemoved(client);
|
|
}
|
|
|
|
QList<KXMLGUIClient *> KXMLGUIFactory::clients() const
|
|
{
|
|
return d->m_clients;
|
|
}
|
|
|
|
QWidget *KXMLGUIFactory::container(const QString &containerName, KXMLGUIClient *client, bool useTagName)
|
|
{
|
|
d->pushState();
|
|
d->m_containerName = containerName;
|
|
d->guiClient = client;
|
|
|
|
QWidget *result = d->findRecursive(d->m_rootNode, useTagName);
|
|
|
|
d->guiClient = nullptr;
|
|
d->m_containerName.clear();
|
|
|
|
d->popState();
|
|
|
|
return result;
|
|
}
|
|
|
|
QList<QWidget *> KXMLGUIFactory::containers(const QString &tagName)
|
|
{
|
|
return d->findRecursive(d->m_rootNode, tagName);
|
|
}
|
|
|
|
void KXMLGUIFactory::reset()
|
|
{
|
|
d->m_rootNode->reset();
|
|
|
|
d->m_rootNode->clearChildren();
|
|
}
|
|
|
|
void KXMLGUIFactory::resetContainer(const QString &containerName, bool useTagName)
|
|
{
|
|
if (containerName.isEmpty()) {
|
|
return;
|
|
}
|
|
|
|
ContainerNode *container = d->m_rootNode->findContainer(containerName, useTagName);
|
|
if (container && container->parent) {
|
|
container->parent->removeChild(container);
|
|
}
|
|
}
|
|
|
|
QWidget *KXMLGUIFactoryPrivate::findRecursive(KXMLGUI::ContainerNode *node, bool tag)
|
|
{
|
|
if (((!tag && node->name == m_containerName) || (tag && node->tagName == m_containerName)) //
|
|
&& (!guiClient || node->client == guiClient)) {
|
|
return node->container;
|
|
}
|
|
|
|
for (ContainerNode *child : std::as_const(node->children)) {
|
|
QWidget *cont = findRecursive(child, tag);
|
|
if (cont) {
|
|
return cont;
|
|
}
|
|
}
|
|
|
|
return nullptr;
|
|
}
|
|
|
|
// Case insensitive equality without calling toLower which allocates a new string
|
|
static inline bool equals(const QString &str1, const char *str2)
|
|
{
|
|
return str1.compare(QLatin1String(str2), Qt::CaseInsensitive) == 0;
|
|
}
|
|
static inline bool equals(const QString &str1, const QString &str2)
|
|
{
|
|
return str1.compare(str2, Qt::CaseInsensitive) == 0;
|
|
}
|
|
|
|
QList<QWidget *> KXMLGUIFactoryPrivate::findRecursive(KXMLGUI::ContainerNode *node, const QString &tagName)
|
|
{
|
|
QList<QWidget *> res;
|
|
|
|
if (equals(node->tagName, tagName)) {
|
|
res.append(node->container);
|
|
}
|
|
|
|
for (KXMLGUI::ContainerNode *child : std::as_const(node->children)) {
|
|
res << findRecursive(child, tagName);
|
|
}
|
|
|
|
return res;
|
|
}
|
|
|
|
void KXMLGUIFactory::plugActionList(KXMLGUIClient *client, const QString &name, const QList<QAction *> &actionList)
|
|
{
|
|
d->pushState();
|
|
d->guiClient = client;
|
|
d->actionListName = name;
|
|
d->actionList = actionList;
|
|
d->clientName = client->domDocument().documentElement().attribute(d->attrName);
|
|
|
|
d->m_rootNode->plugActionList(*d);
|
|
|
|
// Load shortcuts for these new actions
|
|
d->saveDefaultActionProperties(actionList);
|
|
d->refreshActionProperties(client, actionList, client->domDocument());
|
|
|
|
d->BuildState::reset();
|
|
d->popState();
|
|
}
|
|
|
|
void KXMLGUIFactory::unplugActionList(KXMLGUIClient *client, const QString &name)
|
|
{
|
|
d->pushState();
|
|
d->guiClient = client;
|
|
d->actionListName = name;
|
|
d->clientName = client->domDocument().documentElement().attribute(d->attrName);
|
|
|
|
d->m_rootNode->unplugActionList(*d);
|
|
|
|
d->BuildState::reset();
|
|
d->popState();
|
|
}
|
|
|
|
void KXMLGUIFactoryPrivate::applyActionProperties(const QDomElement &actionPropElement, ShortcutOption shortcutOption)
|
|
{
|
|
for (QDomElement e = actionPropElement.firstChildElement(); !e.isNull(); e = e.nextSiblingElement()) {
|
|
if (!equals(e.tagName(), "action")) {
|
|
continue;
|
|
}
|
|
|
|
QAction *action = guiClient->action(e);
|
|
if (!action) {
|
|
continue;
|
|
}
|
|
|
|
configureAction(action, e.attributes(), shortcutOption);
|
|
}
|
|
}
|
|
|
|
void KXMLGUIFactoryPrivate::configureAction(QAction *action, const QDomNamedNodeMap &attributes, ShortcutOption shortcutOption)
|
|
{
|
|
for (int i = 0; i < attributes.length(); i++) {
|
|
QDomAttr attr = attributes.item(i).toAttr();
|
|
if (attr.isNull()) {
|
|
continue;
|
|
}
|
|
|
|
configureAction(action, attr, shortcutOption);
|
|
}
|
|
}
|
|
|
|
void KXMLGUIFactoryPrivate::configureAction(QAction *action, const QDomAttr &attribute, ShortcutOption shortcutOption)
|
|
{
|
|
QString attrName = attribute.name();
|
|
// If the attribute is a deprecated "accel", change to "shortcut".
|
|
if (equals(attrName, "accel")) {
|
|
attrName = QStringLiteral("shortcut");
|
|
}
|
|
|
|
// No need to re-set name, particularly since it's "objectName" in Qt4
|
|
if (equals(attrName, "name")) {
|
|
return;
|
|
}
|
|
|
|
if (equals(attrName, "icon")) {
|
|
action->setIcon(QIcon::fromTheme(attribute.value()));
|
|
return;
|
|
}
|
|
|
|
QVariant propertyValue;
|
|
|
|
const int propertyType = action->property(attrName.toLatin1().constData()).typeId();
|
|
bool isShortcut = (propertyType == QMetaType::QKeySequence);
|
|
|
|
if (propertyType == QMetaType::Int) {
|
|
propertyValue = QVariant(attribute.value().toInt());
|
|
} else if (propertyType == QMetaType::UInt) {
|
|
propertyValue = QVariant(attribute.value().toUInt());
|
|
} else if (isShortcut) {
|
|
// Setting the shortcut by property also sets the default shortcut (which is incorrect), so we have to do it directly
|
|
if (attrName == QLatin1String("globalShortcut")) {
|
|
#if HAVE_GLOBALACCEL
|
|
KGlobalAccel::self()->setShortcut(action, QKeySequence::listFromString(attribute.value()));
|
|
#endif
|
|
} else {
|
|
action->setShortcuts(QKeySequence::listFromString(attribute.value()));
|
|
}
|
|
if (shortcutOption & KXMLGUIFactoryPrivate::SetDefaultShortcut) {
|
|
action->setProperty("defaultShortcuts", QVariant::fromValue(QKeySequence::listFromString(attribute.value())));
|
|
}
|
|
} else {
|
|
propertyValue = QVariant(attribute.value());
|
|
}
|
|
if (!isShortcut && !action->setProperty(attrName.toLatin1().constData(), propertyValue)) {
|
|
qCWarning(DEBUG_KXMLGUI) << "Error: Unknown action property " << attrName << " will be ignored!";
|
|
}
|
|
}
|
|
|
|
void KXMLGUIFactoryPrivate::applyShortcutScheme(const QString &schemeName, KXMLGUIClient *client, const QList<QAction *> &actions)
|
|
{
|
|
// First clear all existing shortcuts
|
|
for (QAction *action : actions) {
|
|
action->setShortcuts(QList<QKeySequence>());
|
|
// We clear the default shortcut as well because the shortcut scheme will set its own defaults
|
|
action->setProperty("defaultShortcuts", QVariant::fromValue(QList<QKeySequence>()));
|
|
}
|
|
|
|
// Find the document for the shortcut scheme using the current application path.
|
|
// This allows to install a single XML file for a shortcut scheme for kdevelop
|
|
// rather than 10.
|
|
// Also look for the current xmlguiclient path.
|
|
// Per component xml files make sense for making kmail shortcuts available in kontact.
|
|
QString schemeFileName = KShortcutSchemesHelper::shortcutSchemeFileName(client->componentName(), schemeName);
|
|
if (schemeFileName.isEmpty()) {
|
|
schemeFileName = KShortcutSchemesHelper::applicationShortcutSchemeFileName(schemeName);
|
|
}
|
|
if (schemeFileName.isEmpty()) {
|
|
qCWarning(DEBUG_KXMLGUI) << client->componentName() << ": shortcut scheme file not found:" << schemeName << "after trying"
|
|
<< QCoreApplication::applicationName() << "and" << client->componentName();
|
|
return;
|
|
}
|
|
|
|
QDomDocument scheme;
|
|
QFile schemeFile(schemeFileName);
|
|
if (schemeFile.open(QIODevice::ReadOnly)) {
|
|
qCDebug(DEBUG_KXMLGUI) << client->componentName() << ": found shortcut scheme XML" << schemeFileName;
|
|
scheme.setContent(&schemeFile);
|
|
}
|
|
|
|
if (scheme.isNull()) {
|
|
return;
|
|
}
|
|
|
|
QDomElement docElement = scheme.documentElement();
|
|
QDomElement actionPropElement = docElement.namedItem(QStringLiteral("ActionProperties")).toElement();
|
|
|
|
// Check if we really have the shortcut configuration here
|
|
if (!actionPropElement.isNull()) {
|
|
// qCDebug(DEBUG_KXMLGUI) << "Applying shortcut scheme for XMLGUI client" << client->componentName();
|
|
|
|
// Apply all shortcuts we have
|
|
applyActionProperties(actionPropElement, KXMLGUIFactoryPrivate::SetDefaultShortcut);
|
|
//} else {
|
|
// qCDebug(DEBUG_KXMLGUI) << "Invalid shortcut scheme file";
|
|
}
|
|
}
|
|
|
|
void KXMLGUIFactory::showConfigureShortcutsDialog()
|
|
{
|
|
auto *dlg = new KShortcutsDialog(qobject_cast<QWidget *>(parent()));
|
|
dlg->setAttribute(Qt::WA_DeleteOnClose);
|
|
|
|
for (KXMLGUIClient *client : std::as_const(d->m_clients)) {
|
|
if (client) {
|
|
qCDebug(DEBUG_KXMLGUI) << "Adding collection from client" << client->componentName() << "with" << client->actionCollection()->count() << "actions";
|
|
|
|
dlg->addCollection(client->actionCollection(), client->componentName());
|
|
}
|
|
}
|
|
|
|
connect(dlg, &KShortcutsDialog::saved, this, &KXMLGUIFactory::shortcutsSaved);
|
|
dlg->configure(true /*save settings on accept*/);
|
|
}
|
|
|
|
// Find or create
|
|
QDomElement KXMLGUIFactory::actionPropertiesElement(QDomDocument &doc)
|
|
{
|
|
// first, lets see if we have existing properties
|
|
QDomElement elem = findActionPropertiesElement(doc);
|
|
|
|
// if there was none, create one
|
|
if (elem.isNull()) {
|
|
elem = doc.createElement(QStringLiteral("ActionProperties"));
|
|
elem.setAttribute(QStringLiteral("scheme"), currentShortcutScheme());
|
|
doc.documentElement().appendChild(elem);
|
|
}
|
|
return elem;
|
|
}
|
|
|
|
QDomElement KXMLGUIFactory::findActionByName(QDomElement &elem, const QString &sName, bool create)
|
|
{
|
|
const QLatin1String attrName("name");
|
|
for (QDomNode it = elem.firstChild(); !it.isNull(); it = it.nextSibling()) {
|
|
QDomElement e = it.toElement();
|
|
if (e.attribute(attrName) == sName) {
|
|
return e;
|
|
}
|
|
}
|
|
|
|
if (create) {
|
|
QDomElement act_elem = elem.ownerDocument().createElement(QStringLiteral("Action"));
|
|
act_elem.setAttribute(attrName, sName);
|
|
elem.appendChild(act_elem);
|
|
return act_elem;
|
|
}
|
|
return QDomElement();
|
|
}
|
|
|
|
#include "moc_kxmlguifactory.cpp"
|