Don't generate wxEVT_CHAR_HOOK events while the mouse is captured.

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

diff --git a/src/common/valtext.cpp b/src/common/valtext.cpp
index 86211d84348ee9359e9680f674f7e522f32fcbbf..43c87eb446842040c0011db68a5d8f401c06d9e2 100644 (file)
--- a/src/common/valtext.cpp
+++ b/src/common/valtext.cpp
@@ -1,18 +1,14 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        valtext.cpp
+// Name:        src/common/valtext.cpp

 // Purpose:     wxTextValidator
 // Author:      Julian Smart
 // Purpose:     wxTextValidator
 // Author:      Julian Smart

-// Modified by:
+// Modified by: Francesco Montorsi

 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma implementation "valtext.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -20,44 +16,56 @@
   #pragma hdrstop
 #endif
 
   #pragma hdrstop
 #endif
 

-#if wxUSE_VALIDATORS && wxUSE_TEXTCTRL
+#if wxUSE_VALIDATORS && (wxUSE_TEXTCTRL || wxUSE_COMBOBOX)
+
+#include "wx/valtext.h"

 
 #ifndef WX_PRECOMP
   #include <stdio.h>
   #include "wx/textctrl.h"
 
 #ifndef WX_PRECOMP
   #include <stdio.h>
   #include "wx/textctrl.h"

+  #include "wx/combobox.h"

   #include "wx/utils.h"
   #include "wx/msgdlg.h"
   #include "wx/intl.h"
 #endif
 
   #include "wx/utils.h"
   #include "wx/msgdlg.h"
   #include "wx/intl.h"
 #endif
 

-#include "wx/valtext.h"
-

 #include <ctype.h>
 #include <string.h>
 #include <stdlib.h>
 
 #include <ctype.h>
 #include <string.h>
 #include <stdlib.h>
 

-#ifdef __SALFORDC__
-    #include <clib.h>
-#endif
+#include "wx/combo.h"

 
 

-IMPLEMENT_DYNAMIC_CLASS(wxTextValidator, wxValidator)
+// ----------------------------------------------------------------------------
+// global helpers
+// ----------------------------------------------------------------------------
+
+static bool wxIsNumeric(const wxString& val)
+{
+    for ( wxString::const_iterator i = val.begin(); i != val.end(); ++i )
+    {
+        // Allow for "," (French) as well as "." -- in future we should
+        // use wxSystemSettings or other to do better localisation
+        if ((!wxIsdigit(*i)) &&
+            (*i != wxS('.')) && (*i != wxS(',')) && (*i != wxS('e')) &&
+            (*i != wxS('E')) && (*i != wxS('+')) && (*i != wxS('-')))
+            return false;
+    }
+    return true;
+}
+
+// ----------------------------------------------------------------------------
+// wxTextValidator
+// ----------------------------------------------------------------------------

 
 

+IMPLEMENT_DYNAMIC_CLASS(wxTextValidator, wxValidator)

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

-static bool wxIsNumeric(const wxString& val);
-

 wxTextValidator::wxTextValidator(long style, wxString *val)
 {
 wxTextValidator::wxTextValidator(long style, wxString *val)
 {

-    m_validatorStyle = style;

     m_stringValue = val;
     m_stringValue = val;

-/*
-    m_refData = new wxVTextRefData;
-
-    M_VTEXTDATA->m_validatorStyle = style;
-    M_VTEXTDATA->m_stringValue = val;
-*/
+    SetStyle(style);

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


@@ -66,6 +74,30 @@ wxTextValidator::wxTextValidator(const wxTextValidator& val)
     Copy(val);
 }
 
     Copy(val);
 }
 

+void wxTextValidator::SetStyle(long style)
+{
+    m_validatorStyle = style;
+
+#if wxDEBUG_LEVEL
+    int check;
+    check = (int)HasFlag(wxFILTER_ALPHA) + (int)HasFlag(wxFILTER_ALPHANUMERIC) +
+            (int)HasFlag(wxFILTER_DIGITS) + (int)HasFlag(wxFILTER_NUMERIC);
+    wxASSERT_MSG(check <= 1,
+        "It makes sense to use only one of the wxFILTER_ALPHA/wxFILTER_ALPHANUMERIC/"
+        "wxFILTER_SIMPLE_NUMBER/wxFILTER_NUMERIC styles");
+
+    wxASSERT_MSG(((int)HasFlag(wxFILTER_INCLUDE_LIST) + (int)HasFlag(wxFILTER_INCLUDE_CHAR_LIST) <= 1) &&
+                 ((int)HasFlag(wxFILTER_EXCLUDE_LIST) + (int)HasFlag(wxFILTER_EXCLUDE_CHAR_LIST) <= 1),
+        "Using both wxFILTER_[IN|EX]CLUDE_LIST _and_ wxFILTER_[IN|EX]CLUDE_CHAR_LIST "
+        "doesn't work since wxTextValidator internally uses the same array for both");
+
+    check = (int)HasFlag(wxFILTER_INCLUDE_LIST) + (int)HasFlag(wxFILTER_INCLUDE_CHAR_LIST) +
+            (int)HasFlag(wxFILTER_EXCLUDE_LIST) + (int)HasFlag(wxFILTER_EXCLUDE_CHAR_LIST);
+    wxASSERT_MSG(check <= 1,
+        "Using both an include/exclude list may lead to unexpected results");
+#endif // wxDEBUG_LEVEL
+}
+

 bool wxTextValidator::Copy(const wxTextValidator& val)
 {
     wxValidator::Copy(val);
 bool wxTextValidator::Copy(const wxTextValidator& val)
 {
     wxValidator::Copy(val);


@@ -79,266 +111,225 @@ bool wxTextValidator::Copy(const wxTextValidator& val)
     return true;
 }
 
     return true;
 }
 

