Add QTextOption/QTextEdit/QPlainTextEdit::tabStopDistance property

In Qt, we have QTextOption::tabStop, QTextEdit::tabStopWidth and
QPlainTextEdit::tabStopWidth.

Neither are very good names, since the tab stop is neither a
numerical value as in the former, nor does it have any dimensions
that can be measured, as in the latter. Vertical text advances
may also be supported by Qt at some point in the future, at
which point the name would make even less sense.

At the same time, we expose the actual type of the tab stop
distance as floating point in the QTextEdit and QPlainTextEdit
API instead of always rounding it to an int.

To avoid duplicating either of these APIs in Qt Quick, we
introduce tabStopDistance as the common term instead and deprecate
the old names.

[ChangeLog][Text] Introduced tabStopDistance property in
QTextOption, QTextEdit and QPlainTextEdit as replacement for
the inconsistently named tabStop and tabStopWidth properties.
QTextOption::tabStop, QTextEdit::tabStopWidth and
QPlainTextEdit::tabStopWidth have subsequently been deprecated.

Change-Id: Ib7e01387910cddb58adaaaadcd56c0e69edc4bc2
Reviewed-by: Paolo Angelelli <paolo.angelelli@qt.io>
Reviewed-by: Lars Knoll <lars.knoll@qt.io>

1 files changed, 28 insertions, 5 deletions

diff --git a/src/gui/text/qtextoption.cpp b/src/gui/text/qtextoption.cpp
index 87e31eeb2c..2a16f50f33 100644
--- a/src/gui/text/qtextoption.cpp
+++ b/src/gui/text/qtextoption.cpp
@@ -144,7 +144,7 @@ QTextOption &QTextOption::operator=(const QTextOption &o)
     Sets the tab positions for the text layout to those specified by
     \a tabStops.
 
-    \sa tabArray(), setTabStop(), setTabs()
+    \sa tabArray(), setTabStopDistance(), setTabs()
 */
 void QTextOption::setTabArray(const QList<qreal> &tabStops)
 {
@@ -332,22 +332,45 @@ QList<QTextOption::Tab> QTextOption::tabs() const
   \sa flags()
 */
 
+#if QT_DEPRECATED_SINCE(5, 10)
 /*!
   \fn qreal QTextOption::tabStop() const
+  \deprecated in Qt 5.10. Use tabStopDistance() instead.
 
   Returns the distance in device units between tab stops.
   Convenient function for the above method
 
-  \sa setTabStop(), tabArray(), setTabs(), tabs()
+  \sa setTabStopDistance(), tabArray(), setTabs(), tabs()
 */
 
 /*!
   \fn void QTextOption::setTabStop(qreal tabStop)
+  \deprecated in Qt 5.10. Use setTabStopDistance() instead.
 
   Sets the default distance in device units between tab stops to the value specified
   by \a tabStop.
 
-  \sa tabStop(), setTabArray(), setTabs(), tabs()
+  \sa tabStopDistance(), setTabArray(), setTabs(), tabs()
+*/
+#endif
+
+/*!
+  \fn qreal QTextOption::tabStopDistance() const
+  \since 5.10
+
+  Returns the distance in device units between tab stops.
+
+  \sa setTabStopDistance(), tabArray(), setTabs(), tabs()
+*/
+
+/*!
+  \fn void QTextOption::setTabStopDistance(qreal tabStopDistance)
+  \since 5.10
+
+  Sets the default distance in device units between tab stops to the value specified
+  by \a tabStopDistance.
+
+  \sa tabStopDistance(), setTabArray(), setTabs(), tabs()
 */
 
 /*!
@@ -426,7 +449,7 @@ QList<QTextOption::Tab> QTextOption::tabs() const
   \fn void setTabs(const QList<Tab> &tabStops)
   Set the Tab properties to \a tabStops.
 
-  \sa tabStop(), tabs()
+  \sa tabStopDistance(), tabs()
 */
 
 /*!
@@ -434,7 +457,7 @@ QList<QTextOption::Tab> QTextOption::tabs() const
   \fn QList<QTextOption::Tab> QTextOption::tabs() const
   Returns a list of tab positions defined for the text layout.
 
-  \sa tabStop(), setTabs(), setTabStop()
+  \sa tabStopDistance(), setTabs(), setTabStop()
 */