.. index:: pair: struct; EE::UI::UIValueValidationResult
.. _doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result:

struct EE::UI::UIValueValidationResult
======================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Machine-readable result of converting or accepting a widget value. :ref:`More...<details-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result>`


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

	#include <uivaluevalidation.hpp>
	
	struct UIValueValidationResult {
		// typedefs
	
		typedef :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` :target:`Code<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result_1a0339b4ed99ecbccaeee8c7647307ca59>`;

		// fields
	
		bool :target:`valid<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result_1af927bcdd2257f3a8a70770ba090aa36f>` { true };
		std::optional<:ref:`Code<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result_1a0339b4ed99ecbccaeee8c7647307ca59>`> :target:`code<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result_1af5cd83285b373d847bdbf0929a2d8142>`;
		std::optional<std::string> :target:`debugMessage<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result_1a807b75afefe894082bc5c675216e4ff4>`;

		// methods
	
		:target:`operator bool<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result_1a2b855bb6280a9c282ab85a0512fc418a>`() const;
		bool :target:`operator==<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result_1a90932f676570984139113df86ab9be28>`(const UIValueValidationResult& other) const;
		bool :target:`operator!=<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result_1a92849082bea841ceba71e49a0b0135b0>`(const UIValueValidationResult& other) const;
		static UIValueValidationResult :target:`success<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result_1a1aab6f74a7e92088b658b3f545fe7c17>`();
		static UIValueValidationResult :target:`error<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result_1a3fd1b55ea22ad15d7ae901c042cf878f>`(:ref:`Code<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result_1a0339b4ed99ecbccaeee8c7647307ca59>` code);
		static UIValueValidationResult :target:`error<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result_1ac6fa764324cf9148223115008a5aa9a6>`(:ref:`Code<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result_1a0339b4ed99ecbccaeee8c7647307ca59>` code, std::string debugMessage);
		static UIValueValidationResult :target:`error<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result_1a9da399992415de181d77e3865b2f55dd>`(std::string debugMessage);
	};
.. _details-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result:

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

Machine-readable result of converting or accepting a widget value.

A numeric code is the normal way to identify an error. Applications can map that code, together with the binding or form context, to localized :ref:`UI <doxid-namespace_e_e_1_1_u_i>` text. debugMessage is optional diagnostic information for logs, tests, and inspection; it should not be shown to users implicitly.

Codes are owned by the subsystem or application defining the validation rule. Apart from values in UIValueValidationError, eepp does not require codes to be globally unique or stable for serialization. Code 0 is valid: the optional itself represents the absence of a code.