Added wxGenericValidator & doc

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1635 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

src/common/valgen.cpp

@@ -0,0 +1,386 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        valgen.cpp
+// Purpose:     wxGenericValidator class
+// Author:      Kevin Smith
+// Modified by:
+// Created:     Jan 22 1999
+// RCS-ID:      
+// Copyright:   (c) 1999 Kevin Smith
+// Licence:   	wxWindows licence
+/////////////////////////////////////////////////////////////////////////////
+
+#ifdef __GNUG__
+#pragma implementation "valgen.h"
+#endif
+
+// For compilers that support precompilation, includes "wx.h".
+#include "wx/wxprec.h"
+
+#ifdef __BORLANDC__
+#pragma hdrstop
+#endif
+
+#ifndef WX_PRECOMP
+#include "wx/utils.h"
+#include "wx/intl.h"
+#endif
+
+#include "wx/spinbutt.h"
+#include "wx/checklst.h"
+
+#include "wx/valgen.h"
+
+wxGenericValidator::wxGenericValidator(bool *val)
+{
+  Initialize();
+  m_pBool = val;
+}
+
+wxGenericValidator::wxGenericValidator(int *val)
+{
+  Initialize();
+  m_pInt = val;
+}
+
+wxGenericValidator::wxGenericValidator(wxString *val)
+{
+  Initialize();
+  m_pString = val;
+}
+
+wxGenericValidator::wxGenericValidator(wxArrayInt *val)
+{
+  Initialize();
+  m_pArrayInt = val;
+}
+
+wxGenericValidator::wxGenericValidator(const wxGenericValidator& val)
+{
+  Copy(val);
+}
+
+bool wxGenericValidator::Copy(const wxGenericValidator& val)
+{
+  wxValidator::Copy(val);
+
+  m_pBool = val.m_pBool;
+  m_pInt = val.m_pInt;
+  m_pString = val.m_pString;
+  m_pArrayInt = val.m_pArrayInt;
+
+  return TRUE;
+}
+
+wxGenericValidator::~wxGenericValidator()
+{
+}
+
+// Called to transfer data to the window
+bool wxGenericValidator::TransferToWindow(void)
+{
+  if ( !m_validatorWindow )
+    return FALSE;
+
+  // bool controls
+  if (m_validatorWindow->IsKindOf(CLASSINFO(wxCheckBox)) )
+  {
+    wxCheckBox* pControl = (wxCheckBox*) m_validatorWindow;
+	if (m_pBool)
+    {
+      pControl->SetValue(*m_pBool) ;
+      return TRUE;
+    }
+  }
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxRadioButton)) )
+  {
+    wxRadioButton* pControl = (wxRadioButton*) m_validatorWindow;
+	if (m_pBool)
+    {
+      pControl->SetValue(*m_pBool) ;
+      return TRUE;
+    }
+  }
+  // int controls
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxGauge)) )
+  {
+    wxGauge* pControl = (wxGauge*) m_validatorWindow;
+	if (m_pInt)
+    {
+      pControl->SetValue(*m_pInt) ;
+      return TRUE;
+    }
+  }
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxRadioBox)) )
+  {
+    wxRadioBox* pControl = (wxRadioBox*) m_validatorWindow;
+	if (m_pInt)
+    {
+      pControl->SetSelection(*m_pInt) ;
+      return TRUE;
+    }
+  }
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxScrollBar)) )
+  {
+    wxScrollBar* pControl = (wxScrollBar*) m_validatorWindow;
+	if (m_pInt)
+    {
+      pControl->SetThumbPosition(*m_pInt) ;
+      return TRUE;
+    }
+  }
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxSpinButton)) )
+  {
+    wxSpinButton* pControl = (wxSpinButton*) m_validatorWindow;
+	if (m_pInt)
+    {
+      pControl->SetValue(*m_pInt) ;
+      return TRUE;
+    }
+  }
+  // string controls
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxButton)) )
+  {
+    wxButton* pControl = (wxButton*) m_validatorWindow;
+	if (m_pString)
+    {
+      pControl->SetLabel(*m_pString) ;
+      return TRUE;
+    }
+  }
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxComboBox)) )
+  {
+    wxComboBox* pControl = (wxComboBox*) m_validatorWindow;
+	if (m_pString)
+    {
+      pControl->SetValue(*m_pString) ;
+      return TRUE;
+    }
+  }
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxChoice)) )
+  {
+    wxChoice* pControl = (wxChoice*) m_validatorWindow;
+	if (m_pInt)
+    {
+      pControl->SetSelection(*m_pInt) ;
+      return TRUE;
+    }
+  }
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxStaticText)) )
+  {
+    wxStaticText* pControl = (wxStaticText*) m_validatorWindow;
+	if (m_pString)
+    {
+      pControl->SetLabel(*m_pString) ;
+      return TRUE;
+    }
+  }
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxTextCtrl)) )
+  {
+    wxTextCtrl* pControl = (wxTextCtrl*) m_validatorWindow;
+	if (m_pString)
+    {
+      pControl->SetValue(*m_pString) ;
+      return TRUE;
+    }
+  }
+  // array controls
+  // NOTE: wxCheckListBox isa wxListBox, so wxCheckListBox
+  // MUST come first:
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxCheckListBox)) )
+  {
+    wxCheckListBox* pControl = (wxCheckListBox*) m_validatorWindow;
+	if (m_pArrayInt)
+    {
+      // clear all selections
+      int i;
+      for (i = 0 ; i < pControl->Number(); ++i)
+        pControl->Check(i, FALSE);
+      // select each item in our array
+      unsigned u;
+      for (u = 0; u < m_pArrayInt->Count(); ++u)
+        pControl->Check(m_pArrayInt->Item(u));
+      return TRUE;
+    }
+	else
+		return FALSE;
+  }
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxListBox)) )
+  {
+    wxListBox* pControl = (wxListBox*) m_validatorWindow;
+	if (m_pArrayInt)
+    {
+      // clear all selections
+      int i;
+      for (i = 0 ; i < pControl->Number(); ++i)
+        pControl->Deselect(i);
+      // select each item in our array
+      unsigned u;
+      for (u = 0; u < m_pArrayInt->Count(); ++u)
+        pControl->SetSelection(m_pArrayInt->Item(u));
+      return TRUE;
+    }
+  }
+
+  // unrecognized control, or bad pointer
+  return FALSE;
+}
+
+// Called to transfer data to the window
+bool wxGenericValidator::TransferFromWindow(void)
+{
+  if ( !m_validatorWindow )
+    return FALSE;
+
+  // bool controls
+  if (m_validatorWindow->IsKindOf(CLASSINFO(wxCheckBox)) )
+  {
+    wxCheckBox* pControl = (wxCheckBox*) m_validatorWindow;
+	if (m_pBool)
+    {
+      *m_pBool = pControl->GetValue() ;
+      return TRUE;
+    }
+  }
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxRadioButton)) )
+  {
+    wxRadioButton* pControl = (wxRadioButton*) m_validatorWindow;
+	if (m_pBool)
+    {
+      *m_pBool = pControl->GetValue() ;
+      return TRUE;
+    }
+  }
+  // int controls
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxGauge)) )
+  {
+    wxGauge* pControl = (wxGauge*) m_validatorWindow;
+	if (m_pInt)
+    {
+      *m_pInt = pControl->GetValue() ;
+      return TRUE;
+    }
+  }
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxRadioBox)) )
+  {
+    wxRadioBox* pControl = (wxRadioBox*) m_validatorWindow;
+	if (m_pInt)
+    {
+      *m_pInt = pControl->GetSelection() ;
+      return TRUE;
+    }
+  }
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxScrollBar)) )
+  {
+    wxScrollBar* pControl = (wxScrollBar*) m_validatorWindow;
+	if (m_pInt)
+    {
+      *m_pInt = pControl->GetThumbPosition() ;
+      return TRUE;
+    }
+  }
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxSpinButton)) )
+  {
+    wxSpinButton* pControl = (wxSpinButton*) m_validatorWindow;
+	if (m_pInt)
+    {
+      *m_pInt = pControl->GetValue() ;
+      return TRUE;
+    }
+  }
+  // string controls
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxButton)) )
+  {
+    wxButton* pControl = (wxButton*) m_validatorWindow;
+	if (m_pString)
+    {
+      *m_pString = pControl->GetLabel() ;
+      return TRUE;
+    }
+  }
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxComboBox)) )
+  {
+    wxComboBox* pControl = (wxComboBox*) m_validatorWindow;
+	if (m_pString)
+    {
+      *m_pString = pControl->GetValue() ;
+      return TRUE;
+    }
+  }
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxChoice)) )
+  {
+    wxChoice* pControl = (wxChoice*) m_validatorWindow;
+	if (m_pInt)
+    {
+      *m_pInt = pControl->GetSelection() ;
+      return TRUE;
+    }
+  }
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxStaticText)) )
+  {
+    wxStaticText* pControl = (wxStaticText*) m_validatorWindow;
+	if (m_pString)
+    {
+      *m_pString = pControl->GetLabel() ;
+      return TRUE;
+    }
+  }
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxTextCtrl)) )
+  {
+    wxTextCtrl* pControl = (wxTextCtrl*) m_validatorWindow;
+	if (m_pString)
+    {
+      *m_pString = pControl->GetValue() ;
+      return TRUE;
+    }
+  }
+  // array controls
+  // NOTE: wxCheckListBox isa wxListBox, so wxCheckListBox
+  // MUST come first:
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxCheckListBox)) )
+  {
+    wxCheckListBox* pControl = (wxCheckListBox*) m_validatorWindow;
+	if (m_pArrayInt)
+    {
+      // clear our array
+      m_pArrayInt->Clear();
+      // add each selected item to our array
+      int i;
+      for (i = 0 ; i < pControl->Number(); ++i)
+        if (pControl->IsChecked(i))
+          m_pArrayInt->Add(i);
+      return TRUE;
+    }
+	else
+	  return FALSE;
+  }
+  else if (m_validatorWindow->IsKindOf(CLASSINFO(wxListBox)) )
+  {
+    wxListBox* pControl = (wxListBox*) m_validatorWindow;
+	if (m_pArrayInt)
+    {
+      // clear our array
+      m_pArrayInt->Clear();
+      // add each selected item to our array
+      int i;
+      for (i = 0 ; i < pControl->Number(); ++i)
+        if (pControl->Selected(i))
+          m_pArrayInt->Add(i);
+      return TRUE;
+    }
+  }
+
+  // unrecognized control, or bad pointer
+  return FALSE;
+}
+
+/*
+  Called by constructors to initialize ALL data members
+*/
+void wxGenericValidator::Initialize()
+{
+  m_pBool = 0;
+  m_pInt = 0;
+  m_pString = 0;
+  m_pArrayInt = 0;
+}
+

