ShortcutEditWidget Class Reference

#include <KisShortcutsDialog_p.h>

Inheritance diagram for ShortcutEditWidget:

Public Slots
void	setKeySequence (const QKeySequence &activeSeq)
	Set the displayed sequences.

Signals
void	keySequenceChanged (const QKeySequence &)
	Emitted when the key sequence is changed.
void	stealShortcut (const QKeySequence &seq, QAction *action)

Public Member Functions
KisKKeySequenceWidget::ShortcutTypes	checkForConflictsAgainst () const
bool	multiKeyShortcutsAllowed () const
void	paintEvent (QPaintEvent *pe) override
void	setAction (QObject *action)
void	setCheckActionCollections (const QList< KisKActionCollection * > checkActionCollections)
void	setCheckForConflictsAgainst (KisKKeySequenceWidget::ShortcutTypes)
void	setComponentName (const QString componentName)
void	setMultiKeyShortcutsAllowed (bool)
	ShortcutEditWidget (QWidget *viewport, const QKeySequence &defaultSeq, const QKeySequence &activeSeq, bool allowLetterShortcuts)

Private Slots
void	defaultToggled (bool)
void	setCustom (const QKeySequence &)

Private Attributes
QObject *	m_action
KisKKeySequenceWidget *	m_customEditor
QRadioButton *	m_customRadio
QKeySequence	m_defaultKeySequence
QLabel *	m_defaultLabel
QRadioButton *	m_defaultRadio
bool	m_isUpdating

Detailed Description

Edit a shortcut. This widget is displayed when a user clicks on a shortcut from the list. It contains radio buttons choosing between default and custom shortcuts, and a button to configure the custom shortcut.

See also

KisShortcutsEditorDelegate::itemActivated

KisShortcutWidget.cpp

Definition at line 165 of file KisShortcutsDialog_p.h.

Constructor & Destructor Documentation

ShortcutEditWidget()

ShortcutEditWidget::ShortcutEditWidget	(	QWidget *	viewport,
		const QKeySequence &	defaultSeq,
		const QKeySequence &	activeSeq,
		bool	allowLetterShortcuts )

Definition at line 41 of file KisShortcutEditWidget.cpp.

    : QWidget(viewport),
      m_defaultKeySequence(defaultSeq),
      m_isUpdating(false),
      m_action(0)
{
    QGridLayout *layout = new QGridLayout(this);
 
    m_defaultRadio = new QRadioButton(i18n("Default:"), this);
    m_defaultLabel = new QLabel(i18nc("No shortcut defined", "None"), this);
    QString defaultText = defaultSeq.toString(QKeySequence::NativeText);
    if (defaultText.isEmpty()) {
        defaultText = i18nc("No shortcut defined", "None");
    }
    m_defaultLabel->setText(defaultText);
 
    m_customRadio = new QRadioButton(i18n("Custom:"), this);
    m_customEditor = new KisKKeySequenceWidget(this);
    m_customEditor->setModifierlessAllowed(allowLetterShortcuts);
 
    layout->addWidget(m_defaultRadio, 0, 0);
    layout->addWidget(m_defaultLabel, 0, 1);
    layout->addWidget(m_customRadio, 1, 0);
    layout->addWidget(m_customEditor, 1, 1);
    layout->setColumnStretch(2, 1);
 
    setKeySequence(activeSeq);
 
    connect(m_defaultRadio, SIGNAL(toggled(bool)),
            this, SLOT(defaultToggled(bool)));
    connect(m_customEditor, SIGNAL(keySequenceChanged(QKeySequence)),
            this, SLOT(setCustom(QKeySequence)));
    connect(m_customEditor, SIGNAL(stealShortcut(QKeySequence,QAction*)),
            this, SIGNAL(stealShortcut(QKeySequence,QAction*)));
}

References connect(), defaultToggled(), keySequenceChanged(), m_customEditor, m_customRadio, m_defaultLabel, m_defaultRadio, setCustom(), setKeySequence(), KisKKeySequenceWidget::setModifierlessAllowed(), and stealShortcut().

