Doc tweaks

[wxWidgets.git] / src / common / valtext.cpp

diff --git a/src/common/valtext.cpp b/src/common/valtext.cpp
index f891889826b97db693fe8897702d9fea694522b2..3fdd1964991ec3378388fdee094f6f0468ef720d 100644 (file)
--- a/src/common/valtext.cpp
+++ b/src/common/valtext.cpp
@@ -5,11 +5,11 @@
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:     wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

 #pragma implementation "valtext.h"
 #endif
 
 #pragma implementation "valtext.h"
 #endif
 


@@ -20,7 +20,7 @@
   #pragma hdrstop
 #endif
 
   #pragma hdrstop
 #endif
 

-#if wxUSE_VALIDATORS
+#if wxUSE_VALIDATORS && wxUSE_TEXTCTRL

 
 #ifndef WX_PRECOMP
   #include <stdio.h>
 
 #ifndef WX_PRECOMP
   #include <stdio.h>


@@ -40,29 +40,28 @@
     #include <clib.h>
 #endif
 
     #include <clib.h>
 #endif
 

-#if !USE_SHARED_LIBRARY

 IMPLEMENT_DYNAMIC_CLASS(wxTextValidator, wxValidator)
 
 BEGIN_EVENT_TABLE(wxTextValidator, wxValidator)
     EVT_CHAR(wxTextValidator::OnChar)
 END_EVENT_TABLE()
 IMPLEMENT_DYNAMIC_CLASS(wxTextValidator, wxValidator)
 
 BEGIN_EVENT_TABLE(wxTextValidator, wxValidator)
     EVT_CHAR(wxTextValidator::OnChar)
 END_EVENT_TABLE()

-#endif

 
 static bool wxIsNumeric(const wxString& val);
 
 wxTextValidator::wxTextValidator(long style, wxString *val)
 {
 
 static bool wxIsNumeric(const wxString& val);
 
 wxTextValidator::wxTextValidator(long style, wxString *val)
 {

-    m_validatorStyle = style ;
-    m_stringValue = val ;
+    m_validatorStyle = style;
+    m_stringValue = val;

 /*
     m_refData = new wxVTextRefData;
 
 /*
     m_refData = new wxVTextRefData;
 

-    M_VTEXTDATA->m_validatorStyle = style ;
-    M_VTEXTDATA->m_stringValue = val ;
+    M_VTEXTDATA->m_validatorStyle = style;
+    M_VTEXTDATA->m_stringValue = val;

 */
 }
 
 wxTextValidator::wxTextValidator(const wxTextValidator& val)
 */
 }
 
 wxTextValidator::wxTextValidator(const wxTextValidator& val)

+    : wxValidator()

 {
     Copy(val);
 }
 {
     Copy(val);
 }


@@ -71,28 +70,13 @@ bool wxTextValidator::Copy(const wxTextValidator& val)
 {
     wxValidator::Copy(val);
 
 {
     wxValidator::Copy(val);
 

-    m_validatorStyle = val.m_validatorStyle ;
-    m_stringValue = val.m_stringValue ;
+    m_validatorStyle = val.m_validatorStyle;
+    m_stringValue = val.m_stringValue;

 
 

-    wxNode *node = val.m_includeList.First() ;
-    while ( node )
-    {
-        wxChar *s = (wxChar *)node->Data();
-        m_includeList.Add(s);
-        node = node->Next();
-    }
-    node = val.m_excludeList.First() ;
-    while ( node )
-    {
-        wxChar *s = (wxChar *)node->Data();
-        m_excludeList.Add(s);
-        node = node->Next();
-    }
-    return TRUE;
-}
+    m_includes    = val.m_includes;
+    m_excludes    = val.m_excludes;

 
 

-wxTextValidator::~wxTextValidator()
-{
+    return true;

 }
 
 static bool wxIsAlpha(const wxString& val)
 }
 
 static bool wxIsAlpha(const wxString& val)


@@ -100,10 +84,10 @@ static bool wxIsAlpha(const wxString& val)
     int i;
     for ( i = 0; i < (int)val.Length(); i++)
     {
     int i;
     for ( i = 0; i < (int)val.Length(); i++)
     {

-        if (!isalpha(val[i]))
-            return FALSE;
+        if (!wxIsalpha(val[i]))
+            return false;

     }
     }

-    return TRUE;
+    return true;

 }
 
 static bool wxIsAlphaNumeric(const wxString& val)
 }
 
 static bool wxIsAlphaNumeric(const wxString& val)


