KisKXMLGUIFactoryPrivate Class Reference

Inheritance diagram for KisKXMLGUIFactoryPrivate:

Public Types
enum	ShortcutOption { SetActiveShortcut = 1 , SetDefaultShortcut = 2 }

Public Member Functions
void	applyActionProperties (const QDomElement &element, ShortcutOption shortcutOption=KisKXMLGUIFactoryPrivate::SetActiveShortcut)
void	configureAction (QAction *action, const QDomAttr &attribute, ShortcutOption shortcutOption=KisKXMLGUIFactoryPrivate::SetActiveShortcut)
void	configureAction (QAction *action, const QDomNamedNodeMap &attributes, ShortcutOption shortcutOption=KisKXMLGUIFactoryPrivate::SetActiveShortcut)
bool	emptyState () const
QWidget *	findRecursive (KisKXMLGUI::ContainerNode *node, bool tag)
QList< QWidget * >	findRecursive (KisKXMLGUI::ContainerNode *node, const QString &tagName)
	KisKXMLGUIFactoryPrivate ()
void	popState ()
void	pushState ()
void	refreshActionProperties (KisKXMLGUIClient *client, const QList< QAction * > &actions, const QDomDocument &doc)
void	saveDefaultActionProperties (const QList< QAction * > &actions)
	~KisKXMLGUIFactoryPrivate ()
Public Member Functions inherited from KisKXMLGUI::BuildState
	BuildState ()
void	reset ()

Public Attributes
QString	attrName
QList< KisKXMLGUIClient * >	m_clients
QString	m_containerName
QString	m_defaultMergingName
ContainerNode *	m_rootNode
BuildStateStack	m_stateStack
QString	tagActionList
Public Attributes inherited from KisKXMLGUI::BuildState
ActionList	actionList
QString	actionListName
KisKXMLGUIBuilder *	builder
QStringList	builderContainerTags
QStringList	builderCustomTags
KisKXMLGUIBuilder *	clientBuilder
QStringList	clientBuilderContainerTags
QStringList	clientBuilderCustomTags
QString	clientName
MergingIndexList::Iterator	currentClientMergingIt
MergingIndexList::Iterator	currentDefaultMergingIt
KisKXMLGUIClient *	guiClient

Detailed Description

Definition at line 43 of file kxmlguifactory.cpp.

Member Enumeration Documentation

ShortcutOption

enum KisKXMLGUIFactoryPrivate::ShortcutOption

Enumerator
SetActiveShortcut
SetDefaultShortcut

Definition at line 46 of file kxmlguifactory.cpp.

{ SetActiveShortcut = 1, SetDefaultShortcut = 2};

Constructor & Destructor Documentation

KisKXMLGUIFactoryPrivate()

KisKXMLGUIFactoryPrivate::KisKXMLGUIFactoryPrivate ( )

inline

Definition at line 48 of file kxmlguifactory.cpp.

    {
        m_rootNode = new ContainerNode(0L, QString(), QString());
        m_defaultMergingName = QStringLiteral("<default>");
        tagActionList = QStringLiteral("actionlist");
        attrName = QStringLiteral("name");
    }

References attrName, m_defaultMergingName, m_rootNode, and tagActionList.

~KisKXMLGUIFactoryPrivate()

KisKXMLGUIFactoryPrivate::~KisKXMLGUIFactoryPrivate ( )

inline

Definition at line 55 of file kxmlguifactory.cpp.

    {
        delete m_rootNode;
    }

References m_rootNode.

Member Function Documentation

applyActionProperties()

void KisKXMLGUIFactoryPrivate::applyActionProperties	(	const QDomElement &	element,
		ShortcutOption	shortcutOption = KisKXMLGUIFactoryPrivate::SetActiveShortcut )

Definition at line 577 of file kxmlguifactory.cpp.

{
    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);
    }
}

References KisKXMLGUIClient::action(), configureAction(), equals(), and KisKXMLGUI::BuildState::guiClient.

configureAction() [1/2]

void KisKXMLGUIFactoryPrivate::configureAction	(	QAction *	action,
		const QDomAttr &	attribute,
		ShortcutOption	shortcutOption = KisKXMLGUIFactoryPrivate::SetActiveShortcut )

Definition at line 608 of file kxmlguifactory.cpp.

{
    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(KisIconUtils::loadIcon(attribute.value()));
        return;
    }
 
    QVariant propertyValue;
 
    QVariant::Type propertyType = action->property(attrName.toLatin1().constData()).type();
    bool isShortcut = (propertyType == QVariant::KeySequence);
 
    if (propertyType == QVariant::Int) {
        propertyValue = QVariant(attribute.value().toInt());
    } else if (propertyType == QVariant::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
        action->setShortcuts(QKeySequence::listFromString(attribute.value()));
        if (shortcutOption & KisKXMLGUIFactoryPrivate::SetDefaultShortcut) {
            action->setProperty("defaultShortcuts",
                                QVariant::fromValue(QKeySequence::listFromString(attribute.value())));
        }
    } else {
        propertyValue = QVariant(attribute.value());
    }
    if (!isShortcut && !action->setProperty(attrName.toLatin1().constData(), propertyValue)) {
        qWarning() << "Error: Unknown action property " << attrName << " will be ignored!";
    }
}

References attrName, equals(), KisIconUtils::loadIcon(), and SetDefaultShortcut.

configureAction() [2/2]

