events

Event names

Syntax

events(ClassName)

events(obj)

e = events(___)

Description

events(ClassName) displays the names of non-hidden events with public ListenAccess for the MATLAB^® class classname, including events inherited from superclasses.

events(obj) displays the names of the public events for the class of obj, where obj is an instance of a MATLAB class. obj can be a scalar object or an array of objects.

e = events(___) returns the event names in a cell array.

Examples

Get Event Names from Class Name

Get the names of the public events of the handle class and store the result in a cell array of character vectors.

eventNames = events('handle');

List Object Events

List the events defined by the containers.Map class from an instance of this class.

m = containers.Map('May',70);
events(m)

Events for class containers.Map:

    ObjectBeingDestroyed

Input Arguments

ClassName — Class name

character vector | string scalar

Class name, specified as a character vector or string.

Data Types: char | string

obj — Object

MATLAB object

MATLAB object specified as a scalar object or an object array.

Output Arguments

e — Event names

cell array

Event names contained in a cell array of character vectors.

More About

Public Events

An event is public when the value of its ListenAccess attribute is public and its Hidden attribute value is false (default values for both attributes). See Event Attributes for a complete list of attributes.

Events Keyword

events is also a MATLAB class-definition keyword. See classdef for more information on class definition keywords.

Extended Capabilities

Thread-Based Environment

Run code in the background using MATLAB® backgroundPool or accelerate code with Parallel Computing Toolbox™ ThreadPool.

The events function fully supports thread-based environments. For more information, see Run MATLAB Functions in Thread-Based Environment.

Version History

Introduced in R2008a