src/gtk.inc

@@ -54,6 +54,7 @@ LIB_CPP_SRC=\
  common/objstrm.cpp \
  common/sckstrm.cpp \
  common/validate.cpp \
+ common/valgen.cpp \
  common/valtext.cpp \
  common/variant.cpp \
  common/socket.cpp \

src/motif.inc

@@ -55,6 +55,7 @@ LIB_CPP_SRC=\
  common/objstrm.cpp \
  common/sckstrm.cpp \
  common/validate.cpp \
+ common/valgen.cpp \
  common/valtext.cpp \
  common/variant.cpp \
  common/wxexpr.cpp \

src/motif/makefile.unx

@@ -59,6 +59,7 @@ LIB_CPP_SRC=\
  ../common/objstrm.cpp \
  ../common/sckstrm.cpp \
  ../common/validate.cpp \
+ ../common/valgen.cpp \
  ../common/valtext.cpp \
  ../common/variant.cpp \
  ../common/wxexpr.cpp \

src/msw/makefile.b32

@@ -127,6 +127,7 @@ COMMONOBJS = \
   $(MSWDIR)\timercmn.obj \
   $(MSWDIR)\utilscmn.obj \
   $(MSWDIR)\validate.obj \
+  $(MSWDIR)\valgen.obj \
   $(MSWDIR)\valtext.obj \
   $(MSWDIR)\variant.obj \
   $(MSWDIR)\date.obj \
