KisActionShortcutsModel Class Reference

A QAbstractListModel subclass that lists shortcuts associated with an action from a profile. More...

#include <kis_action_shortcuts_model.h>

Inheritance diagram for KisActionShortcutsModel:

Classes
class	Private

Public Slots
void	setAction (KisAbstractInputAction *action)
void	setProfile (KisInputProfile *profile)

Public Member Functions
KisAbstractInputAction *	action () const
bool	canRemoveRow (int row) const
int	columnCount (const QModelIndex &) const override
QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override
Qt::ItemFlags	flags (const QModelIndex &index) const override
QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override
	KisActionShortcutsModel (QObject *parent=0)
KisInputProfile *	profile () const
bool	removeRows (int row, int count, const QModelIndex &parent=QModelIndex()) override
int	rowCount (const QModelIndex &parent=QModelIndex()) const override
bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override
	~KisActionShortcutsModel () override

Private Slots
void	currentProfileChanged ()

Private Attributes
Private *const	d

Detailed Description

A QAbstractListModel subclass that lists shortcuts associated with an action from a profile.

This class lists all shortcuts from the set profile that correspond to a specific action. This is used to allow editing of shortcuts from the ui.

It defines the following columns:

• Type: The type of shortcut, can be one of Key Combination, Mouse Button, Mouse Wheel, Gesture
• Input: What input is used to activate the shortcut. Depends on the type.
• Action: What mode of the action will be activated by the shortcut.

Note

Before this model will provide any data you should call setAction and setProfile.

This model is editable and provides an implementation of removeRows.

Definition at line 30 of file kis_action_shortcuts_model.h.

Constructor & Destructor Documentation

KisActionShortcutsModel()

KisActionShortcutsModel::KisActionShortcutsModel ( QObject * parent = 0 )

explicit

Constructor.

Definition at line 40 of file kis_action_shortcuts_model.cpp.

    : QAbstractListModel(parent), d(new Private)
{
    connect(KisInputProfileManager::instance(), SIGNAL(currentProfileChanged()), SLOT(currentProfileChanged()));
}

References connect(), currentProfileChanged(), and KisInputProfileManager::instance().

~KisActionShortcutsModel()

KisActionShortcutsModel::~KisActionShortcutsModel ( )

override

Destructor.

Definition at line 46 of file kis_action_shortcuts_model.cpp.

{
}

Member Function Documentation

action()

KisAbstractInputAction * KisActionShortcutsModel::action

(

)

const

Returns

The action used as data constraint for this model.

Definition at line 296 of file kis_action_shortcuts_model.cpp.

{
    return d->action;
}

References KisActionShortcutsModel::Private::action, and d.

canRemoveRow()

bool KisActionShortcutsModel::canRemoveRow

(

int

row

)

const

Definition at line 218 of file kis_action_shortcuts_model.cpp.

{
    if (row >= d->shortcuts.size()) {
        return false;
    }
    KisShortcutConfiguration* config = d->shortcuts.at(row);
    return !(d->action->isShortcutRequired(config->mode()) && d->shortcutModeCount(config->mode()) < 2);
}

References KisActionShortcutsModel::Private::action, d, KisAbstractInputAction::isShortcutRequired(), KisShortcutConfiguration::mode(), KisActionShortcutsModel::Private::shortcutModeCount(), and KisActionShortcutsModel::Private::shortcuts.

columnCount()

int KisActionShortcutsModel::columnCount ( const QModelIndex & ) const

override

Reimplemented from QAbstractItemModel::columnCount()

Definition at line 168 of file kis_action_shortcuts_model.cpp.

{
    return 3;
}

currentProfileChanged

void KisActionShortcutsModel::currentProfileChanged ( )

privateslot

Definition at line 342 of file kis_action_shortcuts_model.cpp.

{
    setProfile(KisInputProfileManager::instance()->currentProfile());
}

References KisInputProfileManager::instance(), and setProfile().

data()

QVariant KisActionShortcutsModel::data ( const QModelIndex & index, int role = Qt::DisplayRole ) const

override

Reimplemented from QAbstractItemModel::data()

