contrib/docs/latex/deprecated/propforv.tex

   1 \section{\class{wxPropertyFormValidator}}\label{wxpropertyformvalidator}
   2
   3 The {\bf wxPropertyFormValidator} class defines a base class for form validators. By overriding virtual functions,
   4 the programmer can create custom behaviour for kinds of property.
   5
   6 \wxheading{See also}
   7
   8 \helpref{wxPropertyFormValidator overview}{wxpropertyformvalidatoroverview}
   9
  10 \latexignore{\rtfignore{\wxheading{Members}}}
  11
  12 \membersection{wxPropertyFormValidator::wxPropertyFormValidator}
  13
  14 \func{void}{wxPropertyFormValidator}{\param{long}{ flags = 0}}
  15
  16 Constructor.
  17
  18 \membersection{wxPropertyFormValidator::\destruct{wxPropertyFormValidator}}
  19
  20 \func{void}{\destruct{wxPropertyFormValidator}}{\void}
  21
  22 Destructor.
  23
  24 \membersection{wxPropertyFormValidator::OnCommand}
  25
  26 \func{bool}{OnCommand}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
  27  \param{wxWindow *}{parentWindow}, \param{wxCommandEvent\& }{event}}
  28
  29 Called when the control corresponding to the property receives a command (if not intercepted
  30 by a callback associated with the actual control).
  31
  32 \membersection{wxPropertyFormValidator::OnCheckValue}
  33
  34 \func{bool}{OnCheckValue}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
  35  \param{wxWindow *}{parentWindow}}
  36
  37 Called when the view checks the property value. The value checked by this validator should be taken from the
  38 panel item corresponding to the property.
  39
  40 \membersection{wxPropertyFormValidator::OnDisplayValue}
  41
  42 \func{bool}{OnDisplayValue}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
  43  \param{wxWindow *}{parentWindow}}
  44
  45 Should display the property value in the appropriate control.
  46
  47 \membersection{wxPropertyFormValidator::OnDoubleClick}
  48
  49 \func{bool}{OnDoubleClick}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
  50  \param{wxWindow *}{parentWindow}}
  51
  52 Called when the control corresponding to the property is double clicked (listboxes only).
  53
  54 \membersection{wxPropertyFormValidator::OnRetrieveValue}
  55
  56 \func{bool}{OnRetrieveValue}{\param{wxProperty *}{property}, \param{wxPropertyFormView *}{view},
  57  \param{wxWindow *}{parentWindow}}
  58
  59 Should do the transfer from the property editing area to the property itself.
  60