Public Member Functions
void	cancelRecording ()

bool	checkAgainstGlobalShortcuts () const

bool	checkAgainstLocalShortcuts () const

bool	checkAgainstStandardShortcuts () const

bool	conflictWithGlobalShortcuts (const QKeySequence &seq)

bool	conflictWithLocalShortcuts (const QKeySequence &seq)

bool	conflictWithStandardShortcuts (const QKeySequence &seq)

void	controlModifierlessTimeout ()

void	doneRecording (bool validate=true)

void	init ()

	KisKKeySequenceWidgetPrivate (KisKKeySequenceWidget *q)

void	startRecording ()

bool	stealShortcuts (const QList< QAction * > &actions, const QKeySequence &seq)

bool	stealStandardShortcut (KStandardShortcut::StandardShortcut std, const QKeySequence &seq)

void	updateShortcutDisplay ()

void	wontStealShortcut (QAction *item, const QKeySequence &seq)

Static Public Member Functions
static QKeySequence	appendToSequence (const QKeySequence &seq, int keyQt)

static bool	isOkWhenModifierless (int keyQt)

Public Attributes
bool	allowModifierless

QList< KisKActionCollection * >	checkActionCollections

KisKKeySequenceWidget::ShortcutTypes	checkAgainstShortcutTypes
	Check the key sequence against KStandardShortcut::find()

QList< QAction * >	checkList

QToolButton *	clearButton

QString	componentName

bool	isRecording

KKeySequenceButton *	keyButton

QKeySequence	keySequence

QHBoxLayout *	layout

uint	modifierKeys

QTimer	modifierlessTimeout

bool	multiKeyShortcutsAllowed

uint	nKey

QKeySequence	oldKeySequence

KisKKeySequenceWidget *const	q

QList< QAction * >	stealActions

Detailed Description

Definition at line 34 of file kkeysequencewidget.cpp.

Constructor & Destructor Documentation

◆ KisKKeySequenceWidgetPrivate()

KisKKeySequenceWidgetPrivate::KisKKeySequenceWidgetPrivate ( KisKKeySequenceWidget * q )

Definition at line 146 of file kkeysequencewidget.cpp.

    : q(q)
    , layout(0)
    , keyButton(0)
    , clearButton(0)
    , allowModifierless(false)
    , nKey(0)
    , modifierKeys(0)
    , isRecording(false)
    , multiKeyShortcutsAllowed(true)
    , componentName()
    , checkAgainstShortcutTypes(KisKKeySequenceWidget::LocalShortcuts | KisKKeySequenceWidget::GlobalShortcuts)
    , stealActions()
{}

Member Function Documentation

◆ appendToSequence()

QKeySequence KisKKeySequenceWidgetPrivate::appendToSequence	(	const QKeySequence &	seq,
		int	keyQt )

static

Definition at line 977 of file kkeysequencewidget.cpp.

{
    switch (seq.count()) {
    case 0:
        return QKeySequence(keyQt);
    case 1:
        return QKeySequence(seq[0], keyQt);
    case 2:
        return QKeySequence(seq[0], seq[1], keyQt);
    case 3:
        return QKeySequence(seq[0], seq[1], seq[2], keyQt);
    default:
        return seq;
    }
}

◆ cancelRecording()

void KisKKeySequenceWidgetPrivate::cancelRecording ( )

inline

Definition at line 98 of file kkeysequencewidget.cpp.

    {
        keySequence = oldKeySequence;
        doneRecording();
    }

References doneRecording(), keySequence, and oldKeySequence.

◆ checkAgainstGlobalShortcuts()

bool KisKKeySequenceWidgetPrivate::checkAgainstGlobalShortcuts ( ) const

inline

Definition at line 76 of file kkeysequencewidget.cpp.

    {
        return checkAgainstShortcutTypes & KisKKeySequenceWidget::GlobalShortcuts;
    }

References checkAgainstShortcutTypes, and KisKKeySequenceWidget::GlobalShortcuts.

◆ checkAgainstLocalShortcuts()

bool KisKKeySequenceWidgetPrivate::checkAgainstLocalShortcuts ( ) const

inline

Definition at line 81 of file kkeysequencewidget.cpp.

    {
        return checkAgainstShortcutTypes & KisKKeySequenceWidget::LocalShortcuts;
    }

References checkAgainstShortcutTypes, and KisKKeySequenceWidget::LocalShortcuts.

◆ checkAgainstStandardShortcuts()

