Implemented suffix and prefix strings for the numbering in ordered lists as supported by ODF. Works also with HTML import/export by using Qt CSS properties extensions.

Merge-request: 1642
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@nokia.com>

11 files changed, 193 insertions, 8 deletions

diff --git a/src/gui/text/qcssparser.cpp b/src/gui/text/qcssparser.cpp
index 3fc6722..dafc8e7 100644
--- a/src/gui/text/qcssparser.cpp
+++ b/src/gui/text/qcssparser.cpp
@@ -68,6 +68,8 @@ static const QCssKnownValue properties[NumProperties - 1] = {
     { "-qt-background-role", QtBackgroundRole },
     { "-qt-block-indent", QtBlockIndent },
     { "-qt-list-indent", QtListIndent },
+    { "-qt-list-number-prefix", QtListNumberPrefix },
+    { "-qt-list-number-suffix", QtListNumberSuffix },
     { "-qt-paragraph-type", QtParagraphType },
     { "-qt-style-features", QtStyleFeatures },
     { "-qt-table-type", QtTableType },
diff --git a/src/gui/text/qcssparser_p.h b/src/gui/text/qcssparser_p.h
index 138d506..ca9688e 100644
--- a/src/gui/text/qcssparser_p.h
+++ b/src/gui/text/qcssparser_p.h
@@ -178,6 +178,8 @@ enum Property {
     OutlineBottomRightRadius,
     FontVariant,
     TextTransform,
+    QtListNumberPrefix,
+    QtListNumberSuffix,
     NumProperties
 };
 
diff --git a/src/gui/text/qtextdocument.cpp b/src/gui/text/qtextdocument.cpp
index 42d6c66..887ac6c 100644
--- a/src/gui/text/qtextdocument.cpp
+++ b/src/gui/text/qtextdocument.cpp
@@ -2591,14 +2591,40 @@ void QTextHtmlExporter::emitBlock(const QTextBlock &block)
                 default: html += QLatin1String("<ul"); // ### should not happen
             }
 
-            html += QLatin1String(" style=\"margin-top: 0px; margin-bottom: 0px; margin-left: 0px; margin-right: 0px;");
+            QString styleString = QString::fromLatin1("margin-top: 0px; margin-bottom: 0px; margin-left: 0px; margin-right: 0px;");
 
             if (format.hasProperty(QTextFormat::ListIndent)) {
-                html += QLatin1String(" -qt-list-indent: ");
-                html += QString::number(format.indent());
-                html += QLatin1Char(';');
+                styleString += QLatin1String(" -qt-list-indent: ");
+                styleString += QString::number(format.indent());
+                styleString += QLatin1Char(';');
+            }
+
+            if (format.hasProperty(QTextFormat::ListNumberPrefix)) {
+                QString numberPrefix = format.numberPrefix();
+                numberPrefix.replace('"', "\\22");
+                numberPrefix.replace('\'', "\\27"); // FIXME: There's a problem in the CSS parser the prevents this from being correctly restored
+                styleString += QLatin1String(" -qt-list-number-prefix: ");
+                styleString += QLatin1Char('\'');
+                styleString += numberPrefix;
+                styleString += QLatin1Char('\'');
+                styleString += QLatin1Char(';');
             }
 
+            if (format.hasProperty(QTextFormat::ListNumberSuffix)) {
+                if (format.numberSuffix() != QLatin1String(".")) { // this is our default
+                    QString numberSuffix = format.numberSuffix();
+                    numberSuffix.replace('"', "\\22");
+                    numberSuffix.replace('\'', "\\27"); // see above
+                    styleString += QLatin1String(" -qt-list-number-suffix: ");
+                    styleString += QLatin1Char('\'');
+                    styleString += numberSuffix;
+                    styleString += QLatin1Char('\'');
+                    styleString += QLatin1Char(';');
+                }
+            }
+
+            html += QLatin1String(" style=\"");
+            html += styleString;
             html += QLatin1String("\">");
         }
 