-static bool wxIsAlpha(const wxString& val)
+wxTextEntry *wxTextValidator::GetTextEntry()

 {
 {

-    int i;
-    for ( i = 0; i < (int)val.Length(); i++)
+#if wxUSE_TEXTCTRL
+    if (m_validatorWindow->IsKindOf(CLASSINFO(wxTextCtrl)))

     {
     {

-        if (!wxIsalpha(val[i]))
-            return false;
+        return (wxTextCtrl*)m_validatorWindow;

     }
     }

-    return true;
-}
+#endif

 
 

-static bool wxIsAlphaNumeric(const wxString& val)
-{
-    int i;
-    for ( i = 0; i < (int)val.Length(); i++)
+#if wxUSE_COMBOBOX
+    if (m_validatorWindow->IsKindOf(CLASSINFO(wxComboBox)))

     {
     {

-        if (!wxIsalnum(val[i]))
-            return false;
+        return (wxComboBox*)m_validatorWindow;

     }
     }

-    return true;
+#endif
+
+#if wxUSE_COMBOCTRL
+    if (m_validatorWindow->IsKindOf(CLASSINFO(wxComboCtrl)))
+    {
+        return (wxComboCtrl*)m_validatorWindow;
+    }
+#endif
+
+    wxFAIL_MSG(
+        "wxTextValidator can only be used with wxTextCtrl, wxComboBox, "
+        "or wxComboCtrl"
+    );
+
+    return NULL;

 }
 
 // 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( !CheckValidator() )
-        return false;
-
-    wxTextCtrl *control = (wxTextCtrl *) m_validatorWindow;
-

     // If window is disabled, simply return
     // If window is disabled, simply return

-    if ( !control->IsEnabled() )
+    if ( !m_validatorWindow->IsEnabled() )

         return true;
 
         return true;
 

-    wxString val(control->GetValue());
+    wxTextEntry * const text = GetTextEntry();
+    if ( !text )
+        return false;

 
 

-    bool ok = true;
+    wxString val(text->GetValue());

 
 

-    // NB: this format string should contian exactly one '%s'

     wxString errormsg;
     wxString errormsg;

-
-    bool includes = (m_validatorStyle & wxFILTER_INCLUDE_LIST) != 0;
-    if ( includes || (m_validatorStyle & wxFILTER_EXCLUDE_LIST) )
+    if ( HasFlag(wxFILTER_EMPTY) && val.empty() )

     {
     {

-        // 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 )
-        {
-            errormsg = _("'%s' is invalid");
-        }
+        errormsg = _("Required information entry is empty.");

     }
     }

-    else if ( (m_validatorStyle & wxFILTER_ASCII) && !val.IsAscii() )
+    else if ( !(errormsg = IsValid(val)).empty() )

     {
     {

-        ok = false;
-
-        errormsg = _("'%s' should only contain ASCII characters.");
+        // NB: this format string should always contain exactly one '%s'
+        wxString buf;
+        buf.Printf(errormsg, val.c_str());
+        errormsg = buf;

     }
     }

-    else if ( (m_validatorStyle & wxFILTER_ALPHA) && !wxIsAlpha(val) )
-    {
-        ok = false;

 
 

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

     {
     {

-        ok = false;
+        m_validatorWindow->SetFocus();
+        wxMessageBox(errormsg, _("Validation conflict"),
+                     wxOK | wxICON_EXCLAMATION, parent);

 
 

-        errormsg = _("'%s' should only contain alphabetic or numeric characters.");
+        return false;

     }
     }

-    else if ( (m_validatorStyle & wxFILTER_NUMERIC) && !wxIsNumeric(val))
-    {
-        ok = false;

 
 

-        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;
-    }
+    return true;
+}

 
 

-    if ( !ok )
+// Called to transfer data to the window
+bool wxTextValidator::TransferToWindow()
+{
+    if ( m_stringValue )

     {
     {

-        wxASSERT_MSG( !errormsg.empty(), _T("you forgot to set errormsg") );
-
-        m_validatorWindow->SetFocus();
-
-        wxString buf;
-        buf.Printf(errormsg, val.c_str());
+        wxTextEntry * const text = GetTextEntry();
+        if ( !text )
+            return false;

 
 

-        wxMessageBox(buf, _("Validation conflict"),
-                     wxOK | wxICON_EXCLAMATION, parent);
+        text->SetValue(*m_stringValue);

     }
 
     }
 

-    return ok;
+    return true;

 }
 
 // Called to transfer data to the window
 }
 
 // Called to transfer data to the window