bool KisKKeySequenceWidgetPrivate::checkAgainstStandardShortcuts ( ) const

inline

Definition at line 71 of file kkeysequencewidget.cpp.

    {
        return checkAgainstShortcutTypes & KisKKeySequenceWidget::StandardShortcuts;
    }

References checkAgainstShortcutTypes, and KisKKeySequenceWidget::StandardShortcuts.

◆ conflictWithGlobalShortcuts()

bool KisKKeySequenceWidgetPrivate::conflictWithGlobalShortcuts ( const QKeySequence & seq )

Conflicts the key sequence seq conflict with Windows shortcut keys?

Definition at line 414 of file kkeysequencewidget.cpp.

{
    // This could hold some OS-specific stuff, or it could be linked back with
    // the KDE global shortcut code at some point in the future.
 
#ifdef Q_OS_WIN
#else
#endif
    Q_UNUSED(keySequence);
 
    return false;
}

References keySequence.

◆ conflictWithLocalShortcuts()

bool KisKKeySequenceWidgetPrivate::conflictWithLocalShortcuts ( const QKeySequence & seq )

Conflicts the key sequence seq with a current local shortcut?

Definition at line 447 of file kkeysequencewidget.cpp.

{
    if (!(checkAgainstShortcutTypes & KisKKeySequenceWidget::LocalShortcuts)) {
        return false;
    }
 
    // We have actions both in the deprecated checkList and the
    // checkActionCollections list. Add all the actions to a single list to
    // be able to process them in a single loop below.
    // Note that this can't be done in setCheckActionCollections(), because we
    // keep pointers to the action collections, and between the call to
    // setCheckActionCollections() and this function some actions might already be
    // removed from the collection again.
    QList<QAction *> allActions;
    allActions += checkList;
    foreach (KisKActionCollection *collection, checkActionCollections) {
        allActions += collection->actions();
    }
 
    // Because of multikey shortcuts we can have clashes with many shortcuts.
    //
    // Example 1:
    //
    // Application currently uses 'CTRL-X,a', 'CTRL-X,f' and 'CTRL-X,CTRL-F'
    // and the user wants to use 'CTRL-X'. 'CTRL-X' will only trigger as
    // 'activatedAmbiguously()' for obvious reasons.
    //
    // Example 2:
    //
    // Application currently uses 'CTRL-X'. User wants to use 'CTRL-X,CTRL-F'.
    // This will shadow 'CTRL-X' for the same reason as above.
    //
    // Example 3:
    //
    // Some weird combination of Example 1 and 2 with three shortcuts using
    // 1/2/3 key shortcuts. I think you can imagine.
    QList<QAction *> conflictingActions;
 
    //find conflicting shortcuts with existing actions
    foreach (QAction *qaction, allActions) {
        if (shortcutsConflictWith(qaction->shortcuts(), keySequence)) {
            // A conflict with a KAction. If that action is configurable
            // ask the user what to do. If not reject this keySequence.
            if (checkActionCollections.first()->isShortcutsConfigurable(qaction)) {
                conflictingActions.append(qaction);
            } else {
                wontStealShortcut(qaction, keySequence);
                return true;
            }
        }
    }
 
    if (conflictingActions.isEmpty()) {
        // No conflicting shortcuts found.
        return false;
    }
 
    if (stealShortcuts(conflictingActions, keySequence)) {
        stealActions = conflictingActions;
 
        // Announce that the user agreed to override the other shortcut
        Q_FOREACH (QAction *stealAction, stealActions) {
            Q_EMIT q->stealShortcut(
                keySequence,
                stealAction);
        }
        return false;
    } else {
        return true;
    }
}

References KisKActionCollection::actions(), checkActionCollections, checkAgainstShortcutTypes, checkList, keySequence, KisKKeySequenceWidget::LocalShortcuts, q, shortcutsConflictWith(), stealActions, KisKKeySequenceWidget::stealShortcut(), stealShortcuts(), and wontStealShortcut().

◆ conflictWithStandardShortcuts()

bool KisKKeySequenceWidgetPrivate::conflictWithStandardShortcuts ( const QKeySequence & seq )

Conflicts the key sequence seq with a current standard shortcut?

Pops up a dialog asking overriding the conflict is OK.

Definition at line 519 of file kkeysequencewidget.cpp.

{
    if (!(checkAgainstShortcutTypes & KisKKeySequenceWidget::StandardShortcuts)) {
        return false;
    }
    KStandardShortcut::StandardShortcut ssc = KStandardShortcut::find(keySequence);
    if (ssc != KStandardShortcut::AccelNone && !stealStandardShortcut(ssc, keySequence)) {
        return true;
    }
    return false;
}

