Audacity 3.2.0
Public Member Functions | List of all members
BoolValidator Class Referencefinal

Parameter must be a boolean. More...

#include <Validators.h>

Inheritance diagram for BoolValidator:
[legend]
Collaboration diagram for BoolValidator:
[legend]

Public Member Functions

bool Validate (const wxVariant &v) override
 Judge whether the passed value satisfies the Validator. More...
 
wxString GetDescription () const override
 
Holder GetClone () const override
 
- Public Member Functions inherited from Validator
 Validator ()
 
virtual ~Validator ()
 
void SetConverted (const wxVariant &v)
 
const wxVariant & GetConverted ()
 
virtual bool Validate (const wxVariant &v)
 Judge whether the passed value satisfies the Validator. More...
 
virtual wxString GetDescription () const
 
virtual Holder GetClone () const =0
 

Additional Inherited Members

- Public Types inherited from Validator
using Holder = std::unique_ptr< Validator >
 This MUST be overridden, to avoid slicing! More...
 

Detailed Description

Parameter must be a boolean.

Definition at line 138 of file Validators.h.

Member Function Documentation

◆ GetClone()

Holder BoolValidator::GetClone ( ) const
inlineoverridevirtual

Implements Validator.

Definition at line 152 of file Validators.h.

153 {
154 return std::make_unique<BoolValidator>();
155 }

◆ GetDescription()

wxString BoolValidator::GetDescription ( ) const
inlineoverridevirtual

Return a description (for error messages) should be of the form 'v must be $description'

Reimplemented from Validator.

Definition at line 148 of file Validators.h.

149 {
150 return wxT("true/false or 1/0 or yes/no");
151 }
wxT("CloseDown"))

References wxT().

Here is the call graph for this function:

◆ Validate()

bool BoolValidator::Validate ( const wxVariant &  v)
inlineoverridevirtual

Judge whether the passed value satisfies the Validator.

Reimplemented from Validator.

Definition at line 141 of file Validators.h.

142 {
143 bool val;
144 if (!v.Convert(&val)) return false;
145 SetConverted(val);
146 return GetConverted().IsType(wxT("bool"));
147 }
const wxVariant & GetConverted()
Definition: Validators.h:65
void SetConverted(const wxVariant &v)
Definition: Validators.h:61

References Validator::GetConverted(), Validator::SetConverted(), and wxT().

Here is the call graph for this function:

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