Public Member Functions
void	_k_actionDestroyed (QObject *obj)

void	_k_associatedWidgetDestroyed (QObject *obj)

	KisKActionCollectionPrivate ()

void	setComponentForAction (QAction *action)

QAction *	unlistAction (QObject *)

bool	writeKisKXMLGUIConfigFile ()

Public Attributes
QMap< QString, QAction * >	actionByName

QList< QAction * >	actions

QList< QWidget * >	associatedWidgets

QString	configGroup

bool	connectHovered {false}

bool	connectTriggered {false}

QString	m_componentDisplayName

QString	m_componentName

const KisKXMLGUIClient *	m_parentGUIClient {nullptr}

KisKActionCollection *	q {nullptr}

Static Public Attributes
static QList< KisKActionCollection * >	s_allCollections

Detailed Description

Definition at line 42 of file kactioncollection.cpp.

Constructor & Destructor Documentation

◆ KisKActionCollectionPrivate()

KisKActionCollectionPrivate::KisKActionCollectionPrivate ( )

inline

Definition at line 45 of file kactioncollection.cpp.

        : m_parentGUIClient(0L),
          configGroup(QStringLiteral("Shortcuts")),
          q(0)
 
    {
    }

Member Function Documentation

◆ _k_actionDestroyed()

void KisKActionCollectionPrivate::_k_actionDestroyed ( QObject * obj )

Definition at line 608 of file kactioncollection.cpp.

{
    unlistAction(obj);
}

References unlistAction().

◆ _k_associatedWidgetDestroyed()

void KisKActionCollectionPrivate::_k_associatedWidgetDestroyed ( QObject * obj )

Definition at line 735 of file kactioncollection.cpp.

{
    associatedWidgets.removeAll(static_cast<QWidget *>(obj));
}

References associatedWidgets.

◆ setComponentForAction()

void KisKActionCollectionPrivate::setComponentForAction ( QAction * action )

inline

Definition at line 53 of file kactioncollection.cpp.

    {
        Q_UNUSED(action);
    }

◆ unlistAction()

QAction * KisKActionCollectionPrivate::unlistAction ( QObject * action )

Remove a action from our internal bookkeeping. Returns 0 if the action doesn't belong to us.

Definition at line 674 of file kactioncollection.cpp.

{
    // ATTENTION:
    //   This method is called with an QObject formerly known as a QAction
    //   during _k_actionDestroyed(). So don't do fancy stuff here that needs a
    //   real QAction!
 
    // Get the index for the action
    const auto indexOf = [&](const QObject *action, int from = 0) -> int {
        for (int i = from; i < actions.size(); i++) {
            if (actions[i] == action) {
                return i;
            }
        }
        return -1;
    };
 
    int index = indexOf(action);
 
    // Action not found.
    if (index == -1) {
        return 0;
    }
 
    // An action collection can't have the same action twice.
    Q_ASSERT(indexOf(action, index + 1) == -1);
 
    // Get the actions name
    const QString name = action->objectName();
 
    // Remove the action
    actionByName.remove(name);
    // Retrieve the typed QObject* pointer
    // ATTENTION: THIS ACTION IS PARTIALLY DESTROYED!
    QAction *tmp = actions.at(index);
    actions.removeAt(index);
 
    // Remove the action from the categories. Should be only one
    QList<KisKActionCategory *> categories = q->findChildren<KisKActionCategory *>();
    Q_FOREACH (KisKActionCategory *category, categories) {
        category->unlistAction(tmp);
    }
 
    return tmp;
}

References actionByName, actions, q, and KisKActionCategory::unlistAction().

◆ writeKisKXMLGUIConfigFile()

bool KisKActionCollectionPrivate::writeKisKXMLGUIConfigFile ( )

Definition at line 455 of file kactioncollection.cpp.

