vague comment about consume/ignore return values for listeners

NEW
Unassigned

Status

()

Core
Event Handling
--
trivial
17 years ago
9 years ago

People

(Reporter: Jesse Ruderman, Unassigned)

Tracking

Trunk
x86
Windows NT
Points:
---

Firefox Tracking Flags

(Not tracked)

Details

(URL)

(Reporter)

Description

17 years ago
Several comments say "returns whether the event was consumed or ignored".  
These comments should be more specific: what should implementers return to 
consume the event?  What should they return to ignore it?

(Also, a nearby comment mentions the non-existent nsIDOMEvent.h.)

Several of the files with the confusing comment:
- dom/public/coreEvents/nsIDOMFocusListener.h
- dom/public/coreEvents/nsIDOMMouseListener.h
- dom/public/coreEvents/nsIDOMKeyListener.h

Here's what the comment looks like:

/**
 * Processes a mouse down event
 * @param aMouseEvent @see nsIDOMEvent.h
 * @returns whether the event was consumed or ignored. @see nsresult
 */
NS_IMETHOD MouseDown(nsIDOMEvent* aMouseEvent) = 0;

Updated

17 years ago
Target Milestone: --- → mozilla0.9.8

Updated

17 years ago
Target Milestone: mozilla0.9.8 → mozilla0.9.9

Updated

17 years ago
Target Milestone: mozilla0.9.9 → mozilla1.0

Updated

17 years ago
Target Milestone: mozilla1.0 → mozilla1.1

Updated

16 years ago
QA Contact: madhur → rakeshmishra

Updated

16 years ago
QA Contact: rakeshmishra → trix

Comment 1

15 years ago
.
Assignee: joki → saari
QA Contact: trix → ian

Comment 2

15 years ago
retargeting
Target Milestone: mozilla1.1alpha → Future
(Reporter)

Updated

13 years ago
Assignee: saari → events
Target Milestone: Future → ---
Assignee: events → nobody
QA Contact: ian → events
You need to log in before you can comment on or make changes to this bug.