This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English version of the page.

Note: This page has been translated by MathWorks. Click here to see
To view all translated materials including this page, select Country from the country navigator on the bottom of this page.

event.EventData class

Package: event
Superclasses: handle

Base class for event data

Description

The event.EventData class is the base class for all data objects passed to listeners. When you trigger an event using the notify handle class method, MATLAB® assigns values to the properties of an event.EventData object and passes that object to the listener callback function (the event handler).

To provide additional information to event listeners, subclass event.EventData. For more information on custom event data, see Define Event-Specific Data.

Note

Subclasses of event.EventData must set the class ConstructOnLoad attribute to true.

The event.EventData class is a handle class.

Class Attributes

ConstructOnLoad

true

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

The notify handle class method creates an event.EventData object when called to trigger an event. The event.EventData constructor accepts no input arguments so subclasses of event.EventData cannot pass arguments to the superclass constructor.

Properties

expand all

Event source object, specified as a handle to the object that triggered the event.

Attributes:

GetAccess

public

SetAccess

private

GetObservable

true

SetObservable

true

Name of the event, specified as a character vector.

Attributes:

GetAccess

public

SetAccess

private

GetObservable

true

SetObservable

true

Data Types: char

Examples

collapse all

Get the event source object handle and the event name from the event.EventData object passed to this callback function when the event is triggered.

function myCallbk(s,evtData)
   eventSource = evtData.Source;
   eventName = evtData.EventName;
   ...
end

Introduced in R2008a