References checkAgainstShortcutTypes, keySequence, KisKKeySequenceWidget::StandardShortcuts, and stealStandardShortcut().

◆ controlModifierlessTimeout()

void KisKKeySequenceWidgetPrivate::controlModifierlessTimeout ( )

inline

Definition at line 86 of file kkeysequencewidget.cpp.

    {
        if (nKey != 0 && !modifierKeys) {
            // No modifier key pressed currently. Start the timeout
            modifierlessTimeout.start(600);
        } else {
            // A modifier is pressed. Stop the timeout
            modifierlessTimeout.stop();
        }
 
    }

References modifierKeys, modifierlessTimeout, and nKey.

◆ doneRecording()

void KisKKeySequenceWidgetPrivate::doneRecording ( bool validate = true )

Definition at line 390 of file kkeysequencewidget.cpp.

{
    modifierlessTimeout.stop();
    isRecording = false;
    keyButton->releaseKeyboard();
    keyButton->setDown(false);
    stealActions.clear();
 
    if (keySequence == oldKeySequence) {
        // The sequence hasn't changed
        updateShortcutDisplay();
        return;
    }
 
    if (validate && !q->isKeySequenceAvailable(keySequence)) {
        // The sequence had conflicts and the user said no to stealing it
        keySequence = oldKeySequence;
    } else {
        Q_EMIT q->keySequenceChanged(keySequence);
    }
 
    updateShortcutDisplay();
}

References KisKKeySequenceWidget::isKeySequenceAvailable(), isRecording, keyButton, keySequence, KisKKeySequenceWidget::keySequenceChanged(), modifierlessTimeout, oldKeySequence, q, stealActions, and updateShortcutDisplay().

◆ init()

void KisKKeySequenceWidgetPrivate::init ( )

Definition at line 219 of file kkeysequencewidget.cpp.

{
    layout = new QHBoxLayout(q);
    layout->setContentsMargins(0, 0, 0, 0);
 
    keyButton = new KKeySequenceButton(this, q);
    keyButton->setFocusPolicy(Qt::StrongFocus);
    keyButton->setIcon(KisIconUtils::loadIcon(QStringLiteral("configure")));
    keyButton->setToolTip(i18n("Click on the button, then enter the shortcut like you would in the program.\nExample for Ctrl+A: hold the Ctrl key and press A."));
    layout->addWidget(keyButton);
 
    clearButton = new QToolButton(q);
    layout->addWidget(clearButton);
 
    clearButton->setIcon(KisIconUtils::loadIcon(QStringLiteral("edit-clear")));
}

References clearButton, keyButton, layout, KisIconUtils::loadIcon(), and q.

◆ isOkWhenModifierless()

bool KisKKeySequenceWidgetPrivate::isOkWhenModifierless ( int keyQt )

static

Definition at line 994 of file kkeysequencewidget.cpp.

{
    //this whole function is a hack, but especially the first line of code
    if (QKeySequence(keyQt).toString().length() == 1) {
        return false;
    }
 
    switch (keyQt) {
    case Qt::Key_Return:
    case Qt::Key_Space:
    case Qt::Key_Tab:
    case Qt::Key_Backtab: //does this ever happen?
    case Qt::Key_Backspace:
    case Qt::Key_Delete:
        return false;
    default:
        return true;
    }
}

References length().

◆ startRecording()

void KisKKeySequenceWidgetPrivate::startRecording ( )

Definition at line 373 of file kkeysequencewidget.cpp.

{
    nKey = 0;
    modifierKeys = 0;
    oldKeySequence = keySequence;
    keySequence = QKeySequence();
    isRecording = true;
    keyButton->grabKeyboard();
 
    if (!QWidget::keyboardGrabber()) {
        qWarning() << "Failed to grab the keyboard! Most likely qt's nograb option is active";
    }
 
    keyButton->setDown(true);
    updateShortcutDisplay();
}

References isRecording, keyButton, keySequence, modifierKeys, nKey, oldKeySequence, and updateShortcutDisplay().

◆ stealShortcuts()

bool KisKKeySequenceWidgetPrivate::stealShortcuts	(	const QList< QAction * > &	actions,
		const QKeySequence &	seq )

Definition at line 161 of file kkeysequencewidget.cpp.

