KisShortcutsEditorItem Class Reference

#include <KisShortcutsEditor_p.h>

Inheritance diagram for KisShortcutsEditorItem:

Public Member Functions
void	commit ()
	Commit the changes.
QVariant	data (int column, int role=Qt::DisplayRole) const override
bool	isModified () const
bool	isModified (uint column) const
QKeySequence	keySequence (uint column) const
	KisShortcutsEditorItem (QTreeWidgetItem *parent, QAction *action)
bool	operator< (const QTreeWidgetItem &other) const override
void	setKeySequence (uint column, const QKeySequence &seq)
void	setNameBold (bool flag)
void	undo ()
	Undo the changes since the last commit.
	~KisShortcutsEditorItem () override
	Destructor will erase unsaved changes.

Private Member Functions
void	updateModified ()
	Recheck modified status - could have changed back to initial value.

Private Attributes
QAction *	m_action
	The action this item is responsible for.
QString	m_actionNameInTable
	The localized action name.
QCollator	m_collator
	The collator, for sorting.
QString	m_id
	The action id. Needed for exporting and importing.
bool	m_isNameBold {false}
	Should the Name column be painted in bold?
QList< QKeySequence > *	m_oldLocalShortcut {0}
	The original shortcuts before user changes. 0 means no change.

Friends
class	KisShortcutsEditorPrivate

Detailed Description

A QTreeWidgetItem that can handle QActions. It also provides undo functionality.

Call commit() to save pending changes.

Definition at line 118 of file KisShortcutsEditor_p.h.

Constructor & Destructor Documentation

KisShortcutsEditorItem()

KisShortcutsEditorItem::KisShortcutsEditorItem	(	QTreeWidgetItem *	parent,
		QAction *	action )

Definition at line 21 of file KisShortcutsEditorItem.cpp.

    : QTreeWidgetItem(parent, ActionItem)
    , m_action(action)
{
    // Filtering message requested by translators (scripting).
    m_id = m_action->objectName();
    m_actionNameInTable = i18nc("@item:intable Action name in shortcuts configuration",
                                "%1", KLocalizedString::removeAcceleratorMarker(m_action->text()));
    if (m_actionNameInTable.isEmpty()) {
        warnKrita << "Action without text!" << m_action->objectName();
        m_actionNameInTable = m_id;
    }
 
    m_collator.setNumericMode(true);
    m_collator.setCaseSensitivity(Qt::CaseSensitive);
 
    // qDebug() << "Adding new action" << m_id << "with shortcut" << keySequence(LocalPrimary).toString();
}

References m_action, m_actionNameInTable, m_collator, m_id, and warnKrita.

~KisShortcutsEditorItem()

KisShortcutsEditorItem::~KisShortcutsEditorItem ( )

override

Destructor will erase unsaved changes.

Definition at line 40 of file KisShortcutsEditorItem.cpp.

{
    delete m_oldLocalShortcut;
}

References m_oldLocalShortcut.

Member Function Documentation

commit()

void KisShortcutsEditorItem::commit

(

)

Commit the changes.

Definition at line 226 of file KisShortcutsEditorItem.cpp.

{
    if (m_oldLocalShortcut) { // || m_oldShapeGesture || m_oldRockerGesture) {
       dbgUI << "Committing changes for " << data(Name, Qt::DisplayRole).toString();
    }
 
    delete m_oldLocalShortcut;
    m_oldLocalShortcut = 0;
}

References data(), dbgUI, m_oldLocalShortcut, and Name.

data()

QVariant KisShortcutsEditorItem::data ( int column, int role = Qt::DisplayRole ) const

override

Definition at line 50 of file KisShortcutsEditorItem.cpp.

