OptionValidator Class Reference

Parameter must be one of the defined options. More...

#include <Validators.h>

Inheritance diagram for OptionValidator:

Collaboration diagram for OptionValidator:

Public Member Functions
void	AddOption (const wxString &option)
void	AddOptions (const wxArrayString &options)
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

Private Attributes
wxArrayString	mOptions

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 one of the defined options.

Definition at line 97 of file Validators.h.

Member Function Documentation

AddOption()

void OptionValidator::AddOption ( const wxString &  option )

inline

Definition at line 103 of file Validators.h.

   {
      mOptions.push_back(option);
   }

References mOptions.

AddOptions()

void OptionValidator::AddOptions ( const wxArrayString &  options )

inline

Definition at line 107 of file Validators.h.

   {
      mOptions.insert(mOptions.begin(), options.begin(), options.end());
   }

References mOptions.

GetClone()

Holder OptionValidator::GetClone ( ) const

inlineoverridevirtual

Implements Validator.

Definition at line 128 of file Validators.h.

   {
      auto v = std::make_unique<OptionValidator>();
      v->mOptions = mOptions;
      // This std::move is needed to "upcast" the pointer type
      return std::move(v);
   }

References mOptions.

GetDescription()

wxString OptionValidator::GetDescription ( ) const

inlineoverridevirtual

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

Reimplemented from Validator.

Definition at line 116 of file Validators.h.

   {
      wxString desc = wxT("one of: ");
      int optionCount = mOptions.size();
      int i = 0;
      for (i = 0; i+1 < optionCount; ++i)
      {
         desc += mOptions[i] + wxT(", ");
      }
      desc += mOptions[optionCount-1];
      return desc;
   }

References desc, mOptions, and wxT().

Here is the call graph for this function:

Validate()

bool OptionValidator::Validate ( const wxVariant &  v )

inlineoverridevirtual

Judge whether the passed value satisfies the Validator.

Reimplemented from Validator.

Definition at line 111 of file Validators.h.

   {
      SetConverted(v);
      return make_iterator_range( mOptions ).contains( v.GetString() );
   }

References make_iterator_range(), mOptions, and Validator::SetConverted().

Here is the call graph for this function:

Member Data Documentation

mOptions

wxArrayString OptionValidator::mOptions

private

Definition at line 100 of file Validators.h.

Referenced by AddOption(), AddOptions(), GetClone(), GetDescription(), and Validate().

---

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

• Validators.h