wxRuby Documentation Home

Wx::NotifyEvent

This class is not used by the event handlers by itself, but is a base class for other event classes (such as NotebookEvent).

It (or an object of a derived class) is sent when the controls state is being changed and allows the program to Veto() this change if it wants to prevent it from happening.

Derived from

CommandEvent

Event

EvtHandler

Object

Event table macros

None

See also

NotebookEvent

Methods

NotifyEvent.new

NotifyEvent.new(EventType eventType = EVT_NULL,  Integer id = 0)

Constructor (used internally by Widgets only).

NotifyEvent#allow

allow()

This is the opposite of Veto(): it explicitly allows the event to be processed. For most events it is not necessary to call this method as the events are allowed anyhow but some are forbidden by default (this will be mentioned in the corresponding event description).

NotifyEvent#is_allowed

Boolean is_allowed()

Returns true if the change is allowed (Veto() hasn’t been called) or false otherwise (if it was).

NotifyEvent#veto

veto()

Prevents the change announced by this event from happening.

It is in general a good idea to notify the user about the reasons for vetoing the change because otherwise the applications behaviour (which just refuses to do what the user wants) might be quite surprising.

[This page automatically generated from the Textile source at Wed Sep 09 02:21:18 +0100 2009]