Replace Text::wrap property with Text::wrapMode enumeration.

wrap remains for a little while, and will produce a warning.

3 files changed, 51 insertions, 24 deletions

diff --git a/src/declarative/graphicsitems/qdeclarativetext.cpp b/src/declarative/graphicsitems/qdeclarativetext.cpp
index a4f3068..c950e31 100644
--- a/src/declarative/graphicsitems/qdeclarativetext.cpp
+++ b/src/declarative/graphicsitems/qdeclarativetext.cpp
@@ -42,6 +42,7 @@
 #include "private/qdeclarativetext_p.h"
 #include "private/qdeclarativetext_p_p.h"
 #include <qdeclarativestyledtext_p.h>
+#include <qdeclarativeinfo.h>
 
 #include <QTextLayout>
 #include <QTextLine>
@@ -70,7 +71,7 @@ QT_BEGIN_NAMESPACE
     \image declarative-text.png
 
     If height and width are not explicitly set, Text will attempt to determine how
-    much room is needed and set it accordingly. Unless \c wrap is set, it will always
+    much room is needed and set it accordingly. Unless \c wrapMode is set, it will always
     prefer width to height (all text will be placed on a single line).
 
     The \c elide property can alternatively be used to fit a single line of
@@ -98,7 +99,7 @@ QT_BEGIN_NAMESPACE
     \image text.png
 
     If height and width are not explicitly set, Text will attempt to determine how
-    much room is needed and set it accordingly. Unless \c wrap is set, it will always
+    much room is needed and set it accordingly. Unless \c wrapMode is set, it will always
     prefer width to height (all text will be placed on a single line).
 
     The \c elide property can alternatively be used to fit a line of plain text to a set width.
@@ -319,37 +320,52 @@ void QDeclarativeText::setVAlign(VAlignment align)
 }
 
 /*!
-    \qmlproperty bool Text::wrap
+    \qmlproperty enumeration Text::wrapMode
 
     Set this property to wrap the text to the Text item's width.  The text will only
-    wrap if an explicit width has been set.
+    wrap if an explicit width has been set.  wrapMode can be one of:
 
-    Wrapping is done on word boundaries (i.e. it is a "word-wrap"). If the text cannot be
+    \list
+    \o NoWrap - no wrapping will be performed.
+    \o WordWrap - wrapping is done on word boundaries. If the text cannot be
     word-wrapped to the specified width it will be partially drawn outside of the item's bounds.
     If this is undesirable then enable clipping on the item (Item::clip).
+    \endlist
 
-    Wrapping is off by default.
+    The default is NoWrap.
 */
-//### Future may provide choice of wrap modes, such as QTextOption::WrapAtWordBoundaryOrAnywhere
-bool QDeclarativeText::wrap() const
+QDeclarativeText::WrapMode QDeclarativeText::wrapMode() const
 {
     Q_D(const QDeclarativeText);
-    return d->wrap;
+    return d->wrapMode;
 }
 
-void QDeclarativeText::setWrap(bool w)
+void QDeclarativeText::setWrapMode(WrapMode mode)
 {
     Q_D(QDeclarativeText);
-    if (w == d->wrap)
+    if (mode == d->wrapMode)
         return;
 
-    d->wrap = w;
+    d->wrapMode = mode;
 
     d->updateLayout();
     d->markImgDirty();
-    emit wrapChanged(d->wrap);
+    emit wrapModeChanged();
+}
+
+bool QDeclarativeText::wrap() const
+{
+    Q_D(const QDeclarativeText);
+    return d->wrapMode != NoWrap;
+}
+
+void QDeclarativeText::setWrap(bool w)
+{
+    qmlInfo(this) << "\"wrap\" property is deprecated and will soon be removed.  Use wrapMode";
+    setWrapMode(WordWrap);
 }
 
