From eb3383fab42ee1e741d54e044bfb7246640a57a5 Mon Sep 17 00:00:00 2001
From: Mitch Curtis <mitch.curtis@qt.io>
Date: Tue, 17 Jan 2017 10:46:28 +0100
Subject: [PATCH] Doc: clarify how KeyboardStyle::scaleHint is calculated
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Task-number: QTBUG-58154
Change-Id: I0598393589f9ac3933318906ec7aa5d33b1deb61
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
---
src/virtualkeyboard/styles/KeyboardStyle.qml | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/virtualkeyboard/styles/KeyboardStyle.qml b/src/virtualkeyboard/styles/KeyboardStyle.qml
index 8c4dd153..3fa55ca2 100644
--- a/src/virtualkeyboard/styles/KeyboardStyle.qml
+++ b/src/virtualkeyboard/styles/KeyboardStyle.qml
@@ -44,7 +44,7 @@ import QtQuick 2.0
*/
QtObject {
- /*! The current size of the keyboard. */
+ /*! The current height of the keyboard. */
property real keyboardHeight
/*! The design width of the keyboard. */
@@ -53,8 +53,8 @@ QtObject {
/*! The design height of the keyboard. */
property real keyboardDesignHeight
- /*! The keyboard style scale hint. This value is determined by the
- physical size and the design size of the keyboard. All pixel
+ /*! The keyboard style scale hint. This value is determined by dividing
+ \l keyboardHeight by \l keyboardDesignHeight. All pixel
dimensions must be proportional to this value.
*/
readonly property real scaleHint: keyboardHeight / keyboardDesignHeight
--
GitLab