docs/latex/wx/propforv.tex

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