[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.

\latexignore{\rtfignore{\wxheading{Members}}}

\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
fa482912 JS	7	\latexignore{\rtfignore{\wxheading{Members}}}
fa482912 JS	8
200fed6c VS	9	\membersection{wxPropertyValidatorRegistry::wxPropertyValidatorRegistry}
	10
	11	\func{void}{wxPropertyValidatorRegistry}{\void}
	12
	13	Constructor.
	14
	15	\membersection{wxPropertyValidatorRegistry::\destruct{wxPropertyValidatorRegistry}}
	16
	17	\func{void}{\destruct{wxPropertyValidatorRegistry}}{\void}
	18
	19	Destructor.
	20
	21	\membersection{wxPropertyValidatorRegistry::Clear}
	22
	23	\func{void}{ClearRegistry}{\void}
	24
	25	Clears the registry, deleting the validators.
	26
	27	\membersection{wxPropertyValidatorRegistry::GetValidator}
	28
	29	\func{wxPropertyValidator *}{GetValidator}{\param{wxString\& }{roleName}}
	30
	31	Retrieve a validator by the property role name.
	32
	33	\membersection{wxPropertyValidatorRegistry::RegisterValidator}\label{wxpropertyvalidatorregistervalidator}
	34
	35	\func{void}{RegisterValidator}{\param{wxString\& }{roleName}, \param{wxPropertyValidator *}{validator}}
	36
	37	Register a validator with the registry. {\it roleName} is a name indicating the
	38	role of the property, such as ``filename''. Later, when a validator is chosen for
	39	editing a property, this role name is matched against the class names of the property,
	40	if the property does not already have a validator explicitly associated with it.
	41
	42