KiCad PCB EDA Suite
Loading...
Searching...
No Matches
ENV_VAR_NAME_VALIDATOR Class Reference

This class provides a custom wxValidator object for limiting the allowable characters when defining an environment variable name in a text edit control. More...

#include <validators.h>

Inheritance diagram for ENV_VAR_NAME_VALIDATOR:

Public Member Functions

 ENV_VAR_NAME_VALIDATOR (wxString *aValue=nullptr)
 
 ENV_VAR_NAME_VALIDATOR (const ENV_VAR_NAME_VALIDATOR &val)
 
virtual ~ENV_VAR_NAME_VALIDATOR ()
 
virtual wxObject * Clone () const override
 
void OnChar (wxKeyEvent &event)
 
void OnTextChanged (wxCommandEvent &event)
 

Detailed Description

This class provides a custom wxValidator object for limiting the allowable characters when defining an environment variable name in a text edit control.

Only uppercase, numbers, and underscore (_) characters are valid and the first character of the name cannot start with a number. This is according to IEEE Std 1003.1-2001. Even though most systems support other characters, these characters guarantee compatibility for all shells.

Definition at line 87 of file validators.h.

Constructor & Destructor Documentation

◆ ENV_VAR_NAME_VALIDATOR() [1/2]

ENV_VAR_NAME_VALIDATOR::ENV_VAR_NAME_VALIDATOR ( wxString *  aValue = nullptr)

Definition at line 80 of file validators.cpp.

References OnChar().

◆ ENV_VAR_NAME_VALIDATOR() [2/2]

ENV_VAR_NAME_VALIDATOR::ENV_VAR_NAME_VALIDATOR ( const ENV_VAR_NAME_VALIDATOR val)

Definition at line 87 of file validators.cpp.

References OnChar().

◆ ~ENV_VAR_NAME_VALIDATOR()

ENV_VAR_NAME_VALIDATOR::~ENV_VAR_NAME_VALIDATOR ( )
virtual

Definition at line 96 of file validators.cpp.

References OnChar().

Member Function Documentation

◆ Clone()

virtual wxObject * ENV_VAR_NAME_VALIDATOR::Clone ( ) const
inlineoverridevirtual

Definition at line 97 of file validators.h.

◆ OnChar()

void ENV_VAR_NAME_VALIDATOR::OnChar ( wxKeyEvent &  event)

Definition at line 102 of file validators.cpp.

References OnTextChanged().

Referenced by ENV_VAR_NAME_VALIDATOR(), and ~ENV_VAR_NAME_VALIDATOR().

◆ OnTextChanged()

void ENV_VAR_NAME_VALIDATOR::OnTextChanged ( wxCommandEvent &  event)

Definition at line 173 of file validators.cpp.

Referenced by OnChar().


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