Member Function Documentation

checkForConflictsAgainst()

KisKKeySequenceWidget::ShortcutTypes ShortcutEditWidget::checkForConflictsAgainst

(

)

const

See also

KisKKeySequenceWidget::checkAgainstStandardShortcuts()

Definition at line 78 of file KisShortcutEditWidget.cpp.

{
    return m_customEditor->checkForConflictsAgainst();
}

References KisKKeySequenceWidget::checkForConflictsAgainst, and m_customEditor.

defaultToggled

void ShortcutEditWidget::defaultToggled ( bool checked )

privateslot

Definition at line 84 of file KisShortcutEditWidget.cpp.

{
    if (m_isUpdating) {
        return;
    }
 
    m_isUpdating = true;
    if (checked) {
        // The default key sequence should be activated. We check first if this
        // is possible.
        if (m_customEditor->isKeySequenceAvailable(m_defaultKeySequence)) {
            // Clear the customs widget
            m_customEditor->clearKeySequence();
            Q_EMIT keySequenceChanged(m_defaultKeySequence);
        } else {
            // We tried to switch to the default key sequence and failed.
            // Go back.
            m_customRadio->setChecked(true);
        }
    } else {
        // The empty key sequence is always valid
        Q_EMIT keySequenceChanged(QKeySequence());
    }
    m_isUpdating = false;
}

References KisKKeySequenceWidget::clearKeySequence(), KisKKeySequenceWidget::isKeySequenceAvailable(), keySequenceChanged(), m_customEditor, m_customRadio, m_defaultKeySequence, and m_isUpdating.

keySequenceChanged

void ShortcutEditWidget::keySequenceChanged ( const QKeySequence & )

signal

Emitted when the key sequence is changed.

multiKeyShortcutsAllowed()

bool ShortcutEditWidget::multiKeyShortcutsAllowed

(

)

const

See also

KisKKeySequenceWidget::checkAgainstStandardShortcuts()

Definition at line 133 of file KisShortcutEditWidget.cpp.

{
    return m_customEditor->multiKeyShortcutsAllowed();
}

References m_customEditor, and KisKKeySequenceWidget::multiKeyShortcutsAllowed.

paintEvent()

void ShortcutEditWidget::paintEvent ( QPaintEvent * pe )

override

Definition at line 26 of file KisShortcutEditWidget.cpp.

{
    QWidget::paintEvent(e);
    QPainter p(this);
    QPen pen(QPalette().highlight().color());
    pen.setWidth(6);
    p.setPen(pen);
    p.drawLine(0, 0, width(), 0);
    if (qApp->isLeftToRight()) {
        p.drawLine(0, 0, 0, height());
    } else {
        p.drawLine(width(), 0, width(), height());
    }
}

References p.

setAction()

void ShortcutEditWidget::setAction

(

QObject *

action

)

Definition at line 138 of file KisShortcutEditWidget.cpp.

{
    m_action = action;
}

References m_action.

setCheckActionCollections()

void ShortcutEditWidget::setCheckActionCollections

(

const QList< KisKActionCollection * >

checkActionCollections

)

See also

KisKKeySequenceWidget::setCheckActionCollections()

Definition at line 110 of file KisShortcutEditWidget.cpp.

{
    // We just forward them to out KisKKeySequenceWidget.
    m_customEditor->setCheckActionCollections(checkActionCollections);
}

References m_customEditor, and KisKKeySequenceWidget::setCheckActionCollections().

setCheckForConflictsAgainst()

void ShortcutEditWidget::setCheckForConflictsAgainst

(

KisKKeySequenceWidget::ShortcutTypes

types

)

Definition at line 117 of file KisShortcutEditWidget.cpp.

{
    m_customEditor->setCheckForConflictsAgainst(types);
}

References m_customEditor, and KisKKeySequenceWidget::setCheckForConflictsAgainst().

setComponentName()

void ShortcutEditWidget::setComponentName

