KiCad PCB EDA Suite
Loading...
Searching...
No Matches
validators.h File Reference

Custom text control validator definitions. More...

#include <memory>
#include <wx/valtext.h>
#include <wx/grid.h>
#include <wx/regex.h>
#include <lib_id.h>
#include <template_fieldnames.h>

Go to the source code of this file.

Classes

class  FOOTPRINT_NAME_VALIDATOR
 Provide a custom wxValidator object for limiting the allowable characters when defining footprint names. More...
 
class  ENV_VAR_NAME_VALIDATOR
 Provide a custom wxValidator object for limiting the allowable characters when defining an environment variable name in a text edit control. More...
 
class  NETNAME_VALIDATOR
 
class  FIELD_VALIDATOR
 A text control validator used for validating the text allowed in fields. More...
 

Namespaces

namespace  KIUI
 

Functions

void KIUI::ValidatorTransferToWindowWithoutEvents (wxValidator &aValidator)
 Call a text validator's TransferDataToWindow method without firing a text change event.
 
wxString GetFieldValidationErrorMessage (FIELD_T aFieldId, const wxString &aValue)
 Return the error message if aValue is invalid for aFieldId.
 

Detailed Description

Custom text control validator definitions.

Definition in file validators.h.

Function Documentation

◆ GetFieldValidationErrorMessage()

wxString GetFieldValidationErrorMessage ( FIELD_T aFieldId,
const wxString & aValue )

Return the error message if aValue is invalid for aFieldId.

Returns an empty string when the value is valid.

Definition at line 292 of file validators.cpp.

References _, DATASHEET, FOOTPRINT, UTIL::GetRefDesPrefix(), REFERENCE, SHEET_FILENAME, SHEET_NAME, and VALUE.

Referenced by FIELD_VALIDATOR::DoValidate(), and SCH_SHEET_DESC::SCH_SHEET_DESC().