{
 
    const int listSize = actions.size();
 
    QString title = i18ncp("%1 is the number of conflicts", "Shortcut Conflict", "Shortcut Conflicts", listSize);
 
    QString conflictingShortcuts;
    Q_FOREACH (const QAction *action, actions) {
        conflictingShortcuts += i18n("Shortcut '%1' for action '%2'\n",
                                     action->shortcut().toString(QKeySequence::NativeText),
                                     KLocalizedString::removeAcceleratorMarker(action->text()));
    }
    QString message = i18ncp("%1 is the number of ambiguous shortcut clashes (hidden)",
                             "The \"%2\" shortcut is ambiguous with the following shortcut.\n"
                             "Do you want to assign an empty shortcut to this action?\n"
                             "%3",
                             "The \"%2\" shortcut is ambiguous with the following shortcuts.\n"
                             "Do you want to assign an empty shortcut to these actions?\n"
                             "%3",
                             listSize,
                             seq.toString(QKeySequence::NativeText),
                             conflictingShortcuts);
 
    if (KMessageBox::warningContinueCancel(q, message, title, KGuiItem(i18n("Reassign"))) != KMessageBox::Continue) {
        return false;
    }
 
    return true;
}

References q.

◆ stealStandardShortcut()

bool KisKKeySequenceWidgetPrivate::stealStandardShortcut	(	KStandardShortcut::StandardShortcut	std,
		const QKeySequence &	seq )

Get permission to steal the shortcut @seq from the standard shortcut std.

Definition at line 531 of file kkeysequencewidget.cpp.

{
    QString title = i18n("Conflict with Standard Application Shortcut");
    QString message = i18n("The '%1' key combination is also used for the standard action "
                           "\"%2\" that some applications use.\n"
                           "Do you really want to use it as a global shortcut as well?",
                           seq.toString(QKeySequence::NativeText), KStandardShortcut::label(std));
 
    if (KMessageBox::warningContinueCancel(q, message, title, KGuiItem(i18n("Reassign"))) != KMessageBox::Continue) {
        return false;
    }
    return true;
}

References q.

◆ updateShortcutDisplay()

void KisKKeySequenceWidgetPrivate::updateShortcutDisplay ( )

Definition at line 545 of file kkeysequencewidget.cpp.

{
    //empty string if no non-modifier was pressed
    QString s = keySequence.toString(QKeySequence::NativeText);
    s.replace(QLatin1Char('&'), QStringLiteral("&&"));
 
    if (isRecording) {
        if (modifierKeys) {
            if (!s.isEmpty()) {
                s.append(QLatin1Char(','));
            }
            if (modifierKeys & Qt::MetaModifier) {
                s += QKeySequence(Qt::MetaModifier).toString(QKeySequence::NativeText);
            }
#if defined(Q_OS_MAC)
            if (modifierKeys & Qt::AltModifier) {
                s += QKeySequence(Qt::AltModifier).toString(QKeySequence::NativeText);
            }
            if (modifierKeys & Qt::ControlModifier) {
                s += QKeySequence(Qt::ControlModifier).toString(QKeySequence::NativeText);
            }
#else
            if (modifierKeys & Qt::ControlModifier) {
                s += QKeySequence(Qt::ControlModifier).toString(QKeySequence::NativeText);
            }
            if (modifierKeys & Qt::AltModifier) {
                s += QKeySequence(Qt::AltModifier).toString(QKeySequence::NativeText);
            }
#endif
            if (modifierKeys & Qt::ShiftModifier) {
                s += QKeySequence(Qt::ShiftModifier).toString(QKeySequence::NativeText);
            }
            if (modifierKeys & Qt::KeypadModifier) {
                s += QKeySequence(Qt::KeypadModifier).toString(QKeySequence::NativeText);
            }
 
        } else if (nKey == 0) {
            s = i18nc("What the user inputs now will be taken as the new shortcut", "Input");
        }
        //make it clear that input is still going on
        s.append(QStringLiteral(" ..."));
    }
 
    if (s.isEmpty()) {
        s = i18nc("No shortcut defined", "None");
    }
 
    s.prepend(QLatin1Char(' '));
    s.append(QLatin1Char(' '));
    keyButton->setText(s);
 
}

References isRecording, keyButton, keySequence, modifierKeys, and nKey.

◆ wontStealShortcut()

void KisKKeySequenceWidgetPrivate::wontStealShortcut	(	QAction *	item,
		const QKeySequence &	seq )

Definition at line 194 of file kkeysequencewidget.cpp.

