// Visual <--> Logical conversion tables.
/**
- * @brief Sets the visual to logical and the logical to visual map tables.
+ * @brief Retrieves the logical cursor index for the given visual cursor index.
*
- * Replaces any map tables previously set.
+ * @pre The method FetchBidirectionalLineInfo() must be called before. If the result of FetchBidirectionalLineInfo() is false,
+ * then the character is not in a bidirectional line and the result will be invalid.
*
- * @note If the number of runs is zero the bidirectional info buffer is cleared.
+ * @param[in] visualCursorIndex The visual cursor index.
*
- * @param[in] bidirectionalInfo Pointer to a buffer with all the bidirectional info runs.
- * @param[in] numberOfRuns The number of bidirectional info runs.
- * @param[in] startIndex Character index from where the conversion tables are set.
- * @param[in] numberOfCharacters The number of characters.
+ * @return The logical cursor index.
*/
- void SetVisualToLogicalMap( const BidirectionalLineInfoRun* const bidirectionalInfo,
- Length numberOfRuns,
- CharacterIndex startIndex,
- Length numberOfCharacters );
+ CharacterIndex GetLogicalCursorIndex( CharacterIndex visualCursorIndex );
/**
* @brief Retrieves the logical character index for the given visual character index.
*
+ * @pre The method FetchBidirectionalLineInfo() must be called before. If the result of FetchBidirectionalLineInfo() is false,
+ * then the character is not in a bidirectional line and the result will be invalid.
+ *
* @param[in] visualCharacterIndex The visual character index.
*
* @return The logical character index.
*/
- CharacterIndex GetLogicalCharacterIndex( CharacterIndex visualCharacterIndex ) const;
+ CharacterIndex GetLogicalCharacterIndex( CharacterIndex visualCharacterIndex );
+
+ /**
+ * @brief Fetch the bidirectional line info for the given character.
+ *
+ * Call GetBidirectionalLineInfo() to retrieve the last fetched line.
+ *
+ * @param[in] characterIndex The character index.
+ *
+ * @return @e true if the given @e character is in a bidirectional line.
+ */
+ bool FetchBidirectionalLineInfo( CharacterIndex characterIndex );
+
+ /**
+ * @brief Retrieves the last fetched bidirectional line info.
+ *
+ * @return The index of the bidirectional line info.
+ */
+ BidirectionalLineRunIndex GetBidirectionalLineInfo() const;
// Text style.
Vector<WordBreakInfo> mWordBreakInfo;
Vector<ParagraphRun> mParagraphInfo;
Vector<BidirectionalParagraphInfoRun> mBidirectionalParagraphInfo;
- Vector<CharacterDirection> mCharacterDirections; ///< For each character, whether is right to left. ( @e flase is left to right, @e true right to left ).
+ Vector<CharacterDirection> mCharacterDirections; ///< For each character, whether is right to left. ( @e flase is left to right, @e true right to left ).
Vector<BidirectionalLineInfoRun> mBidirectionalLineInfo;
- Vector<CharacterIndex> mLogicalToVisualMap; ///< Bidirectional logical to visual conversion table.
- Vector<CharacterIndex> mVisualToLogicalMap; ///< Bidirectional visual to logical conversion table.
- Vector<CharacterIndex> mVisualToLogicalCursorMap; ///< Bidirectional visual to logical cursor conversion table.
+
+ BidirectionalLineRunIndex mBidirectionalLineIndex; ///< The last fetched bidirectional line info.
};
} // namespace Text