-bool wxTextValidator::TransferToWindow(void)
+bool wxTextValidator::TransferFromWindow()

 {
 {

-    if( !CheckValidator() )
-        return false;
-

     if ( m_stringValue )
     {
     if ( m_stringValue )
     {

-        wxTextCtrl *control = (wxTextCtrl *) m_validatorWindow;
-        control->SetValue(* m_stringValue);
+        wxTextEntry * const text = GetTextEntry();
+        if ( !text )
+            return false;
+
+        *m_stringValue = text->GetValue();

     }
 
     return true;
 }
 
     }
 
     return true;
 }
 

-// Called to transfer data to the window
-bool wxTextValidator::TransferFromWindow(void)
+// IRIX mipsPro refuses to compile wxStringCheck<func>() if func is inline so
+// let's work around this by using this non-template function instead of
+// wxStringCheck(). And while this might be fractionally less efficient because
+// the function call won't be inlined like this, we don't care enough about
+// this to add extra #ifs for non-IRIX case.
+namespace

 {
 {

-    if( !CheckValidator() )
-        return false;

 
 

-    if ( m_stringValue )
+bool CheckString(bool (*func)(const wxUniChar&), const wxString& str)
+{
+    for ( wxString::const_iterator i = str.begin(); i != str.end(); ++i )

     {
     {

-        wxTextCtrl *control = (wxTextCtrl *) m_validatorWindow;
-        *m_stringValue = control->GetValue();
+        if ( !func(*i) )
+            return false;

     }
 
     return true;
 }
 
     }
 
     return true;
 }
 

-#if WXWIN_COMPATIBILITY_2_4
+} // anonymous namespace

 
 

-inline void wxCopyStringListToArrayString(wxArrayString& to, const wxStringList& from)
+wxString wxTextValidator::IsValid(const wxString& val) const

 {
 {

-    to.Clear();
-
-    for(wxStringList::Node* pNode = from.GetFirst(); pNode; pNode = pNode->GetNext())
-        to.Add(pNode->GetData());
+    // wxFILTER_EMPTY is checked for in wxTextValidator::Validate
+
+    if ( HasFlag(wxFILTER_ASCII) && !val.IsAscii() )
+        return _("'%s' should only contain ASCII characters.");
+    if ( HasFlag(wxFILTER_ALPHA) && !CheckString(wxIsalpha, val) )
+        return _("'%s' should only contain alphabetic characters.");
+    if ( HasFlag(wxFILTER_ALPHANUMERIC) && !CheckString(wxIsalnum, val) )
+        return _("'%s' should only contain alphabetic or numeric characters.");
+    if ( HasFlag(wxFILTER_DIGITS) && !CheckString(wxIsdigit, val) )
+        return _("'%s' should only contain digits.");
+    if ( HasFlag(wxFILTER_NUMERIC) && !wxIsNumeric(val) )
+        return _("'%s' should be numeric.");
+    if ( HasFlag(wxFILTER_INCLUDE_LIST) && m_includes.Index(val) == wxNOT_FOUND )
+        return _("'%s' is invalid");
+    if ( HasFlag(wxFILTER_INCLUDE_CHAR_LIST) && !ContainsOnlyIncludedCharacters(val) )
+        return _("'%s' is invalid");
+    if ( HasFlag(wxFILTER_EXCLUDE_LIST) && m_excludes.Index(val) != wxNOT_FOUND )
+        return _("'%s' is invalid");
+    if ( HasFlag(wxFILTER_EXCLUDE_CHAR_LIST) && ContainsExcludedCharacters(val) )
+        return _("'%s' is invalid");
+
+    return wxEmptyString;

 }
 
 }
 

-inline void wxCopyArrayStringToStringList(wxStringList& to, const wxArrayString& from)
+bool wxTextValidator::ContainsOnlyIncludedCharacters(const wxString& val) const

 {
 {

-    to.Clear();
+    for ( wxString::const_iterator i = val.begin(); i != val.end(); ++i )
+        if (m_includes.Index((wxString) *i) == wxNOT_FOUND)
+            // one character of 'val' is NOT present in m_includes...
+            return false;

 
 

-    for(size_t i = 0; i < from.GetCount(); ++i)
-        to.Add(from[i]);
+    // all characters of 'val' are present in m_includes
+    return true;

 }
 
 }
 

