.. index:: pair: class; EE::UI::UIDataBind
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind:

template class EE::UI::UIDataBind
=================================

.. toctree::
	:hidden:

	class_EE_UI_UIDataBind_CallbackSlot.rst

Overview
~~~~~~~~

Synchronizes a value with one or more :ref:`UIWidget <doxid-class_e_e_1_1_u_i_1_1_u_i_widget>` properties. :ref:`More...<details-class_e_e_1_1_u_i_1_1_u_i_data_bind>`


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

	#include <uidatabind.hpp>
	
	template <typename T>
	class UIDataBind {
	public:
		// typedefs
	
		typedef T :target:`ValueType<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1ac1878100afcd1859bba561edbbd1a325>`;
		typedef :ref:`UIValueConverter<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_converter>`<T> :target:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>`;
		typedef typename :ref:`ObservableValue<doxid-class_e_e_1_1_observable_value>`<T>:::ref:`Callback<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a367df465bd8fa97c1075d76802457b0a>` :target:`Callback<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a367df465bd8fa97c1075d76802457b0a>`;
		typedef typename :ref:`ObservableValue<doxid-class_e_e_1_1_observable_value>`<:ref:`Uint64<doxid-namespace_e_e_1ae05f59b032c290566852fe63cb26135c>`>:::ref:`Connection<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a8dd5ef86bc65e7ffa318b2aae6943cb6>` :target:`Connection<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a8dd5ef86bc65e7ffa318b2aae6943cb6>`;

		// classes
	
		class :ref:`CallbackSlot<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1_1_callback_slot>`;

		// fields
	
		:ref:`CallbackSlot<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1_1_callback_slot>` :target:`onValueChangeCb<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1add58f5f90ca53a1fdc0fa41602100951>`;

		// construction
	
		:target:`UIDataBind<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a4e1ec53731b031508fcd651ad85ef2f3>`();
		:target:`UIDataBind<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1ac6c5ddada6e4b37bf9eb0bf344548984>`(const UIDataBind&);
		:target:`UIDataBind<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a15cbca420c62c0d6236b5de650cc34a2>`(UIDataBind&&);
		:target:`UIDataBind<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a157b0eaafcb6c4fd3abeab5fa8661ad1>`(T* t, const :ref:`UnorderedSet<doxid-namespace_e_e_1a4ea711a7ac942d44928ba50194df991e>`<:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`*>& widgets, const :ref:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>`& converter = :ref:`Converter::converterDefault<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_converter_1ae9cf163c1ea47968c25b32bf36464304>`(), const std::string& valueKey = "value", const :ref:`Event::EventType<doxid-class_e_e_1_1_scene_1_1_event_1a230934826f432a3bb4b3694760b59b69>`& eventType = Event::OnValueChange);
		:target:`UIDataBind<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1ae31c6af4613fbc548b054a3220fdc81b>`(T* t, :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget, const :ref:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>`& converter = :ref:`Converter::converterDefault<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_converter_1ae9cf163c1ea47968c25b32bf36464304>`(), const std::string& valueKey = "value", const :ref:`Event::EventType<doxid-class_e_e_1_1_scene_1_1_event_1a230934826f432a3bb4b3694760b59b69>`& eventType = Event::OnValueChange);
		:target:`UIDataBind<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a03c18f393fbae462fcbfa08e2a580432>`(std::shared_ptr<T> value, const :ref:`UnorderedSet<doxid-namespace_e_e_1a4ea711a7ac942d44928ba50194df991e>`<:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`*>& widgets, const :ref:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>`& converter = :ref:`Converter::converterDefault<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_converter_1ae9cf163c1ea47968c25b32bf36464304>`(), const std::string& valueKey = "value", const :ref:`Event::EventType<doxid-class_e_e_1_1_scene_1_1_event_1a230934826f432a3bb4b3694760b59b69>`& eventType = Event::OnValueChange);
		:target:`UIDataBind<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a97ae46d9fad419ba1522292b2131fe3f>`(std::shared_ptr<T> value, :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget, const :ref:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>`& converter = :ref:`Converter::converterDefault<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_converter_1ae9cf163c1ea47968c25b32bf36464304>`(), const std::string& valueKey = "value", const :ref:`Event::EventType<doxid-class_e_e_1_1_scene_1_1_event_1a230934826f432a3bb4b3694760b59b69>`& eventType = Event::OnValueChange);
		:target:`~UIDataBind<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1aa62a68bb59e48633e58d506be3a3bb2a>`();

		// methods
	
		static :ref:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>` :target:`converterDefault<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a170bc7f4e4779a08955a183d71d38f50>`();
		static :ref:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>` :target:`converterString<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1ac250c538963233a6346ecdb089232dfb>`();
		static :ref:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>` :target:`converterBool<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a879c758bc4353028874aee9684778c3a>`();
		static std::unique_ptr<UIDataBind<T>> :target:`New<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7c1c17e9c09692d6f1e2741cb62c3342>`(T* t, const :ref:`UnorderedSet<doxid-namespace_e_e_1a4ea711a7ac942d44928ba50194df991e>`<:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`*>& widgets, const :ref:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>`& converter = :ref:`Converter::converterDefault<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_converter_1ae9cf163c1ea47968c25b32bf36464304>`(), const std::string& valueKey = "value", const :ref:`Event::EventType<doxid-class_e_e_1_1_scene_1_1_event_1a230934826f432a3bb4b3694760b59b69>`& eventType = Event::OnValueChange);
		static std::unique_ptr<UIDataBind<T>> :target:`New<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a6ef75734b90a15e2f91774154dadbe88>`(T* t, :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget, const :ref:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>`& converter = :ref:`Converter::converterDefault<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_converter_1ae9cf163c1ea47968c25b32bf36464304>`(), const std::string& valueKey = "value", const :ref:`Event::EventType<doxid-class_e_e_1_1_scene_1_1_event_1a230934826f432a3bb4b3694760b59b69>`& eventType = Event::OnValueChange);
		static std::unique_ptr<UIDataBind<T>> :ref:`New<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1acc52a864e096ba68e81033db0dd37222>`(std::shared_ptr<T> value, const :ref:`UnorderedSet<doxid-namespace_e_e_1a4ea711a7ac942d44928ba50194df991e>`<:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`*>& widgets, const :ref:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>`& converter = :ref:`Converter::converterDefault<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_converter_1ae9cf163c1ea47968c25b32bf36464304>`(), const std::string& valueKey = "value", const :ref:`Event::EventType<doxid-class_e_e_1_1_scene_1_1_event_1a230934826f432a3bb4b3694760b59b69>`& eventType = Event::OnValueChange);
		static std::unique_ptr<UIDataBind<T>> :ref:`New<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a049aad806a02d2db7a5a400ff5158e96>`(std::shared_ptr<T> value, :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget, const :ref:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>`& converter = :ref:`Converter::converterDefault<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_converter_1ae9cf163c1ea47968c25b32bf36464304>`(), const std::string& valueKey = "value", const :ref:`Event::EventType<doxid-class_e_e_1_1_scene_1_1_event_1a230934826f432a3bb4b3694760b59b69>`& eventType = Event::OnValueChange);
		UIDataBind& :target:`operator=<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1ad82acc22eaad0346fdc449f6a5b84120>`(const UIDataBind&);
		UIDataBind& :target:`operator=<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7b7eb611b0661287a872a5f351a507af>`(UIDataBind&&);
		void :target:`init<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a6420917aa68a0d9a1becf3b930293727>`(T* t, :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget, const :ref:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>`& converter = :ref:`Converter::converterDefault<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_converter_1ae9cf163c1ea47968c25b32bf36464304>`(), const std::string& valueKey = "value", const :ref:`Event::EventType<doxid-class_e_e_1_1_scene_1_1_event_1a230934826f432a3bb4b3694760b59b69>`& eventType = Event::OnValueChange);
		void :target:`init<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a8cc209c65f1ac56e3725897766022e3e>`(T* t, const :ref:`UnorderedSet<doxid-namespace_e_e_1a4ea711a7ac942d44928ba50194df991e>`<:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`*>& widgets, const :ref:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>`& converter = :ref:`Converter::converterDefault<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_converter_1ae9cf163c1ea47968c25b32bf36464304>`(), const std::string& valueKey = "value", const :ref:`Event::EventType<doxid-class_e_e_1_1_scene_1_1_event_1a230934826f432a3bb4b3694760b59b69>`& eventType = Event::OnValueChange);
		void :ref:`init<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1acbc6c753b1c548ba6008e2958868a10b>`(std::shared_ptr<T> value, const :ref:`UnorderedSet<doxid-namespace_e_e_1a4ea711a7ac942d44928ba50194df991e>`<:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`*>& widgets, const :ref:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>`& converter = :ref:`Converter::converterDefault<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_converter_1ae9cf163c1ea47968c25b32bf36464304>`(), const std::string& valueKey = "value", const :ref:`Event::EventType<doxid-class_e_e_1_1_scene_1_1_event_1a230934826f432a3bb4b3694760b59b69>`& eventType = Event::OnValueChange);
		void :ref:`init<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a148bf5da7de19eb4163957c4d4b34b3d>`(std::shared_ptr<T> value, :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget, const :ref:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>`& converter = :ref:`Converter::converterDefault<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_converter_1ae9cf163c1ea47968c25b32bf36464304>`(), const std::string& valueKey = "value", const :ref:`Event::EventType<doxid-class_e_e_1_1_scene_1_1_event_1a230934826f432a3bb4b3694760b59b69>`& eventType = Event::OnValueChange);
	
		template <typename Widgets>
		void :ref:`initRetained<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a1bba476cd79327e38e093fe51e017fa5>`(T* value, std::shared_ptr<void> owner, Widgets&& widgets, const :ref:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>`& converter = :ref:`Converter::converterDefault<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_converter_1ae9cf163c1ea47968c25b32bf36464304>`(), const std::string& valueKey = "value", const :ref:`Event::EventType<doxid-class_e_e_1_1_scene_1_1_event_1a230934826f432a3bb4b3694760b59b69>`& eventType = Event::OnValueChange);
	
		:ref:`UIValueValidationResult<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result>` :ref:`set<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a923c2b8a5356fe69da91148ac65393c5>`(const T& t);
		:ref:`UIValueValidationResult<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result>` :ref:`set<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a43dcdc24faeb68544343d63a45dfdffb>`(T&& t);
		const T& :target:`get<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1aa54924d99cac413cecae032baddc184c>`() const;
		:ref:`Connection<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a8dd5ef86bc65e7ffa318b2aae6943cb6>` :ref:`observe<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a8abd02e75d035f7bf6036073abb00b61>`(:ref:`Callback<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a367df465bd8fa97c1075d76802457b0a>` callback);
		bool :ref:`isInitialized<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a2ca1aad9e8b545f90803a7cdcf8177ad>`() const;
		void :ref:`reset<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1abb40182c79ba00a2ba2cd9b61396963a>`();
		void :ref:`bind<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1aba090dea6da76fa3c248c58cf3e7cd8f>`(:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget);
		void :ref:`unbind<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1af68f69421f80d3d71874fb3391f4de48>`(:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget);
		const :ref:`PropertyDefinition<doxid-class_e_e_1_1_u_i_1_1_c_s_s_1_1_property_definition>`* :target:`getPropertyDefinition<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a15ede12ed54fbe1cd3e9c8950589e7ba>`() const;
		const :ref:`UnorderedSet<doxid-namespace_e_e_1a4ea711a7ac942d44928ba50194df991e>`<:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`*>& :target:`getWidgets<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a6bc7e5f981583522041aa405ccb0d529>`() const;
		:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* :ref:`getValidationEmitter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1aad2da88402da9f2dc346bcd508a15ebe>`() const;
		:ref:`UIValueValidationState<doxid-class_e_e_1_1_u_i_1_1_u_i_value_validation_state>`& :ref:`validationState<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1af5fa112685fb24c2838c601fed528c65>`();
		const :ref:`UIValueValidationState<doxid-class_e_e_1_1_u_i_1_1_u_i_value_validation_state>`& :target:`validationState<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a30ec9e30eec076b96a3f9416f0ae48bb>`() const;
		bool :target:`isValid<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a6566bd776b4cfb84abdf4b6d4694253a>`() const;
	};
.. _details-class_e_e_1_1_u_i_1_1_u_i_data_bind:

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

Synchronizes a value with one or more :ref:`UIWidget <doxid-class_e_e_1_1_u_i_1_1_u_i_widget>` properties.

:ref:`UIDataBind <doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind>` observes each widget's value event and writes converted values back to the external object supplied at construction. Calling :ref:`set() <doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a923c2b8a5356fe69da91148ac65393c5>` updates that object and propagates the converted value to every bound widget.

The converter maps directly between T and the widget property string. Its toValue() callback decides whether widget input is acceptable. Values passed to :ref:`set() <doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a923c2b8a5356fe69da91148ac65393c5>` are authoritative model state and are formatted through fromValue().

Raw-pointer bindings do not own their value. The external object must outlive the :ref:`UIDataBind <doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind>` and every synchronous callback delivery, or :ref:`reset() <doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1abb40182c79ba00a2ba2cd9b61396963a>` must be called before it is destroyed. The shared_ptr overload retains the value through binding lifetime and callback delivery without copying T. :ref:`UIProperty <doxid-class_e_e_1_1_u_i_1_1_u_i_property>` uses that retained form automatically.

Widgets are also observed without ownership: EventConnection handles remove listeners when the binding dies, while the widget-level Event::OnClose notification removes widgets that die before the binding. All binding operations and widget events must run on the widgets' owning :ref:`UI <doxid-namespace_e_e_1_1_u_i>` thread. The class is non-copyable and non-movable because its listeners capture its address.

Use :ref:`UIDataBind <doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind>` when adapting an existing externally owned value and its lifetime is already controlled by the caller. Prefer :ref:`UIProperty <doxid-class_e_e_1_1_u_i_1_1_u_i_property>` for small UI-local state, or :ref:`ObservableValue <doxid-class_e_e_1_1_observable_value>` with :ref:`UIValueBinding <doxid-class_e_e_1_1_u_i_1_1_u_i_value_binding>` when the model must publish changes without depending on the :ref:`UI <doxid-namespace_e_e_1_1_u_i>`.

.. ref-code-block:: cpp

	bool showDetails = false;
	auto binding = UIDataBind<bool>::New(
	    &showDetails, checkbox, UIValueConverter<bool>::converterBool() );
	// 'binding' must be destroyed or reset before 'showDetails'.

Methods
-------

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

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

	static std::unique_ptr<UIDataBind<T>> New(std::shared_ptr<T> value, const :ref:`UnorderedSet<doxid-namespace_e_e_1a4ea711a7ac942d44928ba50194df991e>`<:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`*>& widgets, const :ref:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>`& converter = :ref:`Converter::converterDefault<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_converter_1ae9cf163c1ea47968c25b32bf36464304>`(), const std::string& valueKey = "value", const :ref:`Event::EventType<doxid-class_e_e_1_1_scene_1_1_event_1a230934826f432a3bb4b3694760b59b69>`& eventType = Event::OnValueChange)

Creates a binding that retains ``value`` through callback delivery.

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

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

	static std::unique_ptr<UIDataBind<T>> New(std::shared_ptr<T> value, :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget, const :ref:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>`& converter = :ref:`Converter::converterDefault<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_converter_1ae9cf163c1ea47968c25b32bf36464304>`(), const std::string& valueKey = "value", const :ref:`Event::EventType<doxid-class_e_e_1_1_scene_1_1_event_1a230934826f432a3bb4b3694760b59b69>`& eventType = Event::OnValueChange)

Creates a binding that retains ``value`` through callback delivery.

.. index:: pair: function; init
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1acbc6c753b1c548ba6008e2958868a10b:

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

	void init(std::shared_ptr<T> value, const :ref:`UnorderedSet<doxid-namespace_e_e_1a4ea711a7ac942d44928ba50194df991e>`<:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`*>& widgets, const :ref:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>`& converter = :ref:`Converter::converterDefault<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_converter_1ae9cf163c1ea47968c25b32bf36464304>`(), const std::string& valueKey = "value", const :ref:`Event::EventType<doxid-class_e_e_1_1_scene_1_1_event_1a230934826f432a3bb4b3694760b59b69>`& eventType = Event::OnValueChange)

Reinitializes the binding while retaining ``value``.

.. index:: pair: function; init
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a148bf5da7de19eb4163957c4d4b34b3d:

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

	void init(std::shared_ptr<T> value, :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget, const :ref:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>`& converter = :ref:`Converter::converterDefault<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_converter_1ae9cf163c1ea47968c25b32bf36464304>`(), const std::string& valueKey = "value", const :ref:`Event::EventType<doxid-class_e_e_1_1_scene_1_1_event_1a230934826f432a3bb4b3694760b59b69>`& eventType = Event::OnValueChange)

Reinitializes the binding for one widget while retaining ``value``.

.. index:: pair: function; initRetained
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a1bba476cd79327e38e093fe51e017fa5:

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

	template <typename Widgets>
	void initRetained(T* value, std::shared_ptr<void> owner, Widgets&& widgets, const :ref:`Converter<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a7ec3e21d740aa0c90a6b44433cf3c786>`& converter = :ref:`Converter::converterDefault<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_converter_1ae9cf163c1ea47968c25b32bf36464304>`(), const std::string& valueKey = "value", const :ref:`Event::EventType<doxid-class_e_e_1_1_scene_1_1_event_1a230934826f432a3bb4b3694760b59b69>`& eventType = Event::OnValueChange)

Reinitializes the binding with externally retained storage.

``owner`` must keep ``value`` alive. This supports values embedded in a larger shared state without constructing an aliasing shared_ptr or allocating a separate value control block.

.. index:: pair: function; set
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a923c2b8a5356fe69da91148ac65393c5:

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

	:ref:`UIValueValidationResult<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result>` set(const T& t)

Propagates the authoritative model value and reports formatting failures.

.. index:: pair: function; set
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a43dcdc24faeb68544343d63a45dfdffb:

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

	:ref:`UIValueValidationResult<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result>` set(T&& t)

Propagates the authoritative model value and reports formatting failures.

.. index:: pair: function; observe
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a8abd02e75d035f7bf6036073abb00b61:

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

	:ref:`Connection<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a8dd5ef86bc65e7ffa318b2aae6943cb6>` observe(:ref:`Callback<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a367df465bd8fa97c1075d76802457b0a>` callback)

Observes later changes made through this binding.

Direct writes through the external pointer cannot be observed; use :ref:`set() <doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a923c2b8a5356fe69da91148ac65393c5>` for model-originated changes that must be published. Notifications publish an integer revision internally, so T is never copied for observer delivery. Shared bindings retain their value in each observer adapter; raw bindings require the external value to survive the complete callback sequence.



.. rubric:: Returns:

A scoped connection, or an empty connection when the binding is not initialized.

.. index:: pair: function; isInitialized
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a2ca1aad9e8b545f90803a7cdcf8177ad:

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

	bool isInitialized() const



.. rubric:: Returns:

True when the binding has a valid external value, property, and converter.

.. index:: pair: function; reset
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1abb40182c79ba00a2ba2cd9b61396963a:

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

	void reset()

Disconnects every widget and releases the reference to the external value.

After :ref:`reset() <doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1abb40182c79ba00a2ba2cd9b61396963a>`, the binding must be initialized again before :ref:`get() <doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1aa54924d99cac413cecae032baddc184c>` or :ref:`set() <doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1a923c2b8a5356fe69da91148ac65393c5>` is used.

.. index:: pair: function; bind
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1aba090dea6da76fa3c248c58cf3e7cd8f:

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

	void bind(:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget)

Adds ``widget`` to the synchronized widget set. Duplicate binds are ignored.

.. index:: pair: function; unbind
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1af68f69421f80d3d71874fb3391f4de48:

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

	void unbind(:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget)

Disconnects and removes ``widget`` from the synchronized widget set.

.. index:: pair: function; getValidationEmitter
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1aad2da88402da9f2dc346bcd508a15ebe:

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

	:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* getValidationEmitter() const



.. rubric:: Returns:

The widget that produced the current input error, or nullptr for valid state or a model-to-widget formatting error.

.. index:: pair: function; validationState
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind_1af5fa112685fb24c2838c601fed528c65:

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

	:ref:`UIValueValidationState<doxid-class_e_e_1_1_u_i_1_1_u_i_value_validation_state>`& validationState()



.. rubric:: Returns:

Observable converter error state for this binding.