.. index:: pair: class; EE::UI::UITextSelectionController
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller:

class EE::UI::UITextSelectionController
=======================================

.. toctree::
	:hidden:

	struct_EE_UI_UITextSelectionController_Point.rst
	struct_EE_UI_UITextSelectionController_SelectedSlice.rst
	struct_EE_UI_UITextSelectionController_Selection.rst
	struct_EE_UI_UITextSelectionController_SelectionSlice.rst

Overview
~~~~~~~~

Coordinates document ordering, input, and :ref:`CSS <doxid-namespace_e_e_1_1_u_i_1_1_c_s_s>` selection policy across RichText paint owners. :ref:`More...<details-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller>`


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

	#include <uitextselectioncontroller.hpp>
	
	class UITextSelectionController {
	public:
		// structs
	
		struct :ref:`Point<doxid-struct_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1_1_point>`;
		struct :ref:`SelectedSlice<doxid-struct_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1_1_selected_slice>`;
		struct :ref:`Selection<doxid-struct_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1_1_selection>`;
		struct :ref:`SelectionSlice<doxid-struct_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1_1_selection_slice>`;

		// construction
	
		:target:`UITextSelectionController<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1a3b0653f8bedac24c571235bddad982fc>`(:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* host = nullptr);
		:target:`~UITextSelectionController<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1a31723b1f3035c82c49f3c470346a5ad9>`();

		// methods
	
		void :target:`setHost<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1a7c981b886f64d19eba128efe1ebe9cc8>`(:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* host);
		void :target:`setSelectionRoot<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1a904993c6703f4caeeca5e19084c1dfa3>`(:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* root);
		:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* :target:`getSelectionRoot<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1af9a9d22b9a2cbb580f84804a6a0f07c9>`() const;
		const :ref:`Selection<doxid-struct_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1_1_selection>`& :target:`getSelection<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1a738a736be9c10c068e85e8ef50e228a4>`() const;
		bool :target:`isSelecting<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1a9a6d15cf326b8e5225b8a8607c481936>`() const;
		bool :target:`hasSelection<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1a5492d3616c9498e2bb3f566b84a418e9>`() const;
		void :target:`clear<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1a91357687da6505100987216b9a04a5c6>`();
		void :target:`selectAll<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1aaa8209f232354d2afc5767ab63ca5f71>`();
		void :target:`setSelection<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1a69156ad3ccb54afe0bf35cc5447e0321>`(:ref:`Point<doxid-struct_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1_1_point>` anchor, :ref:`Point<doxid-struct_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1_1_point>` focus);
		:ref:`String<doxid-class_e_e_1_1_string>` :target:`getSelectionString<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1acee21717f36dc63fa3953d72f1a39db8>`() const;
		bool :target:`copySelection<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1a424c9dfe2449151f8178d4009900677e>`();
		bool :target:`onKeyDown<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1a02fa2e2c782e25ea3649a618c5ef6485>`(const :ref:`KeyEvent<doxid-class_e_e_1_1_scene_1_1_key_event>`& event);
		bool :target:`onMouseDown<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1a7cd90814af467c81fecd8bf88bd427d6>`(:ref:`UIRichText<doxid-class_e_e_1_1_u_i_1_1_u_i_rich_text>`* source, const :ref:`Vector2i<doxid-namespace_e_e_1_1_math_1a239f880abf75c42a0c85201dbae17ff1>`& position, :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` flags);
		bool :target:`onMouseUp<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1a78dc4babecb4591968217be1366eb6c9>`(const :ref:`Vector2i<doxid-namespace_e_e_1_1_math_1a239f880abf75c42a0c85201dbae17ff1>`& position, :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` flags);
		bool :target:`onMouseDoubleClick<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1aee576b5a0543ee6fd6de79fd30193753>`(:ref:`UIRichText<doxid-class_e_e_1_1_u_i_1_1_u_i_rich_text>`* source, const :ref:`Vector2i<doxid-namespace_e_e_1_1_math_1a239f880abf75c42a0c85201dbae17ff1>`& position, :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` flags);
		bool :target:`onMouseUpMessage<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1a9f7008acd7916cf8bde5880cef8807d0>`(const :ref:`NodeMessage<doxid-class_e_e_1_1_scene_1_1_node_message>`* message);
		bool :target:`showContextMenu<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1acba0b54abd1b6cd3efb3a3cc376c9e18>`(const :ref:`Vector2i<doxid-namespace_e_e_1_1_math_1a239f880abf75c42a0c85201dbae17ff1>`& position, :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` flags);
		bool :ref:`consumeSuppressedClick<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1aa876571ebe21ddaac9dcf9452ba2fee1>`();
		void :target:`updateSelectionDrag<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1a904f373186d910762dfdfe0c153bd2a7>`();
		void :target:`onDocumentWillChange<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1a57bf94a320ab47bfa168594274060386>`();
		void :target:`onDocumentChanged<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1a8fe1e748add058e52e8de668d3a28c77>`();
		void :ref:`onOwnerWillBeDestroyed<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1adcd024d1af38365b86030d1661c43ad1>`(:ref:`UIRichText<doxid-class_e_e_1_1_u_i_1_1_u_i_rich_text>`* owner);
		void :target:`refresh<doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1ae5755244e104b00f8e106117d95dd890>`();
	};
.. _details-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller:

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

Coordinates document ordering, input, and :ref:`CSS <doxid-namespace_e_e_1_1_u_i_1_1_c_s_s>` selection policy across RichText paint owners. Each owner still handles local character geometry and selection painting.

Methods
-------

.. index:: pair: function; consumeSuppressedClick
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1aa876571ebe21ddaac9dcf9452ba2fee1:

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

	bool consumeSuppressedClick()

Consumes the pending click from a text drag so a link does not navigate on release.

.. index:: pair: function; onOwnerWillBeDestroyed
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_text_selection_controller_1adcd024d1af38365b86030d1661c43ad1:

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

	void onOwnerWillBeDestroyed(:ref:`UIRichText<doxid-class_e_e_1_1_u_i_1_1_u_i_rich_text>`* owner)

Called before an owner's RichText member is destroyed.