Swift_Events_EventObject
in package
implements
Swift_Events_Event
A base Event which all Event classes inherit from.
Tags
Interfaces, Classes and Traits
- Swift_Events_Event
- The minimum interface for an Event.
Table of Contents
- $bubbleCancelled : mixed
- The state of this Event (should it bubble up the stack?)
- $source : mixed
- The source of this Event
- __construct() : mixed
- Create a new EventObject originating at $source.
- bubbleCancelled() : bool
- Returns true if this Event will not bubble any further up the stack.
- cancelBubble() : mixed
- Prevent this Event from bubbling any further up the stack.
- getSource() : object
- Get the source object of this event.
Properties
$bubbleCancelled
The state of this Event (should it bubble up the stack?)
private
mixed
$bubbleCancelled
= alse
$source
The source of this Event
private
mixed
$source
Methods
__construct()
Create a new EventObject originating at $source.
public
__construct(object $source) : mixed
Parameters
- $source : object
Return values
mixed —bubbleCancelled()
Returns true if this Event will not bubble any further up the stack.
public
bubbleCancelled() : bool
Return values
bool —cancelBubble()
Prevent this Event from bubbling any further up the stack.
public
cancelBubble([mixed $cancel = true ]) : mixed
Parameters
- $cancel : mixed = true
Return values
mixed —getSource()
Get the source object of this event.
public
getSource() : object