.. index:: pair: class; EE::UI::UIBindingGroup
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group:

class EE::UI::UIBindingGroup
============================

.. toctree::
	:hidden:

	struct_EE_UI_UIBindingGroup_Entry.rst
	struct_EE_UI_UIBindingGroup_Error.rst
	struct_EE_UI_UIBindingGroup_ObservableEntry.rst
	struct_EE_UI_UIBindingGroup_PropertyEntry.rst
	struct_EE_UI_UIBindingGroup_RawEntry.rst

Overview
~~~~~~~~

Owns heterogeneous bindings and exposes aggregate form state. :ref:`More...<details-class_e_e_1_1_u_i_1_1_u_i_binding_group>`


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

	#include <uibindinggroup.hpp>
	
	class UIBindingGroup {
	public:
		// typedefs
	
		typedef :ref:`SmallVector<doxid-class_e_e_1_1_small_vector>`<:ref:`Error<doxid-struct_e_e_1_1_u_i_1_1_u_i_binding_group_1_1_error>`, 4> :ref:`Errors<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1aa862c4e90978947baa2ea2db13aa3b21>`;
		typedef :ref:`SmallVector<doxid-class_e_e_1_1_small_vector>`<:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`*, 4> :ref:`Widgets<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1ae7ac8076b0f64ecd614cb5d32ae1fc4e>`;
		typedef std::function<void()> :target:`Callback<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a8c80dc31269dbe481b3aa7037fcf04c0>`;

		// structs
	
		struct :ref:`Entry<doxid-struct_e_e_1_1_u_i_1_1_u_i_binding_group_1_1_entry>`;
		struct :ref:`Error<doxid-struct_e_e_1_1_u_i_1_1_u_i_binding_group_1_1_error>`;
	
		template <typename T>
		struct :ref:`ObservableEntry<doxid-struct_e_e_1_1_u_i_1_1_u_i_binding_group_1_1_observable_entry>`;
	
		template <typename T>
		struct :ref:`PropertyEntry<doxid-struct_e_e_1_1_u_i_1_1_u_i_binding_group_1_1_property_entry>`;
	
		template <typename T>
		struct :ref:`RawEntry<doxid-struct_e_e_1_1_u_i_1_1_u_i_binding_group_1_1_raw_entry>`;

		// construction
	
		:target:`UIBindingGroup<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a28f6f1be58bcd4d719ac2a94ec6ead2a>`();
		:target:`UIBindingGroup<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a9b5605538f0662b70ed51e3cb1f1d6fa>`(const UIBindingGroup&);
		:target:`UIBindingGroup<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1aef64e87a9b9a6be59e387d6057a37425>`(UIBindingGroup&&);
		:target:`~UIBindingGroup<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a10723f7e68f83d540a73c382b6206eea>`();

		// methods
	
		UIBindingGroup& :target:`operator=<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a435e79b2777245e935d1d8680987283c>`(const UIBindingGroup&);
		UIBindingGroup& :target:`operator=<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a496059a5b2ac81c8a5b8f911ef39f8e7>`(UIBindingGroup&&);
	
		template <typename T>
		UIBindingGroup& :ref:`hold<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a4dc4700c338341f6e1a4794f097e98a1>`(:ref:`UIValueBinding<doxid-class_e_e_1_1_u_i_1_1_u_i_value_binding>`<T>&& binding);
	
		template <typename T>
		UIBindingGroup& :target:`operator+=<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1ae7e08e4e49d74857bcdebda5d5fff8b4>`(:ref:`UIValueBinding<doxid-class_e_e_1_1_u_i_1_1_u_i_value_binding>`<T>&& binding);
	
		template <typename T>
		UIBindingGroup& :ref:`hold<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a4046ce76823dd7e4b1e2c349c2fbcad0>`(std::unique_ptr<:ref:`UIDataBind<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind>`<T>> binding);
	
		template <typename T>
		UIBindingGroup& :target:`operator+=<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a0c86e053e75ddc4d74221b32e1f30087>`(std::unique_ptr<:ref:`UIDataBind<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind>`<T>> binding);
	
		template <typename T>
		UIBindingGroup& :ref:`hold<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a33b77ef1b1fe8bbc01a160c85b415f24>`(:ref:`UIProperty<doxid-class_e_e_1_1_u_i_1_1_u_i_property>`<T>& property);
	
		template <typename T>
		UIBindingGroup& :ref:`operator+=<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a7f6865c3cda15f54a2a6cdf9de7f1032>`(:ref:`UIProperty<doxid-class_e_e_1_1_u_i_1_1_u_i_property>`<T>& property);
	
		bool :ref:`isValid<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a55dbe3acb1ea774a99d189d46812eed9>`() const;
		bool :ref:`isDirty<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1ad3bb25f634316302862c79247d9f33d9>`() const;
		:ref:`ObservableValue<doxid-class_e_e_1_1_observable_value>`<bool>& :ref:`validValue<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a54dbf49593fccc3c43ec7c7d492722fc>`();
		:ref:`ObservableValue<doxid-class_e_e_1_1_observable_value>`<bool>& :ref:`dirtyValue<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1af9726cbce15bdc50d1a06766124ed572>`();
		:ref:`Errors<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1aa862c4e90978947baa2ea2db13aa3b21>` :ref:`errors<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a0f3efe5133cf634898661bf955de7940>`() const;
		:ref:`Widgets<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1ae7ac8076b0f64ecd614cb5d32ae1fc4e>` :ref:`widgets<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1aed7f71c6c59a3c75baf64ac2967a66fb>`() const;
		:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* :ref:`firstInvalidWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1ace8e8eb0d9da12b95b1bd8ef01b96b94>`() const;
		void :ref:`markClean<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a622520262bd13b13747ba9436985fff3>`();
		void :ref:`reset<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a8ab3ae0380b97aa8ae061a71c6ac537c>`();
		void :ref:`clear<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a7c6f0be6fccfd8c6b9ea5ab713c47e75>`();
		std::size_t :ref:`size<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1afc2782272ec3065a164e1b9f4347301d>`() const;
		void :ref:`onChange<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1ac13b61df7db0ff6b1412be6bad5c1696>`(:ref:`Callback<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a8c80dc31269dbe481b3aa7037fcf04c0>` callback);
	};
.. _details-class_e_e_1_1_u_i_1_1_u_i_binding_group:

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

Owns heterogeneous bindings and exposes aggregate form state.

Dirty state compares live values with explicit per-binding baselines. The group owns bindings, but never owns their widgets or model values. Disabled widgets are excluded from aggregate validation. :ref:`clear() <doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a7c6f0be6fccfd8c6b9ea5ab713c47e75>` and destruction disconnect all bindings.

.. ref-code-block:: cpp

	UIBindingGroup form;
	form += bindValue( name, nameInput, requiredName );
	form += bindValue( port, portInput, validPort );
	auto canSave = computedValue( form.validValue(), form.dirtyValue(),
	                              []( bool valid, bool dirty ) { return valid && dirty; } );

Typedefs
--------

.. index:: pair: typedef; Errors
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1aa862c4e90978947baa2ea2db13aa3b21:

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

	typedef :ref:`SmallVector<doxid-class_e_e_1_1_small_vector>`<:ref:`Error<doxid-struct_e_e_1_1_u_i_1_1_u_i_binding_group_1_1_error>`, 4> Errors

Inline-backed error collection sized for ordinary forms.

.. index:: pair: typedef; Widgets
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1ae7ac8076b0f64ecd614cb5d32ae1fc4e:

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

	typedef :ref:`SmallVector<doxid-class_e_e_1_1_small_vector>`<:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`*, 4> Widgets

Inline-backed widget collection sized for ordinary forms.

Methods
-------

.. index:: pair: function; hold
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a4dc4700c338341f6e1a4794f097e98a1:

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

	template <typename T>
	UIBindingGroup& hold(:ref:`UIValueBinding<doxid-class_e_e_1_1_u_i_1_1_u_i_value_binding>`<T>&& binding)

Adds and takes ownership of a typed binding.



.. rubric:: Returns:

This group, allowing several bindings to be added in one expression.

.. index:: pair: function; hold
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a4046ce76823dd7e4b1e2c349c2fbcad0:

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

	template <typename T>
	UIBindingGroup& hold(std::unique_ptr<:ref:`UIDataBind<doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind>`<T>> binding)

Adds and takes ownership of a legacy :ref:`UIDataBind <doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind>`.

.. index:: pair: function; hold
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a33b77ef1b1fe8bbc01a160c85b415f24:

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

	template <typename T>
	UIBindingGroup& hold(:ref:`UIProperty<doxid-class_e_e_1_1_u_i_1_1_u_i_property>`<T>& property)

Tracks a :ref:`UIProperty <doxid-class_e_e_1_1_u_i_1_1_u_i_property>` without taking ownership of it.

The entry expires safely if ``property`` is destroyed first. Its current value becomes the initial clean baseline.

.. index:: pair: function; operator+=
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a7f6865c3cda15f54a2a6cdf9de7f1032:

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

	template <typename T>
	UIBindingGroup& operator+=(:ref:`UIProperty<doxid-class_e_e_1_1_u_i_1_1_u_i_property>`<T>& property)

Convenience form of :ref:`hold(UIProperty\<T>&) <doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a33b77ef1b1fe8bbc01a160c85b415f24>`.

.. index:: pair: function; isValid
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a55dbe3acb1ea774a99d189d46812eed9:

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

	bool isValid() const

Disabled fields are intentionally ignored, which supports conditional form sections.



.. rubric:: Returns:

true when every binding attached to an enabled widget is valid.

.. index:: pair: function; isDirty
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1ad3bb25f634316302862c79247d9f33d9:

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

	bool isDirty() const



.. rubric:: Returns:

true when at least one value differs from its current clean baseline.

.. index:: pair: function; validValue
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a54dbf49593fccc3c43ec7c7d492722fc:

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

	:ref:`ObservableValue<doxid-class_e_e_1_1_observable_value>`<bool>& validValue()



.. rubric:: Returns:

Observable aggregate validity, suitable for computed values and commands.

.. index:: pair: function; dirtyValue
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1af9726cbce15bdc50d1a06766124ed572:

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

	:ref:`ObservableValue<doxid-class_e_e_1_1_observable_value>`<bool>& dirtyValue()



.. rubric:: Returns:

Observable aggregate dirty state, suitable for computed values and commands.

.. index:: pair: function; errors
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a0f3efe5133cf634898661bf955de7940:

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

	:ref:`Errors<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1aa862c4e90978947baa2ea2db13aa3b21>` errors() const



.. rubric:: Returns:

Invalid enabled bindings in insertion order.

.. index:: pair: function; widgets
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1aed7f71c6c59a3c75baf64ac2967a66fb:

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

	:ref:`Widgets<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1ae7ac8076b0f64ecd614cb5d32ae1fc4e>` widgets() const

The order within a legacy multi-widget :ref:`UIDataBind <doxid-class_e_e_1_1_u_i_1_1_u_i_data_bind>` or :ref:`UIProperty <doxid-class_e_e_1_1_u_i_1_1_u_i_property>` is unspecified.



.. rubric:: Returns:

Connected widgets grouped by binding insertion order.

.. index:: pair: function; firstInvalidWidget
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1ace8e8eb0d9da12b95b1bd8ef01b96b94:

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

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



.. rubric:: Returns:

The first invalid enabled widget in insertion order, or nullptr.

.. index:: pair: function; markClean
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a622520262bd13b13747ba9436985fff3:

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

	void markClean()

Makes every binding's current value its new clean/reset baseline.

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

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

	void reset()

Restores every binding to the baseline recorded at insertion or :ref:`markClean() <doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a622520262bd13b13747ba9436985fff3>`.

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

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

	void clear()

Destroys all owned bindings and resets aggregate state.

.. index:: pair: function; size
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1afc2782272ec3065a164e1b9f4347301d:

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

	std::size_t size() const



.. rubric:: Returns:

The number of bindings owned by the group.

.. index:: pair: function; onChange
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1ac13b61df7db0ff6b1412be6bad5c1696:

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

	void onChange(:ref:`Callback<doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a8c80dc31269dbe481b3aa7037fcf04c0>` callback)

Replaces the callback invoked after a relevant group event.

A non-empty callback is invoked once immediately, then after value, validation, enabled-state, baseline, or membership changes. Use :ref:`validValue() <doxid-class_e_e_1_1_u_i_1_1_u_i_binding_group_1a54dbf49593fccc3c43ec7c7d492722fc>` /dirtyValue() when only aggregate transitions matter, since those observables suppress equal values.