@@ -539,6 +540,8 @@ $(MSWDIR)\utilscmn.obj:     $(COMMDIR)\utilscmn.$(SRCSUFF)
 
 $(MSWDIR)\validate.obj:     $(COMMDIR)\validate.$(SRCSUFF)
 
+$(MSWDIR)\valgen.obj:     $(COMMDIR)\valtext.$(SRCSUFF)
+
 $(MSWDIR)\valtext.obj:     $(COMMDIR)\valtext.$(SRCSUFF)
 
 $(MSWDIR)\date.obj:     $(COMMDIR)\date.$(SRCSUFF)

src/msw/makefile.bcc

@@ -124,6 +124,7 @@ COMMONOBJS = \
   $(MSWDIR)\timercmn.obj \
   $(MSWDIR)\utilscmn.obj \
   $(MSWDIR)\validate.obj \
+  $(MSWDIR)\valgen.obj \
   $(MSWDIR)\valtext.obj \
   $(MSWDIR)\variant.obj \
   $(MSWDIR)\date.obj \
@@ -526,6 +527,8 @@ $(MSWDIR)\utilscmn.obj:     $(COMMDIR)\utilscmn.$(SRCSUFF)
 
 $(MSWDIR)\validate.obj:     $(COMMDIR)\validate.$(SRCSUFF)
 
