[wxWidgets.git] / docs / latex / wx / propregv.tex

\section{\class{wxPropertyValidatorRegistry}}\label{wxpropertyvalidatorregistry}

The {\bf wxPropertyValidatorRegistry} class is used for storing validators,
indexed by the `role name' of the property, by which groups of property
can be identified for the purpose of validation and editing.

\membersection{wxPropertyValidatorRegistry::wxPropertyValidatorRegistry}

\func{void}{wxPropertyValidatorRegistry}{\void}

Constructor.

\membersection{wxPropertyValidatorRegistry::\destruct{wxPropertyValidatorRegistry}}

\func{void}{\destruct{wxPropertyValidatorRegistry}}{\void}

Destructor.

\membersection{wxPropertyValidatorRegistry::Clear}

\func{void}{ClearRegistry}{\void}

Clears the registry, deleting the validators.

\membersection{wxPropertyValidatorRegistry::GetValidator}

\func{wxPropertyValidator *}{GetValidator}{\param{wxString\& }{roleName}}

Retrieve a validator by the property role name.

\membersection{wxPropertyValidatorRegistry::RegisterValidator}\label{wxpropertyvalidatorregistervalidator}

\func{void}{RegisterValidator}{\param{wxString\& }{roleName}, \param{wxPropertyValidator *}{validator}}

Register a validator with the registry. {\it roleName} is a name indicating the
role of the property, such as ``filename''. Later, when a validator is chosen for
editing a property, this role name is matched against the class names of the property,
if the property does not already have a validator explicitly associated with it.
Commit	Line	Data
200fed6c VS	1	\section{\class{wxPropertyValidatorRegistry}}\label{wxpropertyvalidatorregistry}
	2
	3	The {\bf wxPropertyValidatorRegistry} class is used for storing validators,
	4	indexed by the `role name' of the property, by which groups of property
	5	can be identified for the purpose of validation and editing.
	6
	7	\membersection{wxPropertyValidatorRegistry::wxPropertyValidatorRegistry}
	8
	9	\func{void}{wxPropertyValidatorRegistry}{\void}
	10
	11	Constructor.
	12
	13	\membersection{wxPropertyValidatorRegistry::\destruct{wxPropertyValidatorRegistry}}
	14
	15	\func{void}{\destruct{wxPropertyValidatorRegistry}}{\void}
	16
	17	Destructor.
	18
	19	\membersection{wxPropertyValidatorRegistry::Clear}
	20
	21	\func{void}{ClearRegistry}{\void}
	22
	23	Clears the registry, deleting the validators.
	24
	25	\membersection{wxPropertyValidatorRegistry::GetValidator}
	26
	27	\func{wxPropertyValidator *}{GetValidator}{\param{wxString\& }{roleName}}
	28
	29	Retrieve a validator by the property role name.
	30
	31	\membersection{wxPropertyValidatorRegistry::RegisterValidator}\label{wxpropertyvalidatorregistervalidator}
	32
	33	\func{void}{RegisterValidator}{\param{wxString\& }{roleName}, \param{wxPropertyValidator *}{validator}}
	34
	35	Register a validator with the registry. {\it roleName} is a name indicating the
	36	role of the property, such as ``filename''. Later, when a validator is chosen for
	37	editing a property, this role name is matched against the class names of the property,
	38	if the property does not already have a validator explicitly associated with it.
	39
	40