diff --git a/src/gui/text/qtextdocumentfragment.cpp b/src/gui/text/qtextdocumentfragment.cpp
index 7c5f973..d2e2c9f 100644
--- a/src/gui/text/qtextdocumentfragment.cpp
+++ b/src/gui/text/qtextdocumentfragment.cpp
@@ -683,6 +683,10 @@ QTextHtmlImporter::ProcessNodeResult QTextHtmlImporter::processSpecialNodes()
 
             QTextListFormat listFmt;
             listFmt.setStyle(style);
+            if (!currentNode->textListNumberPrefix.isNull())
+                listFmt.setNumberPrefix(currentNode->textListNumberPrefix);
+            if (!currentNode->textListNumberSuffix.isNull())
+                listFmt.setNumberSuffix(currentNode->textListNumberSuffix);
 
             ++indent;
             if (currentNode->hasCssListIndent)
diff --git a/src/gui/text/qtextformat.cpp b/src/gui/text/qtextformat.cpp
index e0a4096..ffa0ebc 100644
--- a/src/gui/text/qtextformat.cpp
+++ b/src/gui/text/qtextformat.cpp
@@ -2227,6 +2227,44 @@ QTextListFormat::QTextListFormat(const QTextFormat &fmt)
     \sa setIndent()
 */
 