(

const QString

componentName

)

See also

KisKKeySequenceWidget::setComponentName

Definition at line 122 of file KisShortcutEditWidget.cpp.

{
    m_customEditor->setComponentName(componentName);
}

References m_customEditor, and KisKKeySequenceWidget::setComponentName().

setCustom

void ShortcutEditWidget::setCustom ( const QKeySequence & seq )

privateslot

Definition at line 144 of file KisShortcutEditWidget.cpp.

{
    if (m_isUpdating) {
        return;
    }
 
    // seq is a const reference to a private variable of KisKKeySequenceWidget.
    // Somewhere below we possible change that one. But we want to Q_EMIT seq
    // whatever happens. So we make a copy.
    QKeySequence original = seq;
 
    m_isUpdating = true;
 
    // Check if the user typed in the default sequence into the custom field.
    // We do this by calling setKeySequence which will do the right thing.
    setKeySequence(original);
 
    Q_EMIT keySequenceChanged(original);
    m_isUpdating = false;
}

References keySequenceChanged(), m_isUpdating, and setKeySequence().

setKeySequence

void ShortcutEditWidget::setKeySequence ( const QKeySequence & activeSeq )

slot

Set the displayed sequences.

Definition at line 165 of file KisShortcutEditWidget.cpp.

{
    if (activeSeq.toString(QKeySequence::NativeText) == m_defaultKeySequence.toString(QKeySequence::NativeText)) {
        m_defaultRadio->setChecked(true);
        m_customEditor->clearKeySequence();
    } else {
        m_customRadio->setChecked(true);
        // m_customEditor->setKeySequence does some stuff we only want to
        // execute when the sequence really changes.
        if (activeSeq != m_customEditor->keySequence()) {
            m_customEditor->setKeySequence(activeSeq);
        }
    }
}

References KisKKeySequenceWidget::clearKeySequence(), KisKKeySequenceWidget::keySequence(), m_customEditor, m_customRadio, m_defaultKeySequence, m_defaultRadio, and KisKKeySequenceWidget::setKeySequence().

setMultiKeyShortcutsAllowed()

void ShortcutEditWidget::setMultiKeyShortcutsAllowed

(

bool

allowed

)

Definition at line 127 of file KisShortcutEditWidget.cpp.

{
    // We just forward them to out KisKKeySequenceWidget.
    m_customEditor->setMultiKeyShortcutsAllowed(allowed);
}

References m_customEditor, and KisKKeySequenceWidget::setMultiKeyShortcutsAllowed().

stealShortcut

void ShortcutEditWidget::stealShortcut ( const QKeySequence & seq, QAction * action )

signal

See also

KisKKeySequenceWidget::stealShortcut()

Member Data Documentation

m_action

QObject* ShortcutEditWidget::m_action

private

Definition at line 219 of file KisShortcutsDialog_p.h.

m_customEditor

KisKKeySequenceWidget* ShortcutEditWidget::m_customEditor

private

Definition at line 217 of file KisShortcutsDialog_p.h.

m_customRadio

QRadioButton* ShortcutEditWidget::m_customRadio

private

Definition at line 216 of file KisShortcutsDialog_p.h.

m_defaultKeySequence

QKeySequence ShortcutEditWidget::m_defaultKeySequence

private

Definition at line 214 of file KisShortcutsDialog_p.h.

m_defaultLabel

QLabel* ShortcutEditWidget::m_defaultLabel

private

Definition at line 213 of file KisShortcutsDialog_p.h.

m_defaultRadio

QRadioButton* ShortcutEditWidget::m_defaultRadio

private

Definition at line 215 of file KisShortcutsDialog_p.h.

m_isUpdating

bool ShortcutEditWidget::m_isUpdating

private

Definition at line 218 of file KisShortcutsDialog_p.h.

---

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

• libs/widgetutils/xmlgui/KisShortcutsDialog_p.h
• libs/widgetutils/xmlgui/KisShortcutEditWidget.cpp