+
 /*!
     \qmlproperty enumeration Text::textFormat
 
@@ -437,7 +453,7 @@ void QDeclarativeText::setTextFormat(TextFormat format)
     Set this property to elide parts of the text fit to the Text item's width.
     The text will only elide if an explicit width has been set.
 
-    This property cannot be used with wrap enabled or with rich text.
+    This property cannot be used with wrapping enabled or with rich text.
 
     Eliding can be \c ElideNone (the default), \c ElideLeft, \c ElideMiddle, or \c ElideRight.
 
@@ -471,7 +487,7 @@ void QDeclarativeText::geometryChanged(const QRectF &newGeometry,
 {
     Q_D(QDeclarativeText);
     if (newGeometry.width() != oldGeometry.width()) {
-        if (d->wrap || d->elideMode != QDeclarativeText::ElideNone) {
+        if (d->wrapMode != QDeclarativeText::NoWrap || d->elideMode != QDeclarativeText::ElideNone) {
             //re-elide if needed
             if (d->singleline && d->elideMode != QDeclarativeText::ElideNone &&
                 isComponentComplete() && widthValid()) {
@@ -538,12 +554,12 @@ void QDeclarativeTextPrivate::updateSize()
             singleline = false; // richtext can't elide or be optimized for single-line case
             doc->setDefaultFont(font);
             QTextOption option((Qt::Alignment)int(hAlign | vAlign));
-            if (wrap)
+            if (wrapMode == QDeclarativeText::WordWrap)
                 option.setWrapMode(QTextOption::WordWrap);
             else
                 option.setWrapMode(QTextOption::NoWrap);
             doc->setDefaultTextOption(option);
-            if (wrap && !q->heightValid() && q->widthValid())
+            if (wrapMode != QDeclarativeText::NoWrap && !q->heightValid() && q->widthValid())
                 doc->setTextWidth(q->width());
             else
                 doc->setTextWidth(doc->idealWidth()); // ### Text does not align if width is not set (QTextDoc bug)
@@ -623,7 +639,7 @@ QSize QDeclarativeTextPrivate::setupTextLayout(QTextLayout *layout)
     qreal lineWidth = 0;
 
     //set manual width
-    if ((wrap || elideMode != QDeclarativeText::ElideNone) && q->widthValid())
+    if ((wrapMode != QDeclarativeText::NoWrap || elideMode != QDeclarativeText::ElideNone) && q->widthValid())
         lineWidth = q->width();
 
     layout->beginLayout();
@@ -633,7 +649,7 @@ QSize QDeclarativeTextPrivate::setupTextLayout(QTextLayout *layout)
         if (!line.isValid())
             break;
 
-        if ((wrap || elideMode != QDeclarativeText::ElideNone) && q->widthValid())
+        if ((wrapMode != QDeclarativeText::NoWrap || elideMode != QDeclarativeText::ElideNone) && q->widthValid())
             line.setLineWidth(lineWidth);
     }
     layout->endLayout();
diff --git a/src/declarative/graphicsitems/qdeclarativetext_p.h b/src/declarative/graphicsitems/qdeclarativetext_p.h
index cbea8f3..7a09b2f 100644
--- a/src/declarative/graphicsitems/qdeclarativetext_p.h
+++ b/src/declarative/graphicsitems/qdeclarativetext_p.h
@@ -42,6 +42,7 @@
 #ifndef QDECLARATIVETEXT_H
 #define QDECLARATIVETEXT_H
 
+#include <QtGui/qtextoption.h>
 #include "qdeclarativeitem.h"
 
 QT_BEGIN_HEADER
@@ -58,6 +59,7 @@ class Q_DECLARATIVE_EXPORT QDeclarativeText : public QDeclarativeItem
     Q_ENUMS(TextStyle)
     Q_ENUMS(TextFormat)
     Q_ENUMS(TextElideMode)
+    Q_ENUMS(WrapMode)
 
     Q_PROPERTY(QString text READ text WRITE setText NOTIFY textChanged)
     Q_PROPERTY(QFont font READ font WRITE setFont NOTIFY fontChanged)
@@ -66,7 +68,8 @@ class Q_DECLARATIVE_EXPORT QDeclarativeText : public QDeclarativeItem
     Q_PROPERTY(QColor styleColor READ styleColor WRITE setStyleColor NOTIFY styleColorChanged)
     Q_PROPERTY(HAlignment horizontalAlignment READ hAlign WRITE setHAlign NOTIFY horizontalAlignmentChanged)
     Q_PROPERTY(VAlignment verticalAlignment READ vAlign WRITE setVAlign NOTIFY verticalAlignmentChanged)
-    Q_PROPERTY(bool wrap READ wrap WRITE setWrap NOTIFY wrapChanged) //### there are several wrap modes in Qt
+    Q_PROPERTY(WrapMode wrapMode READ wrapMode WRITE setWrapMode NOTIFY wrapModeChanged)
+    Q_PROPERTY(bool wrap READ wrap WRITE setWrap NOTIFY wrapModeChanged)
     Q_PROPERTY(TextFormat textFormat READ textFormat WRITE setTextFormat NOTIFY textFormatChanged)
     Q_PROPERTY(TextElideMode elide READ elideMode WRITE setElideMode NOTIFY elideModeChanged) //### elideMode?
 
@@ -93,6 +96,12 @@ public:
                           ElideMiddle = Qt::ElideMiddle,
                           ElideNone = Qt::ElideNone };
 
+    enum WrapMode { NoWrap = QTextOption::NoWrap,
+                    WordWrap = QTextOption::WordWrap
+//                    WrapAnywhere = QTextOption::WrapAnywhere,
+//                    WrapAtWordBoundaryOrAnywhere = QTextOption::WrapAtWordBoundaryOrAnywhere
+                  };
+
     QString text() const;
     void setText(const QString &);
 
@@ -116,6 +125,8 @@ public:
 
     bool wrap() const;
     void setWrap(bool w);
+    WrapMode wrapMode() const;
+    void setWrapMode(WrapMode w);
 
     TextFormat textFormat() const;
     void setTextFormat(TextFormat format);
@@ -136,7 +147,7 @@ Q_SIGNALS:
     void styleColorChanged(const QColor &color);
     void horizontalAlignmentChanged(HAlignment alignment);
     void verticalAlignmentChanged(VAlignment alignment);
-    void wrapChanged(bool wrap);
+    void wrapModeChanged();
     void textFormatChanged(TextFormat textFormat);
     void elideModeChanged(TextElideMode mode);
 
diff --git a/src/declarative/graphicsitems/qdeclarativetext_p_p.h b/src/declarative/graphicsitems/qdeclarativetext_p_p.h
index 85a65ce..cc5a9f2 100644
--- a/src/declarative/graphicsitems/qdeclarativetext_p_p.h
+++ b/src/declarative/graphicsitems/qdeclarativetext_p_p.h
@@ -72,8 +72,8 @@ public:
     QDeclarativeTextPrivate()
       : color((QRgb)0), style(QDeclarativeText::Normal),
         hAlign(QDeclarativeText::AlignLeft), vAlign(QDeclarativeText::AlignTop), elideMode(QDeclarativeText::ElideNone),
-        imgDirty(true), dirty(true), wrap(false), richText(false), singleline(false), cache(true), doc(0),
-        format(QDeclarativeText::AutoText)
+        imgDirty(true), dirty(true), richText(false), singleline(false), cache(true), doc(0),
+        format(QDeclarativeText::AutoText), wrapMode(QDeclarativeText::NoWrap)
     {
 #if defined(QML_NO_TEXT_CACHE)
         cache = false;
@@ -115,7 +115,6 @@ public:
     QDeclarativeText::TextElideMode elideMode;
     bool imgDirty:1;
     bool dirty:1;
-    bool wrap:1;
     bool richText:1;
     bool singleline:1;
     bool cache:1;
@@ -123,6 +122,7 @@ public:
     QTextLayout layout;
     QSize cachedLayoutSize;
     QDeclarativeText::TextFormat format;
+    QDeclarativeText::WrapMode wrapMode;
 };
 
 QT_END_NAMESPACE