+/*!
+    \fn void QTextListFormat::setNumberPrefix(const QString &numberPrefix)
+    \since 4.8
+
+    Sets the list format's number prefix. This can be used with all
+    sorted list types. It does not have any effect on unsorted list types.
+
+    \sa numberPrefix()
+*/
+
+/*!
+    \fn int QTextListFormat::numberPrefix() const
+    \since 4.8
+
+    Returns the list format's number prefix.
+
+    \sa setNumberPrefix()
+*/
+
+/*!
+    \fn void QTextListFormat::setNumberSuffix(const QString &numberSuffix)
+    \since 4.8
+
+    Sets the list format's number suffix. This can be used with all
+    sorted list types. It does not have any effect on unsorted list types.
+    The default suffix is ".".
+
+    \sa numberSuffix()
+*/
+
+/*!
+    \fn int QTextListFormat::numberSuffix() const
+    \since 4.8
+
+    Returns the list format's number suffix.
+
+    \sa setNumberSuffix()
+*/
 
 /*!
     \class QTextFrameFormat
diff --git a/src/gui/text/qtextformat.h b/src/gui/text/qtextformat.h
index ecf48a2..1de83bf 100644
--- a/src/gui/text/qtextformat.h
+++ b/src/gui/text/qtextformat.h
@@ -202,6 +202,8 @@ public:
         // list properties
         ListStyle = 0x3000,
         ListIndent = 0x3001,
+        ListNumberPrefix = 0x3002,
+        ListNumberSuffix = 0x3003,
 
         // table and frame properties
         FrameBorder = 0x4000,
@@ -617,6 +619,14 @@ public:
     inline int indent() const
     { return intProperty(ListIndent); }
 
+    inline void setNumberPrefix(const QString &numberPrefix);
+    inline QString numberPrefix() const
+    { return stringProperty(ListNumberPrefix); }
+
+    inline void setNumberSuffix(const QString &numberSuffix);
+    inline QString numberSuffix() const
+    { return stringProperty(ListNumberSuffix); }
+
 protected:
     explicit QTextListFormat(const QTextFormat &fmt);
     friend class QTextFormat;
@@ -628,6 +638,12 @@ inline void QTextListFormat::setStyle(Style astyle)
 inline void QTextListFormat::setIndent(int aindent)
 { setProperty(ListIndent, aindent); }
 
+inline void QTextListFormat::setNumberPrefix(const QString &numberPrefix)
+{ setProperty(ListNumberPrefix, numberPrefix); }
+
+inline void QTextListFormat::setNumberSuffix(const QString &numberSuffix)
+{ setProperty(ListNumberSuffix, numberSuffix); }
+
 class Q_GUI_EXPORT QTextImageFormat : public QTextCharFormat
 {
 public:
diff --git a/src/gui/text/qtexthtmlparser.cpp b/src/gui/text/qtexthtmlparser.cpp
index e190379..27f647c 100644
--- a/src/gui/text/qtexthtmlparser.cpp
+++ b/src/gui/text/qtexthtmlparser.cpp
@@ -1324,6 +1324,12 @@ void QTextHtmlParserNode::applyCssDeclarations(const QVector<QCss::Declaration>
         case QCss::ListStyle:
             setListStyle(decl.d->values);
             break;
+        case QCss::QtListNumberPrefix:
+            textListNumberPrefix = decl.d->values.first().variant.toString();
+            break;
+        case QCss::QtListNumberSuffix:
+            textListNumberSuffix = decl.d->values.first().variant.toString();
+            break;
         default: break;
         }
     }
diff --git a/src/gui/text/qtexthtmlparser_p.h b/src/gui/text/qtexthtmlparser_p.h
index 94cfa74..20188ab 100644
--- a/src/gui/text/qtexthtmlparser_p.h
+++ b/src/gui/text/qtexthtmlparser_p.h
@@ -180,6 +180,8 @@ struct QTextHtmlParserNode {
     uint displayMode : 3; // QTextHtmlElement::DisplayMode
     uint hasHref : 1;
     QTextListFormat::Style listStyle;
+    QString textListNumberPrefix;
+    QString textListNumberSuffix;
     QString imageName;
     qreal imageWidth;
     qreal imageHeight;
diff --git a/src/gui/text/qtextlist.cpp b/src/gui/text/qtextlist.cpp
index a0ff520..c312d89 100644
--- a/src/gui/text/qtextlist.cpp
+++ b/src/gui/text/qtextlist.cpp
@@ -191,6 +191,13 @@ QString QTextList::itemText(const QTextBlock &blockIt) const
     QString result;
 
     const int style = format().style();
+    QString numberPrefix;
+    QString numberSuffix = QLatin1String(".");
+
+    if (format().hasProperty(QTextFormat::ListNumberPrefix))
+        numberPrefix = format().numberPrefix();
+    if (format().hasProperty(QTextFormat::ListNumberSuffix))
+        numberSuffix = format().numberSuffix();
 
     switch (style) {
         case QTextListFormat::ListDecimal:
@@ -232,7 +239,7 @@ QString QTextList::itemText(const QTextBlock &blockIt) const
                         if (q > 0) {
                             int startDigit = i + (i+3)/4;
                             int numDigits;
-                            if (i % 4) { 
+                            if (i % 4) {
                                 // c[i] == 4|5|9|40|50|90|400|500|900
                                 if ((i-2) % 4) {
                                     // c[i] == 4|9|40|90|400|900 => with substraction (IV, IX, XL, XC, ...)
@@ -263,8 +270,9 @@ QString QTextList::itemText(const QTextBlock &blockIt) const
             Q_ASSERT(false);
     }
     if (blockIt.textDirection() == Qt::RightToLeft)
-        return result.prepend(QLatin1Char('.'));
-    return result + QLatin1Char('.');
+        return numberSuffix + result + numberPrefix;
+    else
+        return numberPrefix + result + numberSuffix;
 }
 
 /*!
diff --git a/src/gui/text/qtextodfwriter.cpp b/src/gui/text/qtextodfwriter.cpp
index 7992de5..04f6913 100644
--- a/src/gui/text/qtextodfwriter.cpp
+++ b/src/gui/text/qtextodfwriter.cpp
@@ -636,7 +636,15 @@ void QTextOdfWriter::writeListFormat(QXmlStreamWriter &writer, QTextListFormat f
             || style == QTextListFormat::ListUpperRoman) {
         writer.writeStartElement(textNS, QString::fromLatin1("list-level-style-number"));
         writer.writeAttribute(styleNS, QString::fromLatin1("num-format"), bulletChar(style));
-        writer.writeAttribute(styleNS, QString::fromLatin1("num-suffix"), QString::fromLatin1("."));
+
+        if (format.hasProperty(QTextFormat::ListNumberSuffix))
+            writer.writeAttribute(styleNS, QString::fromLatin1("num-suffix"), format.numberSuffix());
+        else
+            writer.writeAttribute(styleNS, QString::fromLatin1("num-suffix"), QString::fromLatin1("."));
+
+        if (format.hasProperty(QTextFormat::ListNumberPrefix))
+            writer.writeAttribute(styleNS, QString::fromLatin1("num-prefix"), format.numberPrefix());
+
     } else {
         writer.writeStartElement(textNS, QString::fromLatin1("list-level-style-bullet"));
         writer.writeAttribute(textNS, QString::fromLatin1("bullet-char"), bulletChar(style));
diff --git a/tests/auto/qtextlist/tst_qtextlist.cpp b/tests/auto/qtextlist/tst_qtextlist.cpp
index 3e92836..8ad0898 100644
--- a/tests/auto/qtextlist/tst_qtextlist.cpp
+++ b/tests/auto/qtextlist/tst_qtextlist.cpp
@@ -67,6 +67,9 @@ private slots:
     void item();
     void autoNumbering();
     void autoNumberingRTL();
+    void autoNumberingPrefixAndSuffix();
+    void autoNumberingPrefixAndSuffixRTL();
+    void autoNumberingPrefixAndSuffixHtmlExportImport();
     void romanNumbering();
     void romanNumberingLimit();
     void formatChange();
@@ -128,6 +131,76 @@ void tst_QTextList::autoNumbering()
     QVERIFY(cursor.currentList()->itemText(cursor.block()) == "ab.");
 }
 
+void tst_QTextList::autoNumberingPrefixAndSuffix()
+{
+    QTextListFormat fmt;
+    fmt.setStyle(QTextListFormat::ListLowerAlpha);
+    fmt.setNumberPrefix("-");
+    fmt.setNumberSuffix(")");
+    QTextList *list = cursor.createList(fmt);
+    QVERIFY(list);
+
+    for (int i = 0; i < 27; ++i)
+        cursor.insertBlock();
+
+    QVERIFY(list->count() == 28);
+
+    QVERIFY(cursor.currentList());
+    QVERIFY(cursor.currentList()->itemNumber(cursor.block()) == 27);
+    QVERIFY(cursor.currentList()->itemText(cursor.block()) == "-ab)");
+}
+
+void tst_QTextList::autoNumberingPrefixAndSuffixRTL()
+{
+    QTextBlockFormat bfmt;
+    bfmt.setLayoutDirection(Qt::RightToLeft);
+    cursor.setBlockFormat(bfmt);
+
+    QTextListFormat fmt;
+    fmt.setStyle(QTextListFormat::ListUpperAlpha);
+    fmt.setNumberPrefix("-");
+    fmt.setNumberSuffix("*");
+    QTextList *list = cursor.createList(fmt);
+    QVERIFY(list);
+
+    cursor.insertBlock();
+
+    QVERIFY(list->count() == 2);
+
+    QVERIFY(cursor.currentList()->itemText(cursor.block()) == "*B-");
+}
+
+void tst_QTextList::autoNumberingPrefixAndSuffixHtmlExportImport()
+{
+    QTextListFormat fmt;
+    fmt.setStyle(QTextListFormat::ListLowerAlpha);
+    fmt.setNumberPrefix("\"");
+    fmt.setNumberSuffix("#");
+    fmt.setIndent(10);
+    // FIXME: Would like to test "'" but there's a problem in the css parser (Scanner::preprocess
+    // is called before the values are being parsed), so the quoting does not work.
+    QTextList *list = cursor.createList(fmt);
+    QVERIFY(list);
+
+    for (int i = 0; i < 27; ++i)
+        cursor.insertBlock();
+
+    QVERIFY(list->count() == 28);
+
+    QString htmlExport = doc->toHtml();
+    QTextDocument importDoc;
+    importDoc.setHtml(htmlExport);
+
+    QTextCursor importCursor(&importDoc);
+    for (int i = 0; i < 27; ++i)
+        importCursor.movePosition(QTextCursor::NextBlock);
+
+    QVERIFY(importCursor.currentList());
+    QVERIFY(importCursor.currentList()->itemNumber(importCursor.block()) == 27);
+    QVERIFY(importCursor.currentList()->itemText(importCursor.block()) == "\"ab#");
+    QVERIFY(importCursor.currentList()->format().indent() == 10);
+}
+
 void tst_QTextList::autoNumberingRTL()
 {
     QTextBlockFormat bfmt;