REGEX_VALIDATOR Class Reference

Custom validator that checks verifies that a string exactly matches a regular expression. More...

#include <validators.h>

Inheritance diagram for REGEX_VALIDATOR:

Public Member Functions
	REGEX_VALIDATOR (const wxString &aRegEx, wxString *aValue=nullptr)
	REGEX_VALIDATOR (const wxString &aRegEx, int aFlags, wxString *aValue=nullptr)
	REGEX_VALIDATOR (const REGEX_VALIDATOR &aOther)
virtual wxObject *	Clone () const override
bool	Validate (wxWindow *aParent) override
const wxString &	GetRegEx () const

Protected Member Functions
void	compileRegEx (const wxString &aRegEx, int aFlags)
	< Compiles and stores a regular expression More...

Protected Attributes
wxString	m_regExString
	Original compilation flags (for copy constructor) More...
int	m_regExFlags
	Compiled regex. More...
wxRegEx	m_regEx

Detailed Description

Custom validator that checks verifies that a string exactly matches a regular expression.

Definition at line 116 of file validators.h.

Constructor & Destructor Documentation

REGEX_VALIDATOR() [1/3]

REGEX_VALIDATOR::REGEX_VALIDATOR ( const wxString &  aRegEx, wxString *  aValue = nullptr  )

inline

Parameters

aRegEx	is a regular expression to validate strings.
aValue	is a pointer to a wxString containing the value to validate.

Definition at line 123 of file validators.h.

 : wxTextValidator( wxFILTER_NONE, aValue )
 {
 compileRegEx( aRegEx, wxRE_DEFAULT );
 }

References compileRegEx().

Referenced by Clone().

REGEX_VALIDATOR() [2/3]

REGEX_VALIDATOR::REGEX_VALIDATOR ( const wxString &  aRegEx, int  aFlags, wxString *  aValue = nullptr  )

inline

Parameters

aRegEx	is a regular expression to validate strings.
aFlags	are compilation flags (normally wxRE_DEFAULT).
aValue	is a pointer to a wxString containing the value to validate.

Definition at line 134 of file validators.h.

 : wxTextValidator( wxFILTER_NONE, aValue )
 {
 compileRegEx( aRegEx, aFlags );
 }

References compileRegEx().

REGEX_VALIDATOR() [3/3]

REGEX_VALIDATOR::REGEX_VALIDATOR ( const REGEX_VALIDATOR &  aOther )

inline

Definition at line 140 of file validators.h.

 : wxTextValidator( aOther )
 {
 compileRegEx( aOther.m_regExString, aOther.m_regExFlags );
 }

References compileRegEx(), m_regExFlags, and m_regExString.

Member Function Documentation

Clone()

virtual wxObject * REGEX_VALIDATOR::Clone ( ) const

inlineoverridevirtual

Definition at line 145 of file validators.h.

 {
 return new REGEX_VALIDATOR( *this );
 }

References REGEX_VALIDATOR().

compileRegEx()

void REGEX_VALIDATOR::compileRegEx ( const wxString &  aRegEx, int  aFlags  )

protected

< Compiles and stores a regular expression

Original regular expression (for copy constructor)

Definition at line 258 of file validators.cpp.

{
 if( !m_regEx.Compile( aRegEx, aFlags ) )
 {
 throw std::runtime_error( "REGEX_VALIDATOR: Invalid regular expression: "
 + aRegEx.ToStdString() );
 }
 
 m_regExString = aRegEx;
 m_regExFlags = aFlags;
}

References m_regEx, m_regExFlags, and m_regExString.

Referenced by REGEX_VALIDATOR().

GetRegEx()

const wxString & REGEX_VALIDATOR::GetRegEx ( ) const

inline

Definition at line 152 of file validators.h.

 {
 return m_regExString;
 }

References m_regExString.

Validate()

bool REGEX_VALIDATOR::Validate ( wxWindow *  aParent )

override

Definition at line 220 of file validators.cpp.

{
 // If window is disabled, simply return
 if( !m_validatorWindow->IsEnabled() )
 return true;
 
 wxTextEntry* const textEntry = GetTextEntry();
 
 if( !textEntry )
 return false;
 
 bool valid = true;
 const wxString& value = textEntry->GetValue();
 
 if( m_regEx.Matches( value ) )
 {
 size_t start, len;
 m_regEx.GetMatch( &start, &len );
 
 if( start != 0 || len != value.Length() ) // whole string must match
 valid = false;
 }
 else // no match at all
 {
 valid = false;
 }
 
 if( !valid )
 {
 m_validatorWindow->SetFocus();
 DisplayError( aParent, wxString::Format( _( "Incorrect value: %s" ), value ) );
 return false;
 }
 
 return true;
}

References _, DisplayError(), Format(), and m_regEx.

Member Data Documentation

m_regEx

wxRegEx REGEX_VALIDATOR::m_regEx

protected

Definition at line 168 of file validators.h.

Referenced by compileRegEx(), and Validate().

m_regExFlags

int REGEX_VALIDATOR::m_regExFlags

protected

Compiled regex.

Definition at line 165 of file validators.h.

Referenced by compileRegEx(), and REGEX_VALIDATOR().

m_regExString

wxString REGEX_VALIDATOR::m_regExString

protected

Original compilation flags (for copy constructor)

Definition at line 162 of file validators.h.

Referenced by compileRegEx(), GetRegEx(), and REGEX_VALIDATOR().

---

The documentation for this class was generated from the following files:

• validators.h
• validators.cpp