X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;ds=inline;f=_source%2Fcore%2FeventInfo.js;h=2e38828fff7e01e5409986e2913ffb8ccdda12f5;hb=6e682412d5cc0dfaedb376482e585bf2989c6863;hp=7f534d71cb863039cb6d4f0c0246d85beb999283;hpb=ea7e3453c7b0f023b050aca6d9f83ab372860d91;p=ckeditor.git diff --git a/_source/core/eventInfo.js b/_source/core/eventInfo.js index 7f534d7..2e38828 100644 --- a/_source/core/eventInfo.js +++ b/_source/core/eventInfo.js @@ -1,5 +1,5 @@ /* -Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved. +Copyright (c) 2003-2012, CKSource - Frederico Knabben. All rights reserved. For licensing, see LICENSE.html or http://ckeditor.com/license */ @@ -10,11 +10,11 @@ For licensing, see LICENSE.html or http://ckeditor.com/license */ /** - * This class is not really part of the API. It just illustrates the features - * of the event object passed to event listeners by a {@link CKEDITOR.event} - * based object. + * (Virtual Class) Do not call this constructor. This class is not really part + * of the API. + * @class Virtual class that illustrates the features of the event object to be + * passed to event listeners by a {@link CKEDITOR.event} based object. * @name CKEDITOR.eventInfo - * @constructor * @example * // Do not do this. * var myEvent = new CKEDITOR.eventInfo(); // Error: CKEDITOR.eventInfo is undefined @@ -118,3 +118,15 @@ For licensing, see LICENSE.html or http://ckeditor.com/license * }); * alert( someObject.fire( 'someEvent' ) ); // "true" */ + +/** + * Removes the current listener. + * @name CKEDITOR.eventInfo.prototype.removeListener + * @function + * @example + * someObject.on( 'someEvent', function( event ) + * { + * event.removeListener(); + * // Now this function won't be called again by 'someEvent' + * }); + */