wxRuby Documentation Home

Wx::Validator

Validator is the base class for a family of validator classes that mediate between a class of control, and application data.

A validator has three major roles:

  1. to transfer data from a C++ variable or own storage to and from a control;
  2. to validate data in a control, and show an appropriate error message;
  3. to filter events (such as keystrokes), thereby changing the behaviour of the associated control.

Validators can be plugged into controls dynamically.

To specify a default, `null’ validator, use the symbol DefaultValidator.

For more information, please see Validator overview.

Derived from

EvtHandler

Object

See also

Validator overview, TextValidator, GenericValidator,

Methods

Validator.new

destructor()

Destructor.

Validator#clone

Object clone()

All validator classes must implement the Clone function, which returns an identical copy of itself. This is because validators are passed to control constructors as references which must be copied. Unlike objects such as pens and brushes, it does not make sense to have a reference counting scheme to do this cloning, because all validators should have separate data.

This base function returns NULL.

Validator#get_window

Window get_window()

Returns the window associated with the validator.

Validator#set_bell_on_error

set_bell_on_error(Boolean doIt = true)

This functions switches on or turns off the error sound produced by the validators if an invalid key is pressed.

Validator#set_window

set_window(Window window)

Associates a window with the validator.

Validator#transfer_from_window

Boolean transfer_to_window()

This overridable function is called when the value in the window must be transferred to the validator. Return false if there is a problem.

Validator#transfer_to_window

Boolean transfer_to_window()

This overridable function is called when the value associated with the validator must be transferred to the window. Return false if there is a problem.

Validator#validate

Boolean validate(Window parent)

This overridable function is called when the value in the associated window must be validated. Return false if the value in the window is not valid; you may pop up an error dialog.

[This page automatically generated from the Textile source at Thu May 01 00:50:47 +0100 2008]