KisInputButton Class Reference

A button that can detect input and will store its value. More...

#include <kis_input_button.h>

Inheritance diagram for KisInputButton:

Classes
class	Private

Public Types
enum	ButtonType { MouseType , KeyType , WheelType }

Public Slots
void	clear ()

Signals
void	dataChanged ()

Public Member Functions
Qt::MouseButtons	buttons () const
QList< Qt::Key >	keys () const
	KisInputButton (QWidget *parent=nullptr)
void	setButtons (Qt::MouseButtons newButtons)
void	setKeys (const QList< Qt::Key > &newKeys)
void	setType (ButtonType newType)
void	setWheel (KisShortcutConfiguration::MouseWheelMovement wheel)
ButtonType	type () const
KisShortcutConfiguration::MouseWheelMovement	wheel () const
	~KisInputButton () override

Protected Member Functions
void	keyPressEvent (QKeyEvent *event) override
void	keyReleaseEvent (QKeyEvent *event) override
void	mousePressEvent (QMouseEvent *event) override
void	mouseReleaseEvent (QMouseEvent *) override
void	wheelEvent (QWheelEvent *event) override

Private Slots
void	reset ()

Private Attributes
Private *const	d {nullptr}

Detailed Description

A button that can detect input and will store its value.

This button, when pressed, will detect input based on what type has been set. It is mainly intended for shortcut configuration, that is, picking some input that is later reused for shortcuts or similar.

Definition at line 23 of file kis_input_button.h.

Member Enumeration Documentation

ButtonType

enum KisInputButton::ButtonType

The type of button.

Enumerator
MouseType	Detect and store any combination of pressed mouse buttons.
KeyType	Detect and store any combination of key presses.
WheelType	Detect and store mouse wheel movement.

Definition at line 30 of file kis_input_button.h.

                    {
        MouseType, 
        KeyType, 
        WheelType, 
    };

Constructor & Destructor Documentation

KisInputButton()

KisInputButton::KisInputButton ( QWidget * parent = nullptr )

explicit

Constructor.

Definition at line 37 of file kis_input_button.cpp.

    : QPushButton(parent), d(new Private(this))
{
    setIcon(KisIconUtils::loadIcon("configure"));
    setText(i18nc("No input for this button", "None"));
    setCheckable(true);
 
    d->resetTimer = new QTimer(this);
    d->resetTimer->setInterval(5000);
    d->resetTimer->setSingleShot(true);
    connect(d->resetTimer, SIGNAL(timeout()), SLOT(reset()));
}

References connect(), d, KisIconUtils::loadIcon(), reset(), and KisInputButton::Private::resetTimer.

~KisInputButton()

KisInputButton::~KisInputButton ( )

override

Destructor.

Definition at line 50 of file kis_input_button.cpp.

{
    delete d;
}

References d.

Member Function Documentation

buttons()

Qt::MouseButtons KisInputButton::buttons

(

)

const

Returns

The mouse buttons that were detected. Only applicable when type is MouseType.

Definition at line 86 of file kis_input_button.cpp.

{
    return d->buttons;
}

References KisInputButton::Private::buttons, and d.

clear

void KisInputButton::clear ( )

slot

Clear all detected input and reset the button to an empty state.

Definition at line 65 of file kis_input_button.cpp.

{
    d->keys.clear();
    d->buttons = QFlags<Qt::MouseButton>();
    d->wheel = KisShortcutConfiguration::NoMovement;
    d->updateLabel();
}

References KisInputButton::Private::buttons, d, KisInputButton::Private::keys, KisShortcutConfiguration::NoMovement, KisInputButton::Private::updateLabel(), and KisInputButton::Private::wheel.

dataChanged

void KisInputButton::dataChanged ( )

signal

Emitted whenever one of the values (keys, buttons, wheel) changes.

keyPressEvent()

void KisInputButton::keyPressEvent ( QKeyEvent * event )

overrideprotected

Definition at line 153 of file kis_input_button.cpp.

{
    if (isChecked()) {
        if (d->newInput) {
            d->keys.clear();
            d->newInput = false;
        }
 
        Qt::Key key = static_cast<Qt::Key>(event->key());
 
        if (key == Qt::Key_Meta && event->modifiers().testFlag(Qt::ShiftModifier)) {
            key = Qt::Key_Alt;
        }
 
        d->keys.append(key);
        d->updateLabel();
        d->resetTimer->start();
    }
}

References d, KisInputButton::Private::keys, KisInputButton::Private::newInput, KisInputButton::Private::resetTimer, and KisInputButton::Private::updateLabel().

keyReleaseEvent()

void KisInputButton::keyReleaseEvent ( QKeyEvent * event )

overrideprotected

Definition at line 173 of file kis_input_button.cpp.

{
    if (isChecked()) {
        reset();
    }
    else if (event->key() == Qt::Key_Space || event->key() == Qt::Key_Enter || event->key() == Qt::Key_Return) {
        setChecked(true);
        setText(i18nc("Waiting for user input", "Input..."));
        d->resetTimer->start();
        d->newInput = true;
    }
}

References d, KisInputButton::Private::newInput, reset(), and KisInputButton::Private::resetTimer.

keys()

QList< Qt::Key > KisInputButton::keys

(

)

const