+$(MSWDIR)\valgen.obj:     $(COMMDIR)\valgen.$(SRCSUFF)
+
 $(MSWDIR)\valtext.obj:     $(COMMDIR)\valtext.$(SRCSUFF)
 
 $(MSWDIR)\date.obj:     $(COMMDIR)\date.$(SRCSUFF)

src/msw/makefile.dos

@@ -105,6 +105,7 @@ COMMONOBJS = \
   $(COMMDIR)\timercmn.obj \
   $(COMMDIR)\utilscmn.obj \
   $(COMMDIR)\validate.obj \
+  $(COMMDIR)\valgen.obj \
   $(COMMDIR)\valtext.obj \
   $(COMMDIR)\date.obj \
   $(COMMDIR)\wxexpr.obj \
@@ -833,6 +834,11 @@ $(COMMDIR)/validate.obj:     $*.$(SRCSUFF)
 $(CPPFLAGS) /Fo$@ /c /Tp $*.$(SRCSUFF)
 <<
 
+$(COMMDIR)/valgen.obj:     $*.$(SRCSUFF)
+        cl @<<
+$(CPPFLAGS) /Fo$@ /c /Tp $*.$(SRCSUFF)
+<<
+
 $(COMMDIR)/valtext.obj:     $*.$(SRCSUFF)
         cl @<<
 $(CPPFLAGS) /Fo$@ /c /Tp $*.$(SRCSUFF)

src/msw/makefile.g95

@@ -111,6 +111,7 @@ COMMONOBJS = \
   $(COMMDIR)/timercmn.$(OBJSUFF) \
   $(COMMDIR)/utilscmn.$(OBJSUFF) \
   $(COMMDIR)/validate.$(OBJSUFF) \
+  $(COMMDIR)/valgen.$(OBJSUFF) \
   $(COMMDIR)/valtext.$(OBJSUFF) \
   $(COMMDIR)/date.$(OBJSUFF) \
   $(COMMDIR)/wxexpr.$(OBJSUFF) \

src/msw/makefile.sc

@@ -83,6 +83,7 @@ COMMONOBJS = \
   $(COMMDIR)\timercmn.obj \
   $(COMMDIR)\utilscmn.obj \
   $(COMMDIR)\validate.obj \
+  $(COMMDIR)\valgen.obj \
   $(COMMDIR)\valtext.obj \
   $(COMMDIR)\date.obj \
   $(COMMDIR)\hash.obj \

src/msw/makefile.sl

@@ -69,6 +69,7 @@ COMMONOBJS = cmndata.obj \
   timercmn.obj \
   utilscmn.obj \
   validate.obj \
+  valgen.obj \
   valtext.obj \
   date.obj \
   hash.obj \
@@ -598,6 +599,9 @@ utilscmn.obj:     $(COMMDIR)\utilscmn.cpp
 validate.obj:     $(COMMDIR)\validate.cpp
   $(CCC) $(CPPFLAGS) $(IFLAGS) $(COMMDIR)\validate.cpp /BINARY validate.obj
 
+valgen.obj:     $(COMMDIR)\valgen.cpp
+  $(CCC) $(CPPFLAGS) $(IFLAGS) $(COMMDIR)\valgen.cpp /BINARY valgen.obj
+
 valtext.obj:     $(COMMDIR)\valtext.cpp
   $(CCC) $(CPPFLAGS) $(IFLAGS) $(COMMDIR)\valtext.cpp /BINARY valtext.obj
 