@@ -111,77 +95,84 @@ static bool wxIsAlphaNumeric(const wxString& val)
     int i;
     for ( i = 0; i < (int)val.Length(); i++)
     {
     int i;
     for ( i = 0; i < (int)val.Length(); i++)
     {

-        if (!isalnum(val[i]))
-            return FALSE;
+        if (!wxIsalnum(val[i]))
+            return false;

     }
     }

-    return TRUE;
+    return true;

 }
 
 // Called when the value in the window must be validated.
 // This function can pop up an error message.
 bool wxTextValidator::Validate(wxWindow *parent)
 {
 }
 
 // Called when the value in the window must be validated.
 // This function can pop up an error message.
 bool wxTextValidator::Validate(wxWindow *parent)
 {

-    if ( !m_validatorWindow )
-        return FALSE;
-    if ( !m_validatorWindow->IsKindOf(CLASSINFO(wxTextCtrl)) )
-        return FALSE;
-    if ( !m_stringValue )
-        return FALSE;
+    if( !CheckValidator() )
+        return false;

 
 

-    wxTextCtrl *control = (wxTextCtrl *) m_validatorWindow ;
+    wxTextCtrl *control = (wxTextCtrl *) m_validatorWindow;

 
     // If window is disabled, simply return
     if ( !control->IsEnabled() )
 
     // If window is disabled, simply return
     if ( !control->IsEnabled() )

-        return TRUE;
+        return true;

 
     wxString val(control->GetValue());
 
 
     wxString val(control->GetValue());
 

-    bool ok = TRUE;
+    bool ok = true;

 
 

-    // this format string should contian exactly one '%s'
-    const wxChar *errormsg = _("'%s' is invalid");
+    // NB: this format string should contian exactly one '%s'
+    wxString errormsg;

 
 

-    if ( m_validatorStyle & wxFILTER_INCLUDE_LIST )
+    bool includes = (m_validatorStyle & wxFILTER_INCLUDE_LIST) != 0;
+    if ( includes || (m_validatorStyle & wxFILTER_EXCLUDE_LIST) )

     {
     {

-        if ( !m_includeList.Member(val) )
+        // if includes, it's only ok to have the members of the list,
+        // otherwise it's only ok to have non-members
+        ok = includes == (m_includes.Index(val) != wxNOT_FOUND);
+        if ( !ok )

         {
         {

-            ok = FALSE;
-        }
-    }
-    else if ( m_validatorStyle & wxFILTER_EXCLUDE_LIST )
-    {
-        if ( m_excludeList.Member(val) )
-        {
-            ok = FALSE;
+            errormsg = _("'%s' is invalid");

         }
     }
     else if ( (m_validatorStyle & wxFILTER_ASCII) && !val.IsAscii() )
     {
         }
     }
     else if ( (m_validatorStyle & wxFILTER_ASCII) && !val.IsAscii() )
     {

-        ok = FALSE;
+        ok = false;

 
         errormsg = _("'%s' should only contain ASCII characters.");
     }
     else if ( (m_validatorStyle & wxFILTER_ALPHA) && !wxIsAlpha(val) )
     {
 
         errormsg = _("'%s' should only contain ASCII characters.");
     }
     else if ( (m_validatorStyle & wxFILTER_ALPHA) && !wxIsAlpha(val) )
     {

-        ok = FALSE;
+        ok = false;

 
         errormsg = _("'%s' should only contain alphabetic characters.");
     }
     else if ( (m_validatorStyle & wxFILTER_ALPHANUMERIC) && !wxIsAlphaNumeric(val))
     {
 
         errormsg = _("'%s' should only contain alphabetic characters.");
     }
     else if ( (m_validatorStyle & wxFILTER_ALPHANUMERIC) && !wxIsAlphaNumeric(val))
     {

-        ok = FALSE;
+        ok = false;

 
         errormsg = _("'%s' should only contain alphabetic or numeric characters.");
     }
     else if ( (m_validatorStyle & wxFILTER_NUMERIC) && !wxIsNumeric(val))
     {
 
         errormsg = _("'%s' should only contain alphabetic or numeric characters.");
     }
     else if ( (m_validatorStyle & wxFILTER_NUMERIC) && !wxIsNumeric(val))
     {

-        ok = FALSE;
+        ok = false;

 
         errormsg = _("'%s' should be numeric.");
     }
 
         errormsg = _("'%s' should be numeric.");
     }

+    else if ( (m_validatorStyle & wxFILTER_INCLUDE_CHAR_LIST) && !IsInCharIncludes(val))
+    {
+        //it's only ok to have the members of the list
+        errormsg = _("'%s' is invalid");
+        ok = false;
+    }
+    else if ( (m_validatorStyle & wxFILTER_EXCLUDE_CHAR_LIST) && !IsNotInCharExcludes(val))
+    {
+        // it's only ok to have non-members of the list
+        errormsg = _("'%s' is invalid");
+        ok = false;
+    }

 
     if ( !ok )
     {
 
     if ( !ok )
     {

+        wxASSERT_MSG( !errormsg.empty(), _T("you forgot to set errormsg") );
+

         m_validatorWindow->SetFocus();
 
         wxString buf;
         m_validatorWindow->SetFocus();
 
         wxString buf;


@@ -197,69 +188,110 @@ bool wxTextValidator::Validate(wxWindow *parent)
 // Called to transfer data to the window
 bool wxTextValidator::TransferToWindow(void)
 {
 // Called to transfer data to the window
 bool wxTextValidator::TransferToWindow(void)
 {

-    if ( !m_validatorWindow )
-        return FALSE;
-    if ( !m_validatorWindow->IsKindOf(CLASSINFO(wxTextCtrl)) )
-        return FALSE;
-    if ( !m_stringValue )
-        return FALSE;
+    if( !CheckValidator() )
+        return false;

 
 

-    wxTextCtrl *control = (wxTextCtrl *) m_validatorWindow ;
-    control->SetValue(* m_stringValue) ;
+    if ( m_stringValue )
+    {
+        wxTextCtrl *control = (wxTextCtrl *) m_validatorWindow;
+        control->SetValue(* m_stringValue);
+    }

 
 

-    return TRUE;
+    return true;

 }
 
 // Called to transfer data to the window
 bool wxTextValidator::TransferFromWindow(void)
 {
 }
 
 // Called to transfer data to the window
 bool wxTextValidator::TransferFromWindow(void)
 {

-    if ( !m_validatorWindow )
-        return FALSE;
-    if ( !m_validatorWindow->IsKindOf(CLASSINFO(wxTextCtrl)) )
-        return FALSE;
-    if ( !m_stringValue )
-        return FALSE;
+    if( !CheckValidator() )
+        return false;

 
 

-    wxTextCtrl *control = (wxTextCtrl *) m_validatorWindow ;
-    * m_stringValue = control->GetValue() ;
+    if ( m_stringValue )
+    {
+        wxTextCtrl *control = (wxTextCtrl *) m_validatorWindow;
+        *m_stringValue = control->GetValue();
+    }

 
 

-    return TRUE;
+    return true;

 }
 
 }
 

-void wxTextValidator::SetIncludeList(const wxStringList& list)
+#if WXWIN_COMPATIBILITY_2_4
+
+inline void wxCopyStringListToArrayString(wxArrayString& to, const wxStringList& from)

 {
 {

-/*
-    if ( !M_VTEXTDATA )
-        return;
-*/
+    to.Clear();

 
 

-    m_includeList.Clear();
-    // TODO: replace with =
-    wxNode *node = list.First() ;
-    while ( node )
+    for ( wxStringList::compatibility_iterator pNode = from.GetFirst();
+          pNode;
+          pNode = pNode->GetNext() )

     {
     {

-        wxChar *s = (wxChar *)node->Data();
-        m_includeList.Add(s);
-        node = node->Next();
+        to.Add(pNode->GetData());

     }
 }
 
     }
 }
 

+inline void wxCopyArrayStringToStringList(wxStringList& to, const wxArrayString& from)
+{
+    to.Clear();
+
+    for(size_t i = 0; i < from.GetCount(); ++i)
+        to.Add(from[i]);
+}
+
+wxStringList& wxTextValidator::GetIncludeList()
+{
+    wxCopyArrayStringToStringList(m_includeList, m_includes);
+    return m_includeList;
+}
+
+wxStringList& wxTextValidator::GetExcludeList()
+{
+    wxCopyArrayStringToStringList(m_excludeList, m_excludes);
+    return m_excludeList;
+}
+
+void wxTextValidator::SetIncludeList(const wxStringList& list)
+{
+    wxCopyStringListToArrayString(m_includes, list);
+}
+

 void wxTextValidator::SetExcludeList(const wxStringList& list)
 {
 void wxTextValidator::SetExcludeList(const wxStringList& list)
 {

-/*
-    if ( !M_VTEXTDATA )
-        return;
-*/
+    wxCopyStringListToArrayString(m_excludes, list);
+}

 
 

-    m_excludeList.Clear();
-    // TODO: replace with =
-    wxNode *node = list.First() ;
-    while ( node )
+bool wxTextValidator::IsInCharIncludeList(const wxString& val)
+{
+    return IsInCharIncludes(val);
+}
+
+bool wxTextValidator::IsNotInCharExcludeList(const wxString& val)
+{
+    return IsNotInCharExcludes(val);
+}
+
+#endif //compat 2.4
+
+
+bool wxTextValidator::IsInCharIncludes(const wxString& val)
+{
+    size_t i;
+    for ( i = 0; i < val.Length(); i++)

     {
     {

-        wxChar *s = (wxChar *)node->Data();
-        m_excludeList.Add(s);
-        node = node->Next();
+        if (m_includes.Index((wxString) val[i]) == wxNOT_FOUND)
+            return false;

     }
     }

+    return true;
+}
+
+bool wxTextValidator::IsNotInCharExcludes(const wxString& val)
+{
+    size_t i;
+    for ( i = 0; i < val.Length(); i++)
+    {
+       if (m_excludes.Index((wxString) val[i]) != wxNOT_FOUND)
+            return false;
+    }
+    return true;

 }
 
 void wxTextValidator::OnChar(wxKeyEvent& event)
 }
 
 void wxTextValidator::OnChar(wxKeyEvent& event)


@@ -271,17 +303,19 @@ void wxTextValidator::OnChar(wxKeyEvent& event)
 
     if ( m_validatorWindow )
     {
 
     if ( m_validatorWindow )
     {

-        int keyCode = event.KeyCode();
+        int keyCode = event.GetKeyCode();

 
         // we don't filter special keys and Delete
         if (
              !(keyCode < WXK_SPACE || keyCode == WXK_DELETE || keyCode > WXK_START) &&
              (
 
         // we don't filter special keys and Delete
         if (
              !(keyCode < WXK_SPACE || keyCode == WXK_DELETE || keyCode > WXK_START) &&
              (

+              ((m_validatorStyle & wxFILTER_INCLUDE_CHAR_LIST) && !IsInCharIncludes(wxString((wxChar) keyCode, 1))) ||
+              ((m_validatorStyle & wxFILTER_EXCLUDE_CHAR_LIST) && !IsNotInCharExcludes(wxString((wxChar) keyCode, 1))) ||

               ((m_validatorStyle & wxFILTER_ASCII) && !isascii(keyCode)) ||
               ((m_validatorStyle & wxFILTER_ASCII) && !isascii(keyCode)) ||

-              ((m_validatorStyle & wxFILTER_ALPHA) && !isalpha(keyCode)) ||
-              ((m_validatorStyle & wxFILTER_ALPHANUMERIC) && !isalnum(keyCode)) ||
-              ((m_validatorStyle & wxFILTER_NUMERIC) && !isdigit(keyCode)
-                                && keyCode != '.' && keyCode != '-')
+              ((m_validatorStyle & wxFILTER_ALPHA) && !wxIsalpha(keyCode)) ||
+              ((m_validatorStyle & wxFILTER_ALPHANUMERIC) && !wxIsalnum(keyCode)) ||
+              ((m_validatorStyle & wxFILTER_NUMERIC) && !wxIsdigit(keyCode)
+                                && keyCode != '.' && keyCode != ',' && keyCode != '-')

              )
            )
         {
              )
            )
         {


@@ -301,13 +335,14 @@ static bool wxIsNumeric(const wxString& val)
     int i;
     for ( i = 0; i < (int)val.Length(); i++)
     {
     int i;
     for ( i = 0; i < (int)val.Length(); i++)
     {

-        if ((!isdigit(val[i])) && (val[i] != '.'))
-          if(!((i == 0) && (val[i] == '-')))
-            return FALSE;
+        // Allow for "," (French) as well as "." -- in future we should
+        // use wxSystemSettings or other to do better localisation
+        if ((!wxIsdigit(val[i])) && (val[i] != '.') && (val[i] != ',') && (val[i] != wxT('e')) && (val[i] != wxT('E')) && (val[i] != wxT('+')) && (val[i] != wxT('-')))
+            return false;

     }
     }

-    return TRUE;
+    return true;

 }
 
 }
 

+

 #endif
 #endif

-  // wxUSE_VALIDATORS
-  
\ No newline at end of file
+  // wxUSE_VALIDATORS && wxUSE_TEXTCTRL