Add convenience function QTextCursor::positionInBlock()

We have a missleading function QTextCursor::columnNumber() since 4.2,
which almost never returns what you want.

The pattern cursor.position() - cursor.block().position() is used
frequently in code using QTextCursor.

Reviewed-by: Roberto Raggi

2 files changed, 26 insertions, 1 deletions

diff --git a/src/gui/text/qtextcursor.cpp b/src/gui/text/qtextcursor.cpp
index c81d538..c91df3c 100644
--- a/src/gui/text/qtextcursor.cpp
+++ b/src/gui/text/qtextcursor.cpp
@@ -1145,7 +1145,7 @@ void QTextCursor::setPosition(int pos, MoveMode m)
     Returns the absolute position of the cursor within the document.
     The cursor is positioned between characters.
 
-    \sa setPosition() movePosition() anchor()
+    \sa setPosition() movePosition() anchor() positionInBlock()
 */
 int QTextCursor::position() const
 {
@@ -1155,6 +1155,22 @@ int QTextCursor::position() const
 }
 
 /*!
+    \since 4.7
+    Returns the relative position of the cursor within the block.
+    The cursor is positioned between characters.
+
+    This is equivalent to \c{ position() - block().position()}.
+
+    \sa position()
+*/
+int QTextCursor::positionInBlock() const
+{
+    if (!d || !d->priv)
+        return 0;
+    return d->position - d->block().position();
+}
+
+/*!
     Returns the anchor position; this is the same as position() unless
     there is a selection in which case position() marks one end of the
     selection and anchor() marks the other end. Just like the cursor
@@ -2414,9 +2430,17 @@ int QTextCursor::blockNumber() const
     return d->block().blockNumber();
 }
 
+
 /*!
     \since 4.2
     Returns the position of the cursor within its containing line.
+
+    Note that this is the column number relative to a wrapped line,
+    not relative to the block (i.e. the paragraph).
+
+    You probably want to call positionInBlock() instead.
+
+    \sa positionInBlock()
 */
 int QTextCursor::columnNumber() const
 {
diff --git a/src/gui/text/qtextcursor.h b/src/gui/text/qtextcursor.h
index 38bc39d..3e968a3 100644
--- a/src/gui/text/qtextcursor.h
+++ b/src/gui/text/qtextcursor.h
@@ -89,6 +89,7 @@ public:
 
     void setPosition(int pos, MoveMode mode = MoveAnchor);
     int position() const;
+    int positionInBlock() const;
 
     int anchor() const;