{
    switch (role) {
    case Qt::DisplayRole:
        switch (column) {
        case Name:
            return m_actionNameInTable;
        case Id:
            return m_id;
        case LocalPrimary:
        case LocalAlternate:
            return QVariant::fromValue(keySequence(column));
        default:
            break;
        }
        break;
    case Qt::DecorationRole:
        if (column == Name) {
            return m_action->icon();
        } else {
            return QIcon();
        }
        break;
    case Qt::WhatsThisRole:
        return m_action->whatsThis();
    case Qt::ToolTipRole:
        // TODO: show command descriptions/tooltips in the shortcut editor
        return QVariant();
    case Qt::FontRole:
        if (column == Name && m_isNameBold) {
            QFont modifiedFont = treeWidget()->font();
            modifiedFont.setBold(true);
            return modifiedFont;
        }
        break;
    case KExtendableItemDelegate::ShowExtensionIndicatorRole:
        switch (column) {
        case Name:
            return false;
        case LocalPrimary:
        case LocalAlternate:
            return !m_action->property("isShortcutConfigurable").isValid()
                   || m_action->property("isShortcutConfigurable").toBool();
        default:
            return false;
        }
    //the following are custom roles, defined in this source file only
    case ShortcutRole:
        switch (column) {
        case LocalPrimary:
        case LocalAlternate:
            return QVariant::fromValue(keySequence(column));
        default:
            // Column not valid for this role
            Q_ASSERT(false);
            return QVariant();
        }
 
    case DefaultShortcutRole: {
 
        // Note: we are using the QMetaObject system to store this property.
        QList<QKeySequence> defaultShortcuts = m_action->property("defaultShortcuts").value<QList<QKeySequence> >();
 
        switch (column) {
        case LocalPrimary:
            return QVariant::fromValue(primarySequence(defaultShortcuts));
        case LocalAlternate:
            return QVariant::fromValue(alternateSequence(defaultShortcuts));
        default:
            // Column not valid for this role
            Q_ASSERT(false);
            return QVariant();
        }
    }
    case ObjectRole:
        return QVariant::fromValue((QObject *)m_action);
 
    default:
        break;
    }
 
    return QVariant();
}

References alternateSequence(), DefaultShortcutRole, Id, keySequence(), LocalAlternate, LocalPrimary, m_action, m_actionNameInTable, m_id, m_isNameBold, Name, ObjectRole, primarySequence(), and ShortcutRole.

isModified() [1/2]

bool KisShortcutsEditorItem::isModified

(

)

const

Definition at line 45 of file KisShortcutsEditorItem.cpp.

{
    return m_oldLocalShortcut;
}

References m_oldLocalShortcut.

isModified() [2/2]

bool KisShortcutsEditorItem::isModified

(

uint

column

)

const

Definition at line 194 of file KisShortcutsEditorItem.cpp.

{
    switch (column) {
    case Name:
        return false;
    case LocalPrimary:
    case LocalAlternate:
        if (!m_oldLocalShortcut) {
            return false;
        }
        if (column == LocalPrimary) {
            return primarySequence(*m_oldLocalShortcut) != primarySequence(m_action->shortcuts());
        } else {
            return alternateSequence(*m_oldLocalShortcut) != alternateSequence(m_action->shortcuts());
        }
    default:
        return false;
    }
}

References alternateSequence(), LocalAlternate, LocalPrimary, m_action, m_oldLocalShortcut, Name, and primarySequence().

keySequence()

QKeySequence KisShortcutsEditorItem::keySequence

(

uint

column

)

const

Definition at line 140 of file KisShortcutsEditorItem.cpp.

{
    QList<QKeySequence> shortcuts = m_action->shortcuts();
 
    switch (column) {
    case LocalPrimary:
        return primarySequence(shortcuts);
    case LocalAlternate:
        return alternateSequence(shortcuts);
    default:
        return QKeySequence();
    }
}

References alternateSequence(), LocalAlternate, LocalPrimary, m_action, and primarySequence().

operator<()

bool KisShortcutsEditorItem::operator< ( const QTreeWidgetItem & other ) const

