property_validator.h File Reference

#include <functional>
#include <optional>
#include <wx/any.h>
#include <wx/string.h>

Go to the source code of this file.

Classes
class	VALIDATION_ERROR
	Represents an error returned by a validator and contains enough data to format an error message. More...

Typedefs
using	VALIDATOR_RESULT = std::optional<std::unique_ptr<VALIDATION_ERROR>>
	Null optional means validation succeeded.
using	PROPERTY_VALIDATOR_FN = std::function<VALIDATOR_RESULT( const wxAny&&, EDA_ITEM* aItem )>
	A property validator function takes in the data type of the owning property, and returns a VALIDATOR_RESULT that will be empty (null) if validation succeeded, and contain an error message otherwise.

Typedef Documentation

PROPERTY_VALIDATOR_FN

using PROPERTY_VALIDATOR_FN = std::function<VALIDATOR_RESULT( const wxAny&&, EDA_ITEM* aItem )>

A property validator function takes in the data type of the owning property, and returns a VALIDATOR_RESULT that will be empty (null) if validation succeeded, and contain an error message otherwise.

Definition at line 51 of file property_validator.h.

VALIDATOR_RESULT

using VALIDATOR_RESULT = std::optional<std::unique_ptr<VALIDATION_ERROR>>

Null optional means validation succeeded.

Definition at line 44 of file property_validator.h.