*
*/
-// INTERNAL INCLUDE
-#include <dali-toolkit/internal/text/text-definitions.h>
-
// EXTERNAL INCLUDE
#include <dali/public-api/common/dali-vector.h>
+#include <dali/public-api/math/vector2.h>
+
+// INTERNAL INCLUDE
+#include <dali-toolkit/internal/text/line-run.h>
namespace Dali
{
namespace Text
{
-class VisualModel;
+struct LayoutParameters;
/**
* @brief LayoutEngine is responsible for calculating the visual position of glyphs in layout.
MULTI_LINE_BOX
};
+ enum HorizontalAlignment
+ {
+ HORIZONTAL_ALIGN_BEGIN,
+ HORIZONTAL_ALIGN_CENTER,
+ HORIZONTAL_ALIGN_END
+ };
+
+ enum VerticalAlignment
+ {
+ VERTICAL_ALIGN_TOP,
+ VERTICAL_ALIGN_CENTER,
+ VERTICAL_ALIGN_BOTTOM
+ };
+
/**
* @brief Create a new instance of a LayoutEngine.
*/
unsigned int GetLayout() const;
/**
+ * @brief Enable or disable the text ellipsis.
+ *
+ * @param[in] enabled Whether to enable the text ellipsis.
+ */
+ void SetTextEllipsisEnabled( bool enabled );
+
+ /**
+ * @return Whether the text ellipsis is enabled.
+ */
+ bool GetTextEllipsisEnabled() const;
+
+ /**
+ * @brief Choose the required text horizontal alignment.
+ *
+ * @param[in] alignment The required alignment.
+ */
+ void SetHorizontalAlignment( HorizontalAlignment alignment );
+
+ /**
+ * @brief Query the required text horizontal alignment.
+ *
+ * @return The required alignment.
+ */
+ HorizontalAlignment GetHorizontalAlignment() const;
+
+ /**
+ * @brief Choose the required text vertical alignment.
+ *
+ * @param[in] alignment The required alignment.
+ */
+ void SetVerticalAlignment( VerticalAlignment alignment );
+
+ /**
+ * @brief Query the required text vertical alignment.
+ *
+ * @return The required alignment.
+ */
+ VerticalAlignment GetVerticalAlignment() const;
+
+ /**
* @brief Store the visual position of glyphs in the VisualModel.
*
- * @param[in] boundingBox The size of the box containing the text.
- * @param[in] glyphs A vector with glyphs.
- * @param[in] characterIndices Vector with indices pointing the first character of each glyph.
- * @param[in] charactersPerGlyph Vector with the number of characters that forms each glyph.
- * @param[in] visualModel The visual model to update.
+ * @param[in] layoutParameters The parameters needed to layout the text.
+ * @param[out] glyphPositions The positions of all the glyphs.
+ * @param[out] lines The laid-out lines.
+ * @param[out] actualSize The size of the text after it has been laid-out.
+ *
+ * @return \e true if the text has been re-laid-out. \e false means the given width is too small to layout even a single character.
+ */
+ bool LayoutText( const LayoutParameters& layoutParameters,
+ Vector<Vector2>& glyphPositions,
+ Vector<LineRun>& lines,
+ Size& actualSize );
+
+ /**
+ * @brief Re-lays out those lines with right to left characters.
+ *
+ * It doesn't change the phisical position of the glyphs in the model but sets their new position.
+ *
+ * @param[in] layoutParameters The parameters needed to layout the text.
+ * @param[in,out] glyphPositions The positions of all the glyphs.
+ */
+ void ReLayoutRightToLeftLines( const LayoutParameters& layoutParameters,
+ Vector<Vector2>& glyphPositions );
+
+ /**
+ * @brief Aligns the laid out lines.
+ *
+ * @param[in] layoutSize The size of the laid out the text.
+ * @param[in,out] lines The laid-out lines.
*/
- void UpdateVisualModel( const Vector2& boundingBox,
- const Vector<GlyphInfo>& glyphs,
- const Vector<CharacterIndex>& characterIndices,
- const Vector<Length>& charactersPerGlyph,
- VisualModel& visualModel );
+ void Align( const Size& layoutSize,
+ Vector<LineRun>& lines );
private: