.. index:: pair: class; EE::Graphics::RichText
.. _doxid-class_e_e_1_1_graphics_1_1_rich_text:

class EE::Graphics::RichText
============================

.. toctree::
	:hidden:

	struct_EE_Graphics_RichText_RenderParagraph.rst
	struct_EE_Graphics_RichText_RenderSpan.rst

Overview
~~~~~~~~

A drawable class that renders rich text with multiple styles and spans. :ref:`More...<details-class_e_e_1_1_graphics_1_1_rich_text>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <richtext.hpp>
	
	class RichText: public :ref:`EE::Graphics::Drawable<doxid-class_e_e_1_1_graphics_1_1_drawable>` {
	public:
		// structs
	
		struct :ref:`RenderParagraph<doxid-struct_e_e_1_1_graphics_1_1_rich_text_1_1_render_paragraph>`;
		struct :ref:`RenderSpan<doxid-struct_e_e_1_1_graphics_1_1_rich_text_1_1_render_span>`;

		// construction
	
		:ref:`~RichText<doxid-class_e_e_1_1_graphics_1_1_rich_text_1ab561dff9f07532229642970cfd0adfcd>`();

		// methods
	
		static RichText* :ref:`New<doxid-class_e_e_1_1_graphics_1_1_rich_text_1a7636c5820b741b8e58f4533ecc35cab6>`();
		void :ref:`addSpan<doxid-class_e_e_1_1_graphics_1_1_rich_text_1a9c53608738f111a83cd0e6782e9ee0b9>`(const :ref:`String<doxid-class_e_e_1_1_string>`& text, const :ref:`FontStyleConfig<doxid-class_e_e_1_1_graphics_1_1_font_style_config>`& style);
		void :ref:`addSpan<doxid-class_e_e_1_1_graphics_1_1_rich_text_1a57d8f632df1377a90b851007f2912252>`(const :ref:`String<doxid-class_e_e_1_1_string>`& text, :ref:`Font<doxid-class_e_e_1_1_graphics_1_1_font>`* font = nullptr, :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` characterSize = 0, :ref:`Color<doxid-class_e_e_1_1_system_1_1_color>` color = Color::White, :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` style = :ref:`Text::Regular<doxid-class_e_e_1_1_graphics_1_1_text_1a976ce154fcd0c5db68ef076bee2cd109abeaafd66e444285d55db8c87e985bf17>`);
		void :ref:`clear<doxid-class_e_e_1_1_graphics_1_1_rich_text_1aac024dce521ee6f8da375465a40fa27a>`();
		void :ref:`setFontStyleConfig<doxid-class_e_e_1_1_graphics_1_1_rich_text_1a9538c20e577d4dd0ab4a69042f7fa3f0>`(const :ref:`FontStyleConfig<doxid-class_e_e_1_1_graphics_1_1_font_style_config>`& styleConfig);
		:ref:`FontStyleConfig<doxid-class_e_e_1_1_graphics_1_1_font_style_config>`& :ref:`getFontStyleConfig<doxid-class_e_e_1_1_graphics_1_1_rich_text_1a0e07a4d8add3564bbf28333c04b441be>`();
		void :ref:`setAlign<doxid-class_e_e_1_1_graphics_1_1_rich_text_1ab6cbc843b8fb711ab62c8695996a8254>`(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` align);
		void :ref:`setMaxWidth<doxid-class_e_e_1_1_graphics_1_1_rich_text_1a87fa4e5f8beb6989b142d7196674ddc0>`(:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` width);
		:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` :ref:`getMaxWidth<doxid-class_e_e_1_1_graphics_1_1_rich_text_1ac0a75605be30033edd4e168d2e6328b2>`() const;
		std::vector<std::shared_ptr<:ref:`Text<doxid-class_e_e_1_1_graphics_1_1_text>`>>& :ref:`getSpans<doxid-class_e_e_1_1_graphics_1_1_rich_text_1a137efb75dbc97f422b2b85900705e33f>`();
	
		virtual void :target:`draw<doxid-class_e_e_1_1_graphics_1_1_rich_text_1acd468833867484beff2cb03b7115ad42>`(
			const :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>`& X,
			const :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>`& Y,
			const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& scale = Vector2f::One,
			const :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>`& rotation = 0,
			:ref:`BlendMode<doxid-class_e_e_1_1_graphics_1_1_blend_mode>` effect = :ref:`BlendMode::Alpha<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a230d6f586c6781157eb6d36619d9d38d>`(),
			const :ref:`OriginPoint<doxid-namespace_e_e_1_1_math_1a47cc62bca2a0dbfcac92221f66022972>`& rotationCenter = OriginPoint::OriginCenter,
			const :ref:`OriginPoint<doxid-namespace_e_e_1_1_math_1a47cc62bca2a0dbfcac92221f66022972>`& scaleCenter = OriginPoint::OriginCenter
		);
	
		virtual void :target:`draw<doxid-class_e_e_1_1_graphics_1_1_rich_text_1a6755a0b3df5b45c93ac4abc4ffede8cc>`();
		virtual void :target:`draw<doxid-class_e_e_1_1_graphics_1_1_rich_text_1a464b2111e750fff9cc478738e9934201>`(const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& position);
		virtual void :target:`draw<doxid-class_e_e_1_1_graphics_1_1_rich_text_1a8c3136bc374c33bf8078f0d3d1571816>`(const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& position, const :ref:`Sizef<doxid-namespace_e_e_1_1_math_1a86ff02633aa946b0cc0d2c6ef97a3e2d>`& size);
		virtual bool :target:`isStateful<doxid-class_e_e_1_1_graphics_1_1_rich_text_1a33e37eb3ef6ac8d0ebc776a4b261297e>`();
		virtual :ref:`Sizef<doxid-namespace_e_e_1_1_math_1a86ff02633aa946b0cc0d2c6ef97a3e2d>` :target:`getSize<doxid-class_e_e_1_1_graphics_1_1_rich_text_1aeb4beaac960073f2f78df812822a2068>`();
		virtual :ref:`Sizef<doxid-namespace_e_e_1_1_math_1a86ff02633aa946b0cc0d2c6ef97a3e2d>` :target:`getPixelsSize<doxid-class_e_e_1_1_graphics_1_1_rich_text_1ade152df31a7a4b147be3e8a600cb453f>`();
		void :ref:`invalidate<doxid-class_e_e_1_1_graphics_1_1_rich_text_1a99359cf86f2f10391abc5b80745cc8b6>`();
		const std::vector<:ref:`RenderParagraph<doxid-struct_e_e_1_1_graphics_1_1_rich_text_1_1_render_paragraph>`>& :ref:`getLines<doxid-class_e_e_1_1_graphics_1_1_rich_text_1ae04f4c2e8c6e0b54c665140569511936>`() const;
	};

Inherited Members
-----------------

.. ref-code-block:: cpp
	:class: doxyrest-overview-inherited-code-block

	public:
		// enums
	
		enum :ref:`Type<doxid-class_e_e_1_1_graphics_1_1_drawable_1a581cd8156129550f6b1ece8c946a2028>`;

		// methods
	
		virtual :ref:`Sizef<doxid-namespace_e_e_1_1_math_1a86ff02633aa946b0cc0d2c6ef97a3e2d>` :ref:`getSize<doxid-class_e_e_1_1_graphics_1_1_drawable_1a31fa7ecc79c49f64a8d1ab01a6732a0a>`() = 0;
		virtual :ref:`Sizef<doxid-namespace_e_e_1_1_math_1a86ff02633aa946b0cc0d2c6ef97a3e2d>` :ref:`getPixelsSize<doxid-class_e_e_1_1_graphics_1_1_drawable_1a43f78655995bcbd75c4c627770f6c29e>`() = 0;
		virtual void :ref:`draw<doxid-class_e_e_1_1_graphics_1_1_drawable_1a868402d22e4f5c94409a1fa3693771cc>`() = 0;
		virtual void :ref:`draw<doxid-class_e_e_1_1_graphics_1_1_drawable_1a9aa043b3b2d2d54b6c13d6a81ac5deea>`(const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& position) = 0;
		virtual void :ref:`draw<doxid-class_e_e_1_1_graphics_1_1_drawable_1a2bc0a7a3c7abb5516bc1b28bf1f06c18>`(const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& position, const :ref:`Sizef<doxid-namespace_e_e_1_1_math_1a86ff02633aa946b0cc0d2c6ef97a3e2d>`& size) = 0;
		virtual bool :ref:`isStateful<doxid-class_e_e_1_1_graphics_1_1_drawable_1a98cf5ec5882c2a23e7ca998fb85892ff>`() = 0;
		void :ref:`setAlpha<doxid-class_e_e_1_1_graphics_1_1_drawable_1a5029ab344d43c22687f5617d08256cc3>`(:ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>` alpha);
		const :ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`& :ref:`getAlpha<doxid-class_e_e_1_1_graphics_1_1_drawable_1a16c7d389005e8ee3c27792f7c13f8577>`();
		void :ref:`setColor<doxid-class_e_e_1_1_graphics_1_1_drawable_1a62062adbf06a6db5dd5e0e4f41342f49>`(const :ref:`Color<doxid-class_e_e_1_1_system_1_1_color>`& color);
		const :ref:`Color<doxid-class_e_e_1_1_system_1_1_color>`& :ref:`getColor<doxid-class_e_e_1_1_graphics_1_1_drawable_1a22e0ac65519395aec34ce19cb0e7c647>`() const;
		void :ref:`setColorFilter<doxid-class_e_e_1_1_graphics_1_1_drawable_1a128ef0370c2d7590b5de1fbb110b8d2e>`(const :ref:`Color<doxid-class_e_e_1_1_system_1_1_color>`& color);
		:ref:`RGB<doxid-class_e_e_1_1_system_1_1_r_g_b>` :ref:`getColorFilter<doxid-class_e_e_1_1_graphics_1_1_drawable_1a14b3ac3b90e0906f2159ebe5b869ba60>`();
		void :ref:`clearColor<doxid-class_e_e_1_1_graphics_1_1_drawable_1abb509b0ae153b9dd59cfb65501eafacc>`();
		void :ref:`clearColorFilter<doxid-class_e_e_1_1_graphics_1_1_drawable_1a0e8dfc0c27d9d80a16ae1dbbf8188bce>`();
		void :ref:`resetAlpha<doxid-class_e_e_1_1_graphics_1_1_drawable_1aa2cef60737c9d19e8d019dab905476ae>`();
		:ref:`Type<doxid-class_e_e_1_1_graphics_1_1_drawable_1a581cd8156129550f6b1ece8c946a2028>` :ref:`getDrawableType<doxid-class_e_e_1_1_graphics_1_1_drawable_1ae3fb1711475c6441b7063f7f3a922998>`() const;
		const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& :ref:`getPosition<doxid-class_e_e_1_1_graphics_1_1_drawable_1acea6587e2ba46004548a8a80c177247c>`() const;
		void :ref:`setPosition<doxid-class_e_e_1_1_graphics_1_1_drawable_1a7aab224c8ab1122bf5887edb4062811f>`(const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& position);
		virtual bool :ref:`isDrawableResource<doxid-class_e_e_1_1_graphics_1_1_drawable_1a9f25b25947bc42726b2cbfeaab2003ec>`() const;

.. _details-class_e_e_1_1_graphics_1_1_rich_text:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

A drawable class that renders rich text with multiple styles and spans.

:ref:`RichText <doxid-class_e_e_1_1_graphics_1_1_rich_text>` allows rendering text with different fonts, sizes, colors, and styles mixed together. It supports word wrapping and alignment.

Construction
------------

.. _doxid-class_e_e_1_1_graphics_1_1_rich_text_1ab561dff9f07532229642970cfd0adfcd:
.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	~RichText()

Destructor.

Methods
-------

.. index:: pair: function; New
.. _doxid-class_e_e_1_1_graphics_1_1_rich_text_1a7636c5820b741b8e58f4533ecc35cab6:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static RichText* New()



.. rubric:: Returns:

A new instance of :ref:`RichText <doxid-class_e_e_1_1_graphics_1_1_rich_text>`.

.. index:: pair: function; addSpan
.. _doxid-class_e_e_1_1_graphics_1_1_rich_text_1a9c53608738f111a83cd0e6782e9ee0b9:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void addSpan(const :ref:`String<doxid-class_e_e_1_1_string>`& text, const :ref:`FontStyleConfig<doxid-class_e_e_1_1_graphics_1_1_font_style_config>`& style)

Adds a text span with a specific style configuration.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- text

		- The text content.

	*
		- style

		- The font style configuration to apply.

.. index:: pair: function; addSpan
.. _doxid-class_e_e_1_1_graphics_1_1_rich_text_1a57d8f632df1377a90b851007f2912252:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void addSpan(const :ref:`String<doxid-class_e_e_1_1_string>`& text, :ref:`Font<doxid-class_e_e_1_1_graphics_1_1_font>`* font = nullptr, :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` characterSize = 0, :ref:`Color<doxid-class_e_e_1_1_system_1_1_color>` color = Color::White, :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` style = :ref:`Text::Regular<doxid-class_e_e_1_1_graphics_1_1_text_1a976ce154fcd0c5db68ef076bee2cd109abeaafd66e444285d55db8c87e985bf17>`)

Adds a text span with individual style parameters.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- text

		- The text content.

	*
		- font

		- The font to use (optional, uses default if null).

	*
		- characterSize

		- The character size (optional, uses default if 0).

	*
		- color

		- The text color (optional, uses default if White).

	*
		- style

		- The text style (optional, uses default if Regular).

.. index:: pair: function; clear
.. _doxid-class_e_e_1_1_graphics_1_1_rich_text_1aac024dce521ee6f8da375465a40fa27a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void clear()

Clears all text spans.

.. index:: pair: function; setFontStyleConfig
.. _doxid-class_e_e_1_1_graphics_1_1_rich_text_1a9538c20e577d4dd0ab4a69042f7fa3f0:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setFontStyleConfig(const :ref:`FontStyleConfig<doxid-class_e_e_1_1_graphics_1_1_font_style_config>`& styleConfig)

Sets the default font style configuration used for new spans if not specified.

.. index:: pair: function; getFontStyleConfig
.. _doxid-class_e_e_1_1_graphics_1_1_rich_text_1a0e07a4d8add3564bbf28333c04b441be:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`FontStyleConfig<doxid-class_e_e_1_1_graphics_1_1_font_style_config>`& getFontStyleConfig()



.. rubric:: Returns:

The default font style configuration.

.. index:: pair: function; setAlign
.. _doxid-class_e_e_1_1_graphics_1_1_rich_text_1ab6cbc843b8fb711ab62c8695996a8254:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setAlign(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` align)

Sets the text alignment (Left, Center, Right).

.. index:: pair: function; setMaxWidth
.. _doxid-class_e_e_1_1_graphics_1_1_rich_text_1a87fa4e5f8beb6989b142d7196674ddc0:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setMaxWidth(:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` width)

Sets the maximum width for wrapping. If 0, wrapping is disabled.

.. index:: pair: function; getMaxWidth
.. _doxid-class_e_e_1_1_graphics_1_1_rich_text_1ac0a75605be30033edd4e168d2e6328b2:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` getMaxWidth() const



.. rubric:: Returns:

The maximum width for wrapping.

.. index:: pair: function; getSpans
.. _doxid-class_e_e_1_1_graphics_1_1_rich_text_1a137efb75dbc97f422b2b85900705e33f:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	std::vector<std::shared_ptr<:ref:`Text<doxid-class_e_e_1_1_graphics_1_1_text>`>>& getSpans()



.. rubric:: Returns:

The list of text spans.

.. index:: pair: function; invalidate
.. _doxid-class_e_e_1_1_graphics_1_1_rich_text_1a99359cf86f2f10391abc5b80745cc8b6:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void invalidate()

Invalidates the layout, forcing a recalculation on the next update.

.. index:: pair: function; getLines
.. _doxid-class_e_e_1_1_graphics_1_1_rich_text_1ae04f4c2e8c6e0b54c665140569511936:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const std::vector<:ref:`RenderParagraph<doxid-struct_e_e_1_1_graphics_1_1_rich_text_1_1_render_paragraph>`>& getLines() const



.. rubric:: Returns:

The list of rendered lines.