kxmlguiversionhandler.cpp File Reference

#include "kxmlguiversionhandler_p.h"
#include "kxmlguifactory.h"
#include <QFile>
#include <QDomDocument>
#include <QDomElement>
#include <QStandardPaths>
#include <QMap>

Go to the source code of this file.

Classes
struct	DocStruct

Typedefs
typedef QMap< QString, QMap< QString, QString > >	ActionPropertiesMap

Functions
static ActionPropertiesMap	extractActionProperties (const QDomDocument &doc)
static QList< QDomElement >	extractToolBars (const QDomDocument &doc)
static void	insertToolBars (QDomDocument &doc, const QList< QDomElement > &toolBars)
static void	removeToolBars (QDomDocument &doc, const QStringList &toolBarNames)
static void	storeActionProperties (QDomDocument &doc, const ActionPropertiesMap &properties)
static QStringList	toolBarNames (const QList< QDomElement > &toolBars)

Typedef Documentation

ActionPropertiesMap

typedef QMap<QString, QMap<QString, QString> > ActionPropertiesMap

Definition at line 75 of file kxmlguiversionhandler.cpp.

Function Documentation

extractActionProperties()

static ActionPropertiesMap extractActionProperties ( const QDomDocument & doc )

static

Definition at line 77 of file kxmlguiversionhandler.cpp.

{
    ActionPropertiesMap properties;
 
    QDomElement actionPropElement = doc.documentElement().namedItem(QStringLiteral("ActionProperties")).toElement();
 
    if (actionPropElement.isNull()) {
        return properties;
    }
 
    QDomNode n = actionPropElement.firstChild();
    while (!n.isNull()) {
        QDomElement e = n.toElement();
        n = n.nextSibling(); // Advance now so that we can safely delete e
        if (e.isNull()) {
            continue;
        }
 
        if (e.tagName().compare(QStringLiteral("action"), Qt::CaseInsensitive) != 0) {
            continue;
        }
 
        const QString actionName = e.attribute(QStringLiteral("name"));
        if (actionName.isEmpty()) {
            continue;
        }
 
        QMap<QString, QMap<QString, QString> >::Iterator propIt = properties.find(actionName);
        if (propIt == properties.end()) {
            propIt = properties.insert(actionName, QMap<QString, QString>());
        }
 
        const QDomNamedNodeMap attributes = e.attributes();
        const uint attributeslength = attributes.length();
 
        for (uint i = 0; i < attributeslength; ++i) {
            const QDomAttr attr = attributes.item(i).toAttr();
 
            if (attr.isNull()) {
                continue;
            }
 
            const QString name = attr.name();
 
            if (name == QStringLiteral("name") || name.isEmpty()) {
                continue;
            }
 
            (*propIt)[ name ] = attr.value();
        }
 
    }
 
    return properties;
}

extractToolBars()

static QList< QDomElement > extractToolBars ( const QDomDocument & doc )

static

Definition at line 24 of file kxmlguiversionhandler.cpp.

{
    QList<QDomElement> toolbars;
    QDomElement parent = doc.documentElement();
    for (QDomElement e = parent.firstChildElement(); !e.isNull(); e = e.nextSiblingElement()) {
        if (e.tagName().compare(QStringLiteral("ToolBar"), Qt::CaseInsensitive) == 0) {
            toolbars.append(e);
        }
    }
    return toolbars;
}

insertToolBars()

static void insertToolBars ( QDomDocument & doc, const QList< QDomElement > & toolBars )

static

Definition at line 59 of file kxmlguiversionhandler.cpp.

{
    QDomElement parent = doc.documentElement();
    QDomElement menuBar = parent.namedItem(QStringLiteral("MenuBar")).toElement();
    QDomElement insertAfter = menuBar;
    if (menuBar.isNull()) {
        insertAfter = parent.firstChildElement();    // if null, insertAfter will do an append
    }
    Q_FOREACH (const QDomElement &e, toolBars) {
        QDomNode result = parent.insertAfter(e, insertAfter);
        Q_ASSERT(!result.isNull());
    }
}

removeToolBars()

static void removeToolBars ( QDomDocument & doc, const QStringList & toolBarNames )

static

Definition at line 46 of file kxmlguiversionhandler.cpp.

{
    QDomElement parent = doc.documentElement();
    const QList<QDomElement> toolBars = extractToolBars(doc);
    Q_FOREACH (const QDomElement &e, toolBars) {
        if (toolBarNames.contains(e.attribute(QStringLiteral("name")))) {
            parent.removeChild(e);
        }
 
    }
}

References extractToolBars(), and toolBarNames().

storeActionProperties()

static void storeActionProperties ( QDomDocument & doc, const ActionPropertiesMap & properties )

static

Definition at line 133 of file kxmlguiversionhandler.cpp.

{
    QDomElement actionPropElement = doc.documentElement().namedItem(QStringLiteral("ActionProperties")).toElement();
 
    if (actionPropElement.isNull()) {
        actionPropElement = doc.createElement(QStringLiteral("ActionProperties"));
        doc.documentElement().appendChild(actionPropElement);
    }
 
//Remove only those ActionProperties entries from the document, that are present
//in the properties argument. In real life this means that local ActionProperties
//takes precedence over global ones, if they exists (think local override of shortcuts).
    QDomNode actionNode = actionPropElement.firstChild();
    while (!actionNode.isNull()) {
        if (properties.contains(actionNode.toElement().attribute(QStringLiteral("name")))) {
            QDomNode nextNode = actionNode.nextSibling();
            actionPropElement.removeChild(actionNode);
            actionNode = nextNode;
        } else {
            actionNode = actionNode.nextSibling();
        }
    }
 
    ActionPropertiesMap::ConstIterator it = properties.begin();
    const ActionPropertiesMap::ConstIterator end = properties.end();
    for (; it != end; ++it) {
        QDomElement action = doc.createElement(QStringLiteral("Action"));
        action.setAttribute(QStringLiteral("name"), it.key());
        actionPropElement.appendChild(action);
 
        const QMap<QString, QString> attributes = (*it);
        QMap<QString, QString>::ConstIterator attrIt = attributes.begin();
        const QMap<QString, QString>::ConstIterator attrEnd = attributes.end();
        for (; attrIt != attrEnd; ++attrIt) {
            action.setAttribute(attrIt.key(), attrIt.value());
        }
    }
}

toolBarNames()

static QStringList toolBarNames ( const QList< QDomElement > & toolBars )

static

Definition at line 36 of file kxmlguiversionhandler.cpp.

{
    QStringList names;
    names.reserve(toolBars.count());
    for (const QDomElement &e : toolBars) {
        names.append(e.attribute(QStringLiteral("name")));
    }
    return names;
}