Definition at line 50 of file kis_action_shortcuts_model.cpp.

{
    if (!index.isValid()) {
        return QVariant();
    }
 
    if (index.row() == d->shortcuts.count() && role == Qt::DisplayRole) {
        if (index.column() == 0) {
            return i18n("Add shortcut...");
        }
        else {
            return QVariant();
        }
    }
 
    if (role == Qt::DisplayRole) {
        switch (index.column()) {
        case 0:
            switch (d->shortcuts.at(index.row())->type()) {
            case KisShortcutConfiguration::KeyCombinationType:
                return i18nc("Shortcut type", "Key Combination");
 
            case KisShortcutConfiguration::MouseButtonType:
                return i18nc("Shortcut type", "Mouse Button");
 
            case KisShortcutConfiguration::MouseWheelType:
                return i18nc("Shortcut type", "Mouse Wheel");
 
            case KisShortcutConfiguration::GestureType:
                return i18nc("Shortcut type", "Gesture");
 
            default:
                return i18n("Unknown Input");
            }
 
            break;
 
        case 1: {
            KisShortcutConfiguration *s = d->shortcuts.at(index.row());
            QString output;
 
            switch (s->type()) {
            case KisShortcutConfiguration::KeyCombinationType:
                output = KisShortcutConfiguration::keysToText(s->keys());
                break;
 
            case KisShortcutConfiguration::MouseButtonType:
                output = KisShortcutConfiguration::buttonsInputToText(
                    s->keys(), s->buttons());
                break;
 
            case KisShortcutConfiguration::MouseWheelType:
                output = KisShortcutConfiguration::wheelInputToText(
                    s->keys(), s->wheel());
                break;
 
            case KisShortcutConfiguration::GestureType:
                output = KisShortcutConfiguration::gestureToText(s->gesture());
                break;
 
            default:
                break;
            }
 
            return output;
        }
 
        case 2:
            return d->action->shortcutIndexes().key(d->shortcuts.at(index.row())->mode());
 
        case 3:
            return KisIconUtils::loadIcon("edit-delete");
 
        default:
            break;
        }
    }
    else if (role == Qt::EditRole) {
        KisShortcutConfiguration *s;
 
        if (index.row() == d->shortcuts.count()) {
            if (!d->temporaryShortcut) {
                d->temporaryShortcut = new KisShortcutConfiguration;
            }
 
            s = d->temporaryShortcut;
        }
        else {
            s = d->shortcuts.at(index.row());
        }
 
        switch (index.column()) {
        case 0:
            return s->type();
 
        case 1:
            return QVariant::fromValue(s);
 
        case 2:
            return s->mode();
 
        default:
            break;
        }
    }
 
    return QVariant();
}

References KisActionShortcutsModel::Private::action, KisShortcutConfiguration::buttons(), KisShortcutConfiguration::buttonsInputToText(), d, KisShortcutConfiguration::gesture(), KisShortcutConfiguration::gestureToText(), KisShortcutConfiguration::GestureType, KisShortcutConfiguration::KeyCombinationType, KisShortcutConfiguration::keys(), KisShortcutConfiguration::keysToText(), KisIconUtils::loadIcon(), KisShortcutConfiguration::mode(), KisShortcutConfiguration::MouseButtonType, KisShortcutConfiguration::MouseWheelType, KisAbstractInputAction::shortcutIndexes(), KisActionShortcutsModel::Private::shortcuts, KisActionShortcutsModel::Private::temporaryShortcut, KisShortcutConfiguration::type(), KisShortcutConfiguration::wheel(), and KisShortcutConfiguration::wheelInputToText().

flags()

Qt::ItemFlags KisActionShortcutsModel::flags ( const QModelIndex & index ) const

override

Reimplemented from QAbstractItemModel::flags()

Definition at line 196 of file kis_action_shortcuts_model.cpp.

