]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/propregv.tex
updated wxLocale documentation to reflect API changes
[wxWidgets.git] / docs / latex / wx / propregv.tex
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 \latexignore{\rtfignore{\wxheading{Members}}}
8
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