override

Definition at line 134 of file KisShortcutsEditorItem.cpp.

{
    const int column = treeWidget() ? treeWidget()->sortColumn() : 0;
    return m_collator.compare(text(column), other.text(column)) < 0;
}

References m_collator.

setKeySequence()

void KisShortcutsEditorItem::setKeySequence	(	uint	column,
		const QKeySequence &	seq )

Definition at line 154 of file KisShortcutsEditorItem.cpp.

{
    QList<QKeySequence> ks;
    ks = m_action->shortcuts();
    if (!m_oldLocalShortcut) {
        m_oldLocalShortcut = new QList<QKeySequence>(ks);
    }
 
    if (column == LocalAlternate) {
        if (ks.isEmpty()) {
            ks << QKeySequence();
        }
 
        if (ks.size() <= 1) {
            ks << seq;
        } else {
            ks[1] = seq;
        }
    } else {
        if (ks.isEmpty()) {
            ks << seq;
        } else {
            ks[0] = seq;
        }
    }
 
    m_action->setShortcuts(ks);
 
    updateModified();
}

References LocalAlternate, m_action, m_oldLocalShortcut, and updateModified().

setNameBold()

void KisShortcutsEditorItem::setNameBold ( bool flag )

inline

Definition at line 142 of file KisShortcutsEditor_p.h.

    {
        m_isNameBold = flag;
    }

References m_isNameBold.

undo()

void KisShortcutsEditorItem::undo

(

)

Undo the changes since the last commit.

Definition at line 214 of file KisShortcutsEditorItem.cpp.

{
    //dbgKrita << "Undoing changes for " << data(Name, Qt::DisplayRole).toString();
 
    if (m_oldLocalShortcut) {
        // We only ever reset the active Shortcut
        m_action->setShortcuts(*m_oldLocalShortcut);
    }
 
    updateModified();
}

References m_action, m_oldLocalShortcut, and updateModified().

updateModified()

void KisShortcutsEditorItem::updateModified ( )

private

Recheck modified status - could have changed back to initial value.

Definition at line 186 of file KisShortcutsEditorItem.cpp.

{
    if (m_oldLocalShortcut && *m_oldLocalShortcut == m_action->shortcuts()) {
        delete m_oldLocalShortcut;
        m_oldLocalShortcut = 0;
    }
}

References m_action, and m_oldLocalShortcut.

Friends And Related Symbol Documentation

KisShortcutsEditorPrivate

friend class KisShortcutsEditorPrivate

friend

Definition at line 148 of file KisShortcutsEditor_p.h.

Member Data Documentation

m_action

QAction* KisShortcutsEditorItem::m_action

private

The action this item is responsible for.

Definition at line 154 of file KisShortcutsEditor_p.h.

m_actionNameInTable

QString KisShortcutsEditorItem::m_actionNameInTable

private

The localized action name.

Definition at line 165 of file KisShortcutsEditor_p.h.

m_collator

QCollator KisShortcutsEditorItem::m_collator

private

The collator, for sorting.

Definition at line 171 of file KisShortcutsEditor_p.h.

m_id

QString KisShortcutsEditorItem::m_id

private

The action id. Needed for exporting and importing.

Definition at line 168 of file KisShortcutsEditor_p.h.

m_isNameBold

bool KisShortcutsEditorItem::m_isNameBold {false}

private

Should the Name column be painted in bold?

Definition at line 157 of file KisShortcutsEditor_p.h.

{false};

m_oldLocalShortcut

QList<QKeySequence>* KisShortcutsEditorItem::m_oldLocalShortcut {0}

private

The original shortcuts before user changes. 0 means no change.

Definition at line 161 of file KisShortcutsEditor_p.h.

{0};

---

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

• libs/widgetutils/xmlgui/KisShortcutsEditor_p.h
• libs/widgetutils/xmlgui/KisShortcutsEditorItem.cpp