Qt Reference Documentation

QML KeyEvent Element

The KeyEvent object provides information about a key event. More...

  • List of all members, including inherited members
  • Properties

    Detailed Description

    For example, the following changes the Item's state property when the Enter key is pressed:

     Item {
         focus: true
         Keys.onPressed: { if (event.key == Qt.Key_Enter) state = 'ShowDetails'; }

    Property Documentation

    accepted : bool

    Setting accepted to true prevents the key event from being propagated to the item's parent.

    Generally, if the item acts on the key event then it should be accepted so that ancestor items do not also respond to the same event.

    read-onlycount : int

    This property holds the number of keys involved in this event. If KeyEvent::text is not empty, this is simply the length of the string.

    read-onlyisAutoRepeat : bool

    This property holds whether this event comes from an auto-repeating key.

    read-onlykey : int

    This property holds the code of the key that was pressed or released.

    See Qt.Key for the list of keyboard codes. These codes are independent of the underlying window system. Note that this function does not distinguish between capital and non-capital letters, use the text() function (returning the Unicode text the key generated) for this purpose.

    A value of either 0 or Qt.Key_Unknown means that the event is not the result of a known key; for example, it may be the result of a compose sequence, a keyboard macro, or due to key event compression.

    read-onlytext : string

    This property holds the Unicode text that the key generated. The text returned can be an empty string in cases where modifier keys, such as Shift, Control, Alt, and Meta, are being pressed or released. In such cases key will contain a valid value


    Thank you for giving your feedback.

    Make sure it is related to this specific page. For more general bugs and requests, please use the Qt Bug Tracker.

    [0]; s.parentNode.insertBefore(ga, s); })();