-wxStringList& wxTextValidator::GetIncludeList()
+bool wxTextValidator::ContainsExcludedCharacters(const wxString& val) const

 {
 {

-    wxCopyArrayStringToStringList(m_includeList, m_includes);
-    return m_includeList;
-}
+    for ( wxString::const_iterator i = val.begin(); i != val.end(); ++i )
+        if (m_excludes.Index((wxString) *i) != wxNOT_FOUND)
+            // one character of 'val' is present in m_excludes...
+            return true;

 
 

-wxStringList& wxTextValidator::GetExcludeList()
-{
-    wxCopyArrayStringToStringList(m_excludeList, m_excludes);
-    return m_excludeList;
+    // all characters of 'val' are NOT present in m_excludes
+    return false;

 }
 
 }
 

-void wxTextValidator::SetIncludeList(const wxStringList& list)
+void wxTextValidator::SetCharIncludes(const wxString& chars)

 {
 {

-    wxCopyStringListToArrayString(m_includes, list);
-}
+    wxArrayString arr;

 
 

-void wxTextValidator::SetExcludeList(const wxStringList& list)
-{
-    wxCopyStringListToArrayString(m_excludes, list);
-}
+    for ( wxString::const_iterator i = chars.begin(); i != chars.end(); ++i )
+        arr.Add(*i);

 
 

-bool wxTextValidator::IsInCharIncludeList(const wxString& val)
-{
-    return IsInCharIncludes(val);
+    SetIncludes(arr);

 }
 
 }
 

-bool wxTextValidator::IsNotInCharExcludeList(const wxString& val)
+void wxTextValidator::SetCharExcludes(const wxString& chars)

 {
 {

-    return IsNotInCharExcludes(val);
-}
+    wxArrayString arr;

 
 

-#endif //compat 2.4
+    for ( wxString::const_iterator i = chars.begin(); i != chars.end(); ++i )
+        arr.Add(*i);

 
 

-
-bool wxTextValidator::IsInCharIncludes(const wxString& val)
-{
-    size_t i;
-    for ( i = 0; i < val.Length(); i++)
-    {
-        if (m_includes.Index((wxString) val[i]) == wxNOT_FOUND)
-            return false;
-    }
-    return true;
+    SetExcludes(arr);

 }
 
 }
 

-bool wxTextValidator::IsNotInCharExcludes(const wxString& val)
+void wxTextValidator::OnChar(wxKeyEvent& event)

 {
 {

-    size_t i;
-    for ( i = 0; i < val.Length(); i++)
+    if (!m_validatorWindow)

     {
     {

-       if (m_excludes.Index((wxString) val[i]) != wxNOT_FOUND)
-            return false;
+        event.Skip();
+        return;

     }
     }

-    return true;
-}

 
 

-void wxTextValidator::OnChar(wxKeyEvent& event)
-{
-/*
-    if ( !M_VTEXTDATA )
-        return;
-*/
+    int keyCode = event.GetKeyCode();

 
 

-    if ( m_validatorWindow )
+    // we don't filter special keys and delete
+    if (keyCode < WXK_SPACE || keyCode == WXK_DELETE || keyCode >= WXK_START)

     {
     {

-        int keyCode = event.GetKeyCode();
-
-        // 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_ALPHA) && !wxIsalpha(keyCode)) ||
-              ((m_validatorStyle & wxFILTER_ALPHANUMERIC) && !wxIsalnum(keyCode)) ||
-              ((m_validatorStyle & wxFILTER_NUMERIC) && !wxIsdigit(keyCode)
-                                && keyCode != '.' && keyCode != ',' && keyCode != '-')
-             )
-           )
-        {
-            if ( !wxValidator::IsSilent() )
-                wxBell();
-
-            // eat message
-            return;
-        }
+        event.Skip();
+        return;

     }
 
     }
 

-    event.Skip();
-}
-
-static bool wxIsNumeric(const wxString& val)
-{
-    int i;
-    for ( i = 0; i < (int)val.Length(); i++)
+    wxString str((wxUniChar)keyCode, 1);
+    if (!IsValid(str).empty())

     {
     {

-        // 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;
+        if ( !wxValidator::IsSilent() )
+            wxBell();
+
+        // eat message
+        return;

     }
     }

-    return true;
+    else
+        event.Skip();

 }
 
 
 #endif
 }
 
 
 #endif

-  // wxUSE_VALIDATORS && wxUSE_TEXTCTRL
+  // wxUSE_VALIDATORS && (wxUSE_TEXTCTRL || wxUSE_COMBOBOX)