QKeyCombination Class | Qt Core | Qt 6.11.0
Description: The QKeyCombination class stores a combination of a key with optional modifiers.

- Qt 6.11
- Qt Core
- C++ Classes
- QKeyCombination
- Qt 6.11.0 Reference Documentation

# QKeyCombination Class

The QKeyCombination class stores a combination of a key with optional modifiers. More...

Header: | `#include <QKeyCombination>`
CMake: | `find_package(Qt6 REQUIRED COMPONENTS Core)` `target_link_libraries(mytarget PRIVATE Qt6::Core)`
qmake: | `QT += core`
Since: | Qt 6.0

- List of all members, including inherited members
- Deprecated members

This class is equality-comparable.

## Public Functions

| QKeyCombination(Qt::Key key = Qt::Key_unknown)
| QKeyCombination(Qt::KeyboardModifiers modifiers, Qt::Key key = Qt::Key_unknown)
| QKeyCombination(Qt::Modifiers modifiers, Qt::Key key = Qt::Key_unknown)
Qt::Key | key() const
Qt::KeyboardModifiers | keyboardModifiers() const
int | toCombined() const

## Static Public Members

QKeyCombination | fromCombined(int combined)

## Related Non-Members

size_t | qHash(QKeyCombination key, size_t seed = 0)
bool | operator!=(const QKeyCombination &lhs, const QKeyCombination &rhs)
QDataStream & | operator<<(QDataStream &out, QKeyCombination combination)
QDebug | operator<<(QDebug debug, QKeyCombination combination)
bool | operator==(const QKeyCombination &lhs, const QKeyCombination &rhs)
QDataStream & | operator>>(QDataStream &in, QKeyCombination &combination)
QKeyCombination | operator|(Qt::Key key, Qt::KeyboardModifier modifier)
QKeyCombination | operator|(Qt::Key key, Qt::KeyboardModifiers modifiers)
QKeyCombination | operator|(Qt::Key key, Qt::Modifier modifier)
QKeyCombination | operator|(Qt::Key key, Qt::Modifiers modifiers)
QKeyCombination | operator|(Qt::KeyboardModifier modifier, Qt::Key key)
QKeyCombination | operator|(Qt::KeyboardModifiers modifiers, Qt::Key key)
QKeyCombination | operator|(Qt::Modifier modifier, Qt::Key key)
QKeyCombination | operator|(Qt::Modifiers modifiers, Qt::Key key)

## Detailed Description

The QKeyCombination class can be used to represent a combination of a key with zero or more keyboard modifiers.

See also QKeySequence.

## Member Function Documentation

### `[constexpr noexcept]` QKeyCombination::QKeyCombination(Qt::Key key = Qt::Key_unknown)

Constructs a QKeyCombination object that represents the key key and no modifiers.

See also key().

### `[explicit constexpr noexcept]` QKeyCombination::QKeyCombination(Qt::KeyboardModifiers modifiers, Qt::Key key = Qt::Key_unknown)

Constructs a QKeyCombination object that represents the combination of key with the modifiers modifiers.

See also key() and keyboardModifiers().

### `[explicit constexpr noexcept]` QKeyCombination::QKeyCombination(Qt::Modifiers modifiers, Qt::Key key = Qt::Key_unknown)

Constructs a QKeyCombination object that represents the combination of key with the modifiers modifiers.

See also key() and keyboardModifiers().

### `[static constexpr]` QKeyCombination QKeyCombination::fromCombined(int combined)

Constructs a QKeyCombination object by extracting the key and the modifiers out of combined, which must be the result of a bitwise OR between a value of type Qt::Key and value of type Qt::KeyboardModifiers. toCombined() can be used in order to produce valid values for combined.

See also toCombined().

### `[constexpr noexcept]` Qt::Key QKeyCombination::key() const

Returns the key represented by this QKeyCombination object.

See also keyboardModifiers().

### `[constexpr noexcept]` Qt::KeyboardModifiers QKeyCombination::keyboardModifiers() const

Returns the keyboard modifiers represented by this QKeyCombination object.

See also key().

### `[constexpr noexcept]` int QKeyCombination::toCombined() const

Returns an integer value obtained by applying a bitwise OR between the values of key() and keyboardModifiers() represented by this object. A QKeyCombination object can be created from the returned integer value by using fromCombined().

See also fromCombined(), key(), and keyboardModifiers().

## Related Non-Members

### `[constexpr noexcept]` size_t qHash(QKeyCombination key, size_t seed = 0)

Returns the hash value for key, using seed to seed the calculation.

### `[constexpr noexcept]` bool operator!=(const QKeyCombination &lhs, const QKeyCombination &rhs)

Returns `true` if lhs and rhs have different combinations of key and modifiers, otherwise `false`.

### QDataStream &operator<<(QDataStream &out, QKeyCombination combination)

Writes the combination combination into the stream out. Returns out.

See also Serializing Qt Data Types.

### QDebug operator<<(QDebug debug, QKeyCombination combination)

Writes the combination combination into the debug object debug for debugging purposes.

See also Debugging Techniques.

### `[constexpr noexcept]` bool operator==(const QKeyCombination &lhs, const QKeyCombination &rhs)

Returns `true` if lhs and rhs have the same combination of key and modifiers, and `false` otherwise.

### QDataStream &operator>>(QDataStream &in, QKeyCombination &combination)

Reads the combination combination from the stream in. Returns in.

See also Serializing Qt Data Types.

### `[constexpr noexcept]` QKeyCombination operator|(Qt::Modifier modifier, Qt::Key key)

### `[constexpr noexcept]` QKeyCombination operator|(Qt::KeyboardModifier modifier, Qt::Key key)

### `[constexpr noexcept]` QKeyCombination operator|(Qt::Key key, Qt::Modifier modifier)

### `[constexpr noexcept]` QKeyCombination operator|(Qt::Key key, Qt::KeyboardModifier modifier)

Returns a QKeyCombination object that represents the combination of key with the modifier modifier.

### `[constexpr noexcept]` QKeyCombination operator|(Qt::Modifiers modifiers, Qt::Key key)

### `[constexpr noexcept]` QKeyCombination operator|(Qt::KeyboardModifiers modifiers, Qt::Key key)

### `[constexpr noexcept]` QKeyCombination operator|(Qt::Key key, Qt::Modifiers modifiers)

### `[constexpr noexcept]` QKeyCombination operator|(Qt::Key key, Qt::KeyboardModifiers modifiers)

Returns a QKeyCombination object that represents the combination of key with the modifiers modifiers.