void KisKXMLGUIFactoryPrivate::configureAction	(	QAction *	action,
		const QDomNamedNodeMap &	attributes,
		ShortcutOption	shortcutOption = KisKXMLGUIFactoryPrivate::SetActiveShortcut )

Definition at line 595 of file kxmlguifactory.cpp.

{
    for (int i = 0; i < attributes.length(); i++) {
        QDomAttr attr = attributes.item(i).toAttr();
        if (attr.isNull()) {
            continue;
        }
 
        configureAction(action, attr, shortcutOption);
    }
}

References configureAction().

emptyState()

bool KisKXMLGUIFactoryPrivate::emptyState ( ) const

inline

Definition at line 70 of file kxmlguifactory.cpp.

    {
        return m_stateStack.isEmpty();
    }

References m_stateStack.

findRecursive() [1/2]

QWidget * KisKXMLGUIFactoryPrivate::findRecursive	(	KisKXMLGUI::ContainerNode *	node,
		bool	tag )

Definition at line 501 of file kxmlguifactory.cpp.

{
    if (((!tag && node->name == m_containerName) ||
            (tag && node->tagName == m_containerName)) &&
            (!guiClient || node->client == guiClient)) {
        return node->container;
    }
 
    Q_FOREACH (ContainerNode *child, node->children) {
        QWidget *cont = findRecursive(child, tag);
        if (cont) {
            return cont;
        }
    }
 
    return 0L;
}

References KisKXMLGUI::ContainerNode::children, KisKXMLGUI::ContainerNode::client, KisKXMLGUI::ContainerNode::container, findRecursive(), KisKXMLGUI::BuildState::guiClient, m_containerName, KisKXMLGUI::ContainerNode::name, and KisKXMLGUI::ContainerNode::tagName.

findRecursive() [2/2]

QList< QWidget * > KisKXMLGUIFactoryPrivate::findRecursive	(	KisKXMLGUI::ContainerNode *	node,
		const QString &	tagName )

Definition at line 529 of file kxmlguifactory.cpp.

{
    QList<QWidget *> res;
 
    if (equals(node->tagName, tagName)) {
        res.append(node->container);
    }
 
    Q_FOREACH (KisKXMLGUI::ContainerNode *child, node->children) {
        res << findRecursive(child, tagName);
    }
 
    return res;
}

References KisKXMLGUI::ContainerNode::children, KisKXMLGUI::ContainerNode::container, equals(), findRecursive(), and KisKXMLGUI::ContainerNode::tagName.

popState()

void KisKXMLGUIFactoryPrivate::popState ( )

inline

Definition at line 65 of file kxmlguifactory.cpp.

    {
        BuildState::operator=(m_stateStack.pop());
    }

References m_stateStack.

pushState()

void KisKXMLGUIFactoryPrivate::pushState ( )

inline

Definition at line 60 of file kxmlguifactory.cpp.

    {
        m_stateStack.push(*this);
    }

References m_stateStack.

refreshActionProperties()

void KisKXMLGUIFactoryPrivate::refreshActionProperties	(	KisKXMLGUIClient *	client,
		const QList< QAction * > &	actions,
		const QDomDocument &	doc )

Definition at line 339 of file kxmlguifactory.cpp.

{
    // These were used for applyShortcutScheme() but not for applyActionProperties()??
    Q_UNUSED(client);
    Q_UNUSED(actions);
 
 
    // try to find and apply user-defined shortcuts
    const QDomElement actionPropElement = findActionPropertiesElement(doc);
    if (!actionPropElement.isNull()) {
        applyActionProperties(actionPropElement);
    }
}

References applyActionProperties(), and findActionPropertiesElement().

saveDefaultActionProperties()

void KisKXMLGUIFactoryPrivate::saveDefaultActionProperties

(

const QList< QAction * > &

actions

)

Definition at line 353 of file kxmlguifactory.cpp.

{
    // 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.
    Q_FOREACH (QAction *action, actions) {
        // Skip 0 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();
        //qDebug() << 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()) {
            action->setProperty("_k_DefaultShortcut", QVariant::fromValue(activeShortcut));
        } else {
            action->setProperty("_k_DefaultShortcut", QVariant::fromValue(defaultShortcut));
        }
    }
}

Member Data Documentation

attrName

QString KisKXMLGUIFactoryPrivate::attrName

Definition at line 104 of file kxmlguifactory.cpp.

m_clients

QList<KisKXMLGUIClient *> KisKXMLGUIFactoryPrivate::m_clients

Definition at line 100 of file kxmlguifactory.cpp.

m_containerName

QString KisKXMLGUIFactoryPrivate::m_containerName

Definition at line 95 of file kxmlguifactory.cpp.

m_defaultMergingName

QString KisKXMLGUIFactoryPrivate::m_defaultMergingName

Definition at line 90 of file kxmlguifactory.cpp.

m_rootNode

ContainerNode* KisKXMLGUIFactoryPrivate::m_rootNode

Definition at line 88 of file kxmlguifactory.cpp.

m_stateStack

BuildStateStack KisKXMLGUIFactoryPrivate::m_stateStack

Definition at line 106 of file kxmlguifactory.cpp.

tagActionList

QString KisKXMLGUIFactoryPrivate::tagActionList

Definition at line 102 of file kxmlguifactory.cpp.

---

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

• libs/widgetutils/xmlgui/kxmlguifactory.cpp