{
    if (!index.isValid()) {
        return Qt::ItemIsEnabled;
    }
 
    if (index.row() == d->shortcuts.count() && index.column() != 0) {
        return Qt::ItemIsEnabled;
    }
 
    if (index.row() >= d->shortcuts.count()) {
        return Qt::ItemIsEnabled | Qt::ItemIsEditable;
    }
 
    KisShortcutConfiguration* config = d->shortcuts.at(index.row());
    if (index.column() == 2 && d->action->isShortcutRequired(config->mode()) && d->shortcutModeCount(config->mode()) < 2) {
        return Qt::ItemIsSelectable;
    }
 
    return QAbstractItemModel::flags(index) | Qt::ItemIsEditable;
}

References KisActionShortcutsModel::Private::action, d, KisAbstractInputAction::isShortcutRequired(), KisShortcutConfiguration::mode(), KisActionShortcutsModel::Private::shortcutModeCount(), and KisActionShortcutsModel::Private::shortcuts.

headerData()

QVariant KisActionShortcutsModel::headerData ( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const

override

Reimplemented from QAbstractItemModel::headerData()

Definition at line 173 of file kis_action_shortcuts_model.cpp.

{
    if (orientation != Qt::Horizontal || role != Qt::DisplayRole) {
        return QVariant();
    }
 
    switch (section) {
    case 0:
        return i18nc("Type of shortcut", "Type");
 
    case 1:
        return i18nc("Input for shortcut", "Input");
 
    case 2:
        return i18nc("Action to trigger with shortcut", "Action");
 
    default:
        break;
    }
 
    return QVariant();
}

profile()

KisInputProfile * KisActionShortcutsModel::profile

(

)

const

Returns

The profile used as data source for this model.

Definition at line 319 of file kis_action_shortcuts_model.cpp.

{
    return d->profile;
}

References d, and KisActionShortcutsModel::Private::profile.

removeRows()

bool KisActionShortcutsModel::removeRows ( int row, int count, const QModelIndex & parent = QModelIndex() )

override

Reimplemented from QAbstractItemModel::removeRows.

Removes count rows starting at row.

Note

The associated shortcuts will also be removed from the profile and completely deleted.

Definition at line 347 of file kis_action_shortcuts_model.cpp.

{
    if (row < 0 || row >= d->shortcuts.count() || count == 0) {
        return false;
    }
 
    beginRemoveRows(parent, row, row + count - 1);
 
    for (int i = row; i < d->shortcuts.count() && count > 0; ++i, count--) {
        KisShortcutConfiguration *s = d->shortcuts.at(i);
 
        d->profile->removeShortcut(s);
        d->shortcuts.removeOne(s);
        delete s;
    }
 
    endRemoveRows();
 
    return true;
}

References d, KisActionShortcutsModel::Private::profile, KisInputProfile::removeShortcut(), and KisActionShortcutsModel::Private::shortcuts.

rowCount()

int KisActionShortcutsModel::rowCount ( const QModelIndex & parent = QModelIndex() ) const

override

Reimplemented from QAbstractItemModel::rowCount()

Definition at line 159 of file kis_action_shortcuts_model.cpp.

{
    if (parent.isValid()) {
        return 0;
    }
 
    return d->shortcuts.count() + 1;
}

References d, and KisActionShortcutsModel::Private::shortcuts.

setAction

void KisActionShortcutsModel::setAction ( KisAbstractInputAction * action )

slot

Set the action used as data constraint for this model.

Parameters

action

The action to use.

Definition at line 301 of file kis_action_shortcuts_model.cpp.

{
    if (action != d->action) {
        if (d->action) {
            beginRemoveRows(QModelIndex(), 0, d->shortcuts.count() - 1);
            endRemoveRows();
        }
 
        d->action = action;
 
        if (d->action && d->profile) {
            d->shortcuts = d->profile->shortcutsForAction(d->action);
            beginInsertRows(QModelIndex(), 0, d->shortcuts.count() - 1);
            endInsertRows();
        }
    }
}

References KisActionShortcutsModel::Private::action, action(), d, KisActionShortcutsModel::Private::profile, KisActionShortcutsModel::Private::shortcuts, and KisInputProfile::shortcutsForAction().

setData()

bool KisActionShortcutsModel::setData ( const QModelIndex & index, const QVariant & value, int role = Qt::EditRole )

override

Reimplemented from QAbstractItemModel::setData()

Definition at line 227 of file kis_action_shortcuts_model.cpp.

{
    if (!index.isValid() || role != Qt::EditRole) {
        return false;
    }
 
    if (index.row() == d->shortcuts.count()) {
        if (!d->temporaryShortcut || (index.column() == 0 && value.toUInt() == 0)) {
            return false;
        }
 
        beginInsertRows(QModelIndex(), d->shortcuts.count(), d->shortcuts.count());
        d->temporaryShortcut->setAction(d->action);
        d->profile->addShortcut(d->temporaryShortcut);
        d->shortcuts.append(d->temporaryShortcut);
        d->temporaryShortcut = 0;
        endInsertRows();
    }
 
    switch (index.column()) {
    case 0:
        d->shortcuts.at(index.row())->setType(static_cast<KisShortcutConfiguration::ShortcutType>(value.toUInt()));
        break;
 
    case 1: {
        KisShortcutConfiguration *newData = value.value<KisShortcutConfiguration *>();
        KisShortcutConfiguration *oldData = d->shortcuts.at(index.row());
 
        if (newData == oldData) {
            const QList<KisShortcutConfiguration *> conflictingShortcuts =
                KisInputProfileManager::instance()->getConflictingShortcuts(
                    KisInputProfileManager::instance()->currentProfile());
 
            // check if this shortcut resulted in a conflict
            const bool isConflictingShortcut = std::find_if(conflictingShortcuts.begin(),
                                                            conflictingShortcuts.end(),
                                                            [&oldData](KisShortcutConfiguration *shortcut) {
                                                                return *oldData == *shortcut;
                                                            })
                != conflictingShortcuts.end();
 
            if (isConflictingShortcut) {
                QMessageBox::warning(qApp->activeWindow(),
                                     "Warning",
                                     i18n("A conflict exists between two or more shortcuts."));
            }
            // change was done on the object
            Q_EMIT dataChanged(index, index);
            return true;
        }
 
        oldData->setKeys(newData->keys());
        oldData->setButtons(newData->buttons());
        oldData->setWheel(newData->wheel());
        oldData->setGesture(newData->gesture());
 
        break;
    }
 
    case 2:
        d->shortcuts.at(index.row())->setMode(value.toUInt());
        break;
    }
 
    Q_EMIT dataChanged(index, index);
 
    return true;
}

References KisActionShortcutsModel::Private::action, KisInputProfile::addShortcut(), KisShortcutConfiguration::buttons(), d, KisShortcutConfiguration::gesture(), KisInputProfileManager::getConflictingShortcuts(), KisInputProfileManager::instance(), KisShortcutConfiguration::keys(), KisActionShortcutsModel::Private::profile, KisShortcutConfiguration::setAction(), KisActionShortcutsModel::Private::shortcuts, KisActionShortcutsModel::Private::temporaryShortcut, value(), and KisShortcutConfiguration::wheel().

setProfile

void KisActionShortcutsModel::setProfile ( KisInputProfile * profile )

slot

Set the profile used as data source for this model.

Parameters

profile

The profile to get the data from.

Definition at line 324 of file kis_action_shortcuts_model.cpp.

{
    if (profile != d->profile) {
        if (d->profile) {
            beginRemoveRows(QModelIndex(), 0, d->shortcuts.count() - 1);
            endRemoveRows();
        }
 
        d->profile = profile;
 
        if (d->action && d->profile) {
            d->shortcuts = d->profile->shortcutsForAction(d->action);
            beginInsertRows(QModelIndex(), 0, d->shortcuts.count() - 1);
            endInsertRows();
        }
    }
}

References KisActionShortcutsModel::Private::action, d, KisActionShortcutsModel::Private::profile, profile(), KisActionShortcutsModel::Private::shortcuts, and KisInputProfile::shortcutsForAction().

Member Data Documentation

d

Private* const KisActionShortcutsModel::d

private

Definition at line 109 of file kis_action_shortcuts_model.h.

---

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

• libs/ui/input/config/kis_action_shortcuts_model.h
• libs/ui/input/config/kis_action_shortcuts_model.cpp