src/msw/makefile.twn

@@ -108,6 +108,7 @@ COMMONOBJS = \
   $(COMMDIR)/timercmn.$(OBJSUFF) \
   $(COMMDIR)/utilscmn.$(OBJSUFF) \
   $(COMMDIR)/validate.$(OBJSUFF) \
+  $(COMMDIR)/valgen.$(OBJSUFF) \
   $(COMMDIR)/valtext.$(OBJSUFF) \
   $(COMMDIR)/date.$(OBJSUFF) \
   $(COMMDIR)/wxexpr.$(OBJSUFF) \

src/msw/makefile.vc

@@ -112,6 +112,7 @@ COMMONOBJS = \
   $(COMMDIR)\timercmn.obj \
   $(COMMDIR)\utilscmn.obj \
   $(COMMDIR)\validate.obj \
+  $(COMMDIR)\valgen.obj \
   $(COMMDIR)\valtext.obj \
   $(COMMDIR)\date.obj \
   $(COMMDIR)\hash.obj \
@@ -927,6 +928,11 @@ $(COMMDIR)/validate.obj:     $*.$(SRCSUFF)
 $(CPPFLAGS) /c /Tp $*.$(SRCSUFF) /Fo$@
 <<
 
+$(COMMDIR)/valgen.obj:     $*.$(SRCSUFF)
+        cl @<<
+$(CPPFLAGS) /c /Tp $*.$(SRCSUFF) /Fo$@
+<<
+
 $(COMMDIR)/valtext.obj:     $*.$(SRCSUFF)
         cl @<<
 $(CPPFLAGS) /c /Tp $*.$(SRCSUFF) /Fo$@

src/msw/makefile.wat

@@ -79,6 +79,7 @@ COMMONOBJS = cmndata.obj &
   timercmn.obj &
   utilscmn.obj &
   validate.obj &
+  valgen.obj &
   valtext.obj &
   date.obj &
   hash.obj &
@@ -610,6 +611,9 @@ utilscmn.obj:     $(COMMDIR)\utilscmn.cpp
 validate.obj:     $(COMMDIR)\validate.cpp
   *$(CCC) $(CPPFLAGS) $(IFLAGS) $<
 
+valgen.obj:     $(COMMDIR)\valgen.cpp
+  *$(CCC) $(CPPFLAGS) $(IFLAGS) $<
+
 valtext.obj:     $(COMMDIR)\valtext.cpp
   *$(CCC) $(CPPFLAGS) $(IFLAGS) $<
 

src/stubs.inc

@@ -52,6 +52,7 @@ LIB_CPP_SRC=\
  common/objstrm.cpp \
  common/sckstrm.cpp \
  common/validate.cpp \
+ common/valgen.cpp \
  common/valtext.cpp \
  common/variant.cpp \
  common/wxexpr.cpp \

src/stubs/makefile.unx

@@ -57,6 +57,7 @@ LIB_CPP_SRC=\
  ../common/objstrm.cpp \
  ../common/sckstrm.cpp \
  ../common/validate.cpp \
+ ../common/valgen.cpp \
  ../common/valtext.cpp \
  ../common/variant.cpp \
  ../common/wxexpr.cpp \

src/stubs/makefile.vc

@@ -145,6 +145,7 @@ COMMONOBJS = \
   $(COMMDIR)\timercmn.obj \
   $(COMMDIR)\utilscmn.obj \
   $(COMMDIR)\validate.obj \
+  $(COMMDIR)\valgen.obj \
   $(COMMDIR)\valtext.obj \
   $(COMMDIR)\date.obj \
   $(COMMDIR)\hash.obj \
@@ -750,6 +751,11 @@ $(COMMDIR)/validate.obj:     $*.$(SRCSUFF)
 $(CPPFLAGS) /c /Tp $*.$(SRCSUFF) /Fo$@
 <<
 
+$(COMMDIR)/valgen.obj:     $*.$(SRCSUFF)
+        cl @<<
+$(CPPFLAGS) /c /Tp $*.$(SRCSUFF) /Fo$@
+<<
+
 $(COMMDIR)/valtext.obj:     $*.$(SRCSUFF)
         cl @<<
 $(CPPFLAGS) /c /Tp $*.$(SRCSUFF) /Fo$@