a few typo-fix and cosmetic changes to wxFlexGridSizer docs

[wxWidgets.git] / include / wx / valtext.h

/////////////////////////////////////////////////////////////////////////////
// Name:        valtext.h
// Purpose:     wxTextValidator class
// Author:      Julian Smart
// Modified by: Francesco Montorsi
// Created:     29/01/98
// RCS-ID:      $Id$
// Copyright:   (c) 1998 Julian Smart
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifndef _WX_VALTEXT_H_
#define _WX_VALTEXT_H_

#include "wx/defs.h"

#if wxUSE_VALIDATORS && (wxUSE_TEXTCTRL || wxUSE_COMBOBOX)

class WXDLLIMPEXP_FWD_CORE wxTextEntry;

#include "wx/validate.h"

enum wxTextValidatorStyle
{
    wxFILTER_NONE,
    wxFILTER_ASCII,
    wxFILTER_ALPHA,
    wxFILTER_ALPHANUMERIC,
    wxFILTER_NUMERIC,
    wxFILTER_INCLUDE_LIST,
    wxFILTER_EXCLUDE_LIST,
    wxFILTER_INCLUDE_CHAR_LIST,
    wxFILTER_EXCLUDE_CHAR_LIST
};

class WXDLLIMPEXP_CORE wxTextValidator: public wxValidator
{
public:
    wxTextValidator(wxTextValidatorStyle style = wxFILTER_NONE, wxString *val = NULL);
#if WXWIN_COMPATIBILITY_2_8
    wxDEPRECATED_CONSTRUCTOR( wxTextValidator(long style, wxString *val) );
#endif
    wxTextValidator(const wxTextValidator& val);

    virtual ~wxTextValidator(){}

    // Make a clone of this validator (or return NULL) - currently necessary
    // if you're passing a reference to a validator.
    // Another possibility is to always pass a pointer to a new validator
    // (so the calling code can use a copy constructor of the relevant class).
    virtual wxObject *Clone() const { return new wxTextValidator(*this); }
    bool Copy(const wxTextValidator& val);

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

    // Called to transfer data to the window
    virtual bool TransferToWindow();

    // Called to transfer data from the window
    virtual bool TransferFromWindow();

    // Filter keystrokes
    void OnChar(wxKeyEvent& event);

    // ACCESSORS
    inline wxTextValidatorStyle GetStyle() const { return m_validatorStyle; }
    inline void SetStyle(wxTextValidatorStyle style) { m_validatorStyle = style; }
#if WXWIN_COMPATIBILITY_2_8
    wxDEPRECATED( void SetStyle(long style) );
#endif

    wxTextEntry *GetTextEntry();

    void SetIncludes(const wxArrayString& includes) { m_includes = includes; }
    inline wxArrayString& GetIncludes() { return m_includes; }

    void SetExcludes(const wxArrayString& excludes) { m_excludes = excludes; }
    inline wxArrayString& GetExcludes() { return m_excludes; }

protected:

    // returns true if all characters of the given string are present in m_includes
    bool IsInCharIncludes(const wxString& val) const;

    // returns true if all characters of the given string are NOT present in m_excludes
    bool IsNotInCharExcludes(const wxString& val) const;

    // returns true if the contents of 'val' are valid for the current validation style
    bool IsValid(const wxString& val, wxString* errormsg) const;

protected:
    wxTextValidatorStyle m_validatorStyle;
    wxString *           m_stringValue;
    wxArrayString        m_includes;
    wxArrayString        m_excludes;

private:
    DECLARE_NO_ASSIGN_CLASS(wxTextValidator)
    DECLARE_DYNAMIC_CLASS(wxTextValidator)
    DECLARE_EVENT_TABLE()
};

#endif
  // wxUSE_VALIDATORS && (wxUSE_TEXTCTRL || wxUSE_COMBOBOX)

#endif // _WX_VALTEXT_H_