Returns

The list of keys that was detected. Only applicable when type is KeyType.

Definition at line 73 of file kis_input_button.cpp.

{
    return d->keys;
}

References d, and KisInputButton::Private::keys.

mousePressEvent()

void KisInputButton::mousePressEvent ( QMouseEvent * event )

overrideprotected

Definition at line 112 of file kis_input_button.cpp.

{
    if (isChecked()  && d->type == KisInputButton::MouseType) {
        d->buttons = event->buttons();
        d->updateLabel();
        d->resetTimer->start();
    }
}

References KisInputButton::Private::buttons, d, MouseType, KisInputButton::Private::resetTimer, KisInputButton::Private::type, and KisInputButton::Private::updateLabel().

mouseReleaseEvent()

void KisInputButton::mouseReleaseEvent ( QMouseEvent * )

overrideprotected

Definition at line 121 of file kis_input_button.cpp.

{
    if (isChecked()) {
        reset();
    }
    else {
        setChecked(true);
        setText(i18nc("Waiting for user input", "Input..."));
        d->resetTimer->start();
        d->newInput = true;
    }
}

References d, KisInputButton::Private::newInput, reset(), and KisInputButton::Private::resetTimer.

reset

void KisInputButton::reset ( )

privateslot

Definition at line 186 of file kis_input_button.cpp.

{
    setChecked(false);
    d->updateLabel();
    Q_EMIT dataChanged();
}

References d, dataChanged(), and KisInputButton::Private::updateLabel().

setButtons()

void KisInputButton::setButtons

(

Qt::MouseButtons

newButtons

)

Set the mouse buttons to display.

This is mostly intended to make sure the button displays the right buttons when viewed in a dialog or similar UI.

Only applicable when type is MouseType.

Parameters

newButtons

The mouse buttons to display.

Definition at line 91 of file kis_input_button.cpp.

{
    if (newButtons != d->buttons) {
        d->buttons = newButtons;
        d->updateLabel();
    }
}

References KisInputButton::Private::buttons, d, and KisInputButton::Private::updateLabel().

setKeys()

void KisInputButton::setKeys

(

const QList< Qt::Key > &

newKeys

)

Set the list of keys to display.

This is mostly intended to make sure the button displays the right keys when viewed in a dialog or similar UI.

Only applicable when type is KeyType.

Parameters

newKeys

The list of keys to display.

Definition at line 78 of file kis_input_button.cpp.

{
    if (newKeys != d->keys) {
        d->keys = newKeys;
        d->updateLabel();
    }
}

References d, KisInputButton::Private::keys, and KisInputButton::Private::updateLabel().

setType()

void KisInputButton::setType

(

KisInputButton::ButtonType

newType

)

Set the type of input this button should detect.

Parameters

newType

The type of input to detect.

Definition at line 60 of file kis_input_button.cpp.

{
    d->type = newType;
}

References d, and KisInputButton::Private::type.

setWheel()

void KisInputButton::setWheel

(

KisShortcutConfiguration::MouseWheelMovement

wheel

)

Set the mouse wheel movement to display.

This is mostly intended to make sure the button displays the right wheel movement when viewed in a dialog or similar UI.

Only applicable when type is WheelType.

Parameters

wheel

The wheel movement to display.

Definition at line 104 of file kis_input_button.cpp.

{
    if (newWheel != d->wheel) {
        d->wheel = newWheel;
        d->updateLabel();
    }
}

References d, KisInputButton::Private::updateLabel(), and KisInputButton::Private::wheel.

type()

KisInputButton::ButtonType KisInputButton::type

(

)

const

Returns

The type of input this button detects.

Definition at line 55 of file kis_input_button.cpp.

{
    return d->type;
}

References d, and KisInputButton::Private::type.

wheel()

KisShortcutConfiguration::MouseWheelMovement KisInputButton::wheel

(

)

const

Returns

The mouse wheel movement that was detected. Only applicable when type is WheelType.

Definition at line 99 of file kis_input_button.cpp.

{
    return d->wheel;
}

References d, and KisInputButton::Private::wheel.

wheelEvent()

void KisInputButton::wheelEvent ( QWheelEvent * event )

overrideprotected

Definition at line 134 of file kis_input_button.cpp.

{
    if (isChecked() && !event->angleDelta().isNull()) {
        if (event->angleDelta().x() < 0) {
            d->wheel = KisShortcutConfiguration::WheelRight;
        } else if (event->angleDelta().x() > 0) {
            d->wheel = KisShortcutConfiguration::WheelLeft;
        }
 
        if (event->angleDelta().y() < 0) {
            d->wheel = KisShortcutConfiguration::WheelDown;
        } else if (event->angleDelta().y() > 0) {
            d->wheel = KisShortcutConfiguration::WheelUp;
        }
 
        d->updateLabel();
    }
}

References d, KisInputButton::Private::updateLabel(), KisInputButton::Private::wheel, KisShortcutConfiguration::WheelDown, KisShortcutConfiguration::WheelLeft, KisShortcutConfiguration::WheelRight, and KisShortcutConfiguration::WheelUp.

Member Data Documentation

d

Private* const KisInputButton::d {nullptr}

private

Definition at line 128 of file kis_input_button.h.

{nullptr};

---

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

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