{
    const KisKXMLGUIClient *kxmlguiClient = q->parentGUIClient();
    // return false if there is no KisKXMLGUIClient
    if (!kxmlguiClient || kxmlguiClient->xmlFile().isEmpty()) {
        return false;
    }
 
 
    QString attrShortcut = QStringLiteral("shortcut");
 
    // Read XML file
    QString sXml(KisKXMLGUIFactory::readConfigFile(kxmlguiClient->xmlFile(), q->componentName()));
    QDomDocument doc;
    doc.setContent(sXml);
 
    // Process XML data
 
    // Get hold of ActionProperties tag
    QDomElement elem = KisKXMLGUIFactory::actionPropertiesElement(doc);
 
    // now, iterate through our actions
    for (QMap<QString, QAction *>::ConstIterator it = actionByName.constBegin();
            it != actionByName.constEnd(); ++it) {
        QAction *action = it.value();
        if (!action) {
            continue;
        }
 
        QString actionName = it.key();
 
        // If the action name starts with unnamed- spit out a warning and ignore
        // it. That name will change at will and will break loading writing
        if (actionName.startsWith(QLatin1String("unnamed-"))) {
            qCritical() << "Skipped writing shortcut for action " << actionName << "(" << action->text() << ")!";
            continue;
        }
 
        bool bSameAsDefault = (action->shortcuts() == q->defaultShortcuts(action));
 
        // now see if this element already exists
        // and create it if necessary (unless bSameAsDefault)
        QDomElement act_elem = KisKXMLGUIFactory::findActionByName(elem, actionName, !bSameAsDefault);
        if (act_elem.isNull()) {
            continue;
        }
 
        if (bSameAsDefault) {
            act_elem.removeAttribute(attrShortcut);
            if (act_elem.attributes().count() == 1) {
                elem.removeChild(act_elem);
            }
        } else {
            act_elem.setAttribute(attrShortcut, QKeySequence::listToString(action->shortcuts()));
        }
    }
 
    // Write back to XML file
    KisKXMLGUIFactory::saveConfigFile(doc, kxmlguiClient->localXMLFile(), q->componentName());
    return true;
}

References actionByName, KisKXMLGUIFactory::actionPropertiesElement(), KisKActionCollection::componentName(), KisKActionCollection::defaultShortcuts(), KisKXMLGUIFactory::findActionByName(), KisKXMLGUIClient::localXMLFile(), KisKActionCollection::parentGUIClient(), q, KisKXMLGUIFactory::readConfigFile(), KisKXMLGUIFactory::saveConfigFile(), and KisKXMLGUIClient::xmlFile().

Member Data Documentation

◆ actionByName

QMap<QString, QAction *> KisKActionCollectionPrivate::actionByName

Definition at line 72 of file kactioncollection.cpp.

◆ actions

QList<QAction *> KisKActionCollectionPrivate::actions

Definition at line 73 of file kactioncollection.cpp.

◆ associatedWidgets

QList<QWidget *> KisKActionCollectionPrivate::associatedWidgets

Definition at line 84 of file kactioncollection.cpp.

◆ configGroup

QString KisKActionCollectionPrivate::configGroup

Definition at line 77 of file kactioncollection.cpp.

◆ connectHovered

bool KisKActionCollectionPrivate::connectHovered {false}

Definition at line 80 of file kactioncollection.cpp.

80{false};

◆ connectTriggered

bool KisKActionCollectionPrivate::connectTriggered {false}

Definition at line 79 of file kactioncollection.cpp.

79{false};

◆ m_componentDisplayName

QString KisKActionCollectionPrivate::m_componentDisplayName

Definition at line 66 of file kactioncollection.cpp.

◆ m_componentName

QString KisKActionCollectionPrivate::m_componentName

Definition at line 65 of file kactioncollection.cpp.

◆ m_parentGUIClient

const KisKXMLGUIClient* KisKActionCollectionPrivate::m_parentGUIClient {nullptr}

Definition at line 75 of file kactioncollection.cpp.

75{nullptr};

◆ q

KisKActionCollection* KisKActionCollectionPrivate::q {nullptr}

Definition at line 82 of file kactioncollection.cpp.

82{nullptr};

◆ s_allCollections

QList< KisKActionCollection * > KisKActionCollectionPrivate::s_allCollections

static

Definition at line 58 of file kactioncollection.cpp.

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

libs/widgetutils/xmlgui/kactioncollection.cpp

Public Member Functions

Public Attributes

Static Public Attributes