Custom validator that verifies that a string defines a valid LIB_ID. More...

#include <validators.h>

Inheritance diagram for LIB_ID_VALIDATOR:

Public Member Functions
	LIB_ID_VALIDATOR (wxString *aValue=nullptr)

virtual wxObject *	Clone () const override

bool	Validate (wxWindow *aParent) override

Detailed Description

Custom validator that verifies that a string defines a valid LIB_ID.

The default validation allows empty LIB_ID strings to allow the LIB_ID to be cleared. Use SetStyle( wxFILTER_EMPTY ) to force a valid LIB_ID string.

Definition at line 172 of file validators.h.

Constructor & Destructor Documentation

◆ LIB_ID_VALIDATOR()

LIB_ID_VALIDATOR::LIB_ID_VALIDATOR ( wxString * aValue = nullptr )

inline

Parameters

aLibIdType	is the type of LIB_ID object to validate.
aValue	is a pointer to a wxString containing the value to validate.

Definition at line 179 of file validators.h.

  :
  wxTextValidator( wxFILTER_EXCLUDE_CHAR_LIST, aValue )
  {
  SetCharExcludes( wxT( "\r\n\t" ) );
  }

Referenced by Clone().

Member Function Documentation

◆ Clone()

virtual wxObject* LIB_ID_VALIDATOR::Clone ( ) const

inlineoverridevirtual

Definition at line 185 of file validators.h.

  {
  return new LIB_ID_VALIDATOR( *this );
  }

References LIB_ID_VALIDATOR().

◆ Validate()

bool LIB_ID_VALIDATOR::Validate ( wxWindow * aParent )

override

Definition at line 271 of file validators.cpp.

 {
  LIB_ID dummy;
 
  // If window is disabled, simply return
  if( !m_validatorWindow->IsEnabled() )
  return true;
 
  wxTextEntry* const text = GetTextEntry();
 
  if( !text )
  return false;
 
  wxString msg;
  wxString val( text->GetValue() );
  wxString tmp = val.Clone(); // For trailing and leading white space tests.
 
  // Allow empty string if empty filter not set to allow clearing the LIB_ID.
  if( !(GetStyle() & wxFILTER_EMPTY) && val.IsEmpty() )
  return true;
 
  if( tmp.Trim() != val ) // Trailing white space.
  {
  msg = _( "Entry contains trailing white space." );
  }
  else if( tmp.Trim( false ) != val ) // Leading white space.
  {
  msg = _( "Entry contains leading white space." );
  }
  else if( dummy.Parse( val ) != -1 || !dummy.IsValid() ) // Is valid LIB_ID.
  {
  msg.Printf( _( "'%s' is not a valid library identifier format." ), val );
  }
 
  if( !msg.empty() )
  {
  m_validatorWindow->SetFocus();
 
  wxMessageBox( msg, _( "Library Identifier Validation Error" ),
  wxOK | wxICON_EXCLAMATION, aParent );
 
  return false;
  }
 
  return true;
 }

References _, dummy(), and text.