include/wx/valgen.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        valgen.h
   3 // Purpose:     wxGenericValidator class
   4 // Author:      Kevin Smith
   5 // Created:     Jan 22 1999
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 1999 Julian Smart (assigned from Kevin)
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_VALGENH__
  12 #define _WX_VALGENH__
  13
  14 #include "wx/validate.h"
  15
  16 #if wxUSE_VALIDATORS
  17
  18 class WXDLLIMPEXP_FWD_BASE wxDateTime;
  19
  20 // ----------------------------------------------------------------------------
  21 // wxGenericValidator performs data transfer between many standard controls and
  22 // variables of the type corresponding to their values.
  23 //
  24 // It doesn't do any validation so its name is a slight misnomer.
  25 // ----------------------------------------------------------------------------
  26
  27 class WXDLLIMPEXP_CORE wxGenericValidator: public wxValidator
  28 {
  29 public:
  30     // Different constructors: each of them creates a validator which can only
  31     // be used with some controls, the comments before each constructor
  32     // indicate which ones:
  33         // wxCheckBox, wxRadioButton, wx(Bitmap)ToggleButton
  34     wxGenericValidator(bool* val);
  35         // wxChoice, wxGauge, wxRadioBox, wxScrollBar, wxSlider, wxSpinButton
  36     wxGenericValidator(int* val);
  37         // wxComboBox, wxTextCtrl, wxButton, wxStaticText (read-only)
  38     wxGenericValidator(wxString* val);
  39         // wxListBox, wxCheckListBox
  40     wxGenericValidator(wxArrayInt* val);
  41 #if wxUSE_DATETIME
  42         // wxDatePickerCtrl
  43     wxGenericValidator(wxDateTime* val);
  44 #endif // wxUSE_DATETIME
  45     wxGenericValidator(const wxGenericValidator& copyFrom);
  46
  47     virtual ~wxGenericValidator(){}
  48
  49     // Make a clone of this validator (or return NULL) - currently necessary
  50     // if you're passing a reference to a validator.
  51     // Another possibility is to always pass a pointer to a new validator
  52     // (so the calling code can use a copy constructor of the relevant class).
  53     virtual wxObject *Clone() const { return new wxGenericValidator(*this); }
  54     bool Copy(const wxGenericValidator& val);
  55
  56     // Called when the value in the window must be validated: this is not used
  57     // by this class
  58     virtual bool Validate(wxWindow * WXUNUSED(parent)) { return true; }
  59
  60     // Called to transfer data to the window
  61     virtual bool TransferToWindow();
  62
  63     // Called to transfer data to the window
  64     virtual bool TransferFromWindow();
  65
  66 protected:
  67     void Initialize();
  68
  69     bool*       m_pBool;
  70     int*        m_pInt;
  71     wxString*   m_pString;
  72     wxArrayInt* m_pArrayInt;
  73 #if wxUSE_DATETIME
  74     wxDateTime* m_pDateTime;
  75 #endif // wxUSE_DATETIME
  76
  77 private:
  78     DECLARE_CLASS(wxGenericValidator)
  79     DECLARE_NO_ASSIGN_CLASS(wxGenericValidator)
  80 };
  81
  82 #endif // wxUSE_VALIDATORS
  83
  84 #endif // _WX_VALGENH__