{
    QString title(i18n("Shortcut conflict"));
    QString msg(i18n("<qt>The '%1' key combination is already used by the <b>%2</b> action.<br>"
                     "Please select a different one.</qt>", seq.toString(QKeySequence::NativeText),
                     KLocalizedString::removeAcceleratorMarker(item->text())));
    KMessageBox::error(q, msg, title);
}

References q.

Member Data Documentation

◆ allowModifierless

bool KisKKeySequenceWidgetPrivate::allowModifierless

Definition at line 116 of file kkeysequencewidget.cpp.

◆ checkActionCollections

QList<KisKActionCollection *> KisKKeySequenceWidgetPrivate::checkActionCollections

The list of action collections to check against for conflict shortcut

Definition at line 134 of file kkeysequencewidget.cpp.

◆ checkAgainstShortcutTypes

KisKKeySequenceWidget::ShortcutTypes KisKKeySequenceWidgetPrivate::checkAgainstShortcutTypes

Check the key sequence against KStandardShortcut::find()

Definition at line 124 of file kkeysequencewidget.cpp.

◆ checkList

QList<QAction *> KisKKeySequenceWidgetPrivate::checkList

The list of action to check against for conflict shortcut

Definition at line 129 of file kkeysequencewidget.cpp.

◆ clearButton

QToolButton* KisKKeySequenceWidgetPrivate::clearButton

Definition at line 111 of file kkeysequencewidget.cpp.

◆ componentName

QString KisKKeySequenceWidgetPrivate::componentName

Definition at line 121 of file kkeysequencewidget.cpp.

◆ isRecording

bool KisKKeySequenceWidgetPrivate::isRecording

Definition at line 119 of file kkeysequencewidget.cpp.

◆ keyButton

KKeySequenceButton* KisKKeySequenceWidgetPrivate::keyButton

Definition at line 110 of file kkeysequencewidget.cpp.

◆ keySequence

QKeySequence KisKKeySequenceWidgetPrivate::keySequence

Definition at line 113 of file kkeysequencewidget.cpp.

◆ layout

QHBoxLayout* KisKKeySequenceWidgetPrivate::layout

Definition at line 109 of file kkeysequencewidget.cpp.

◆ modifierKeys

uint KisKKeySequenceWidgetPrivate::modifierKeys

Definition at line 118 of file kkeysequencewidget.cpp.

◆ modifierlessTimeout

QTimer KisKKeySequenceWidgetPrivate::modifierlessTimeout

Definition at line 115 of file kkeysequencewidget.cpp.

◆ multiKeyShortcutsAllowed

bool KisKKeySequenceWidgetPrivate::multiKeyShortcutsAllowed

Definition at line 120 of file kkeysequencewidget.cpp.

◆ nKey

uint KisKKeySequenceWidgetPrivate::nKey

Definition at line 117 of file kkeysequencewidget.cpp.

◆ oldKeySequence

QKeySequence KisKKeySequenceWidgetPrivate::oldKeySequence

Definition at line 114 of file kkeysequencewidget.cpp.

◆ q

KisKKeySequenceWidget* const KisKKeySequenceWidgetPrivate::q

Definition at line 108 of file kkeysequencewidget.cpp.

◆ stealActions

QList<QAction *> KisKKeySequenceWidgetPrivate::stealActions

The action to steal the shortcut from.

Definition at line 139 of file kkeysequencewidget.cpp.

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

libs/widgetutils/xmlgui/kkeysequencewidget.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KisKKeySequenceWidgetPrivate()

Member Function Documentation

◆ appendToSequence()

◆ cancelRecording()

◆ checkAgainstGlobalShortcuts()

◆ checkAgainstLocalShortcuts()

◆ checkAgainstStandardShortcuts()

◆ conflictWithGlobalShortcuts()

◆ conflictWithLocalShortcuts()

◆ conflictWithStandardShortcuts()

◆ controlModifierlessTimeout()

◆ doneRecording()

◆ init()

◆ isOkWhenModifierless()

◆ startRecording()

◆ stealShortcuts()

◆ stealStandardShortcut()

◆ updateShortcutDisplay()

◆ wontStealShortcut()

Member Data Documentation

◆ allowModifierless

◆ checkActionCollections

◆ checkAgainstShortcutTypes

◆ checkList

◆ clearButton

◆ componentName

◆ isRecording

◆ keyButton

◆ keySequence

◆ layout

◆ modifierKeys

◆ modifierlessTimeout

◆ multiKeyShortcutsAllowed

◆ nKey

◆ oldKeySequence

◆ q

◆ stealActions