X-Git-Url: https://scm.cri.minesparis.psl.eu/git/ckeditor.git/blobdiff_plain/871bad8291b6dbc29d489d95d185458caab25158..14d450d78a2d67ec1decd64c928151851961dd36:/_source/core/eventInfo.js diff --git a/_source/core/eventInfo.js b/_source/core/eventInfo.js deleted file mode 100644 index 0f313e8..0000000 --- a/_source/core/eventInfo.js +++ /dev/null @@ -1,120 +0,0 @@ -/* -Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved. -For licensing, see LICENSE.html or http://ckeditor.com/license -*/ - -/** - * @fileOverview Defines the "virtual" {@link CKEDITOR.eventInfo} class, which - * contains the defintions of the event object passed to event listeners. - * This file is for documentation purposes only. - */ - -/** - * (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 - * @example - * // Do not do this. - * var myEvent = new CKEDITOR.eventInfo(); // Error: CKEDITOR.eventInfo is undefined - */ - -/** - * The event name. - * @name CKEDITOR.eventInfo.prototype.name - * @field - * @type String - * @example - * someObject.on( 'someEvent', function( event ) - * { - * alert( event.name ); // "someEvent" - * }); - * someObject.fire( 'someEvent' ); - */ - -/** - * The object that publishes (sends) the event. - * @name CKEDITOR.eventInfo.prototype.sender - * @field - * @type Object - * @example - * someObject.on( 'someEvent', function( event ) - * { - * alert( event.sender == someObject ); // "true" - * }); - * someObject.fire( 'someEvent' ); - */ - -/** - * The editor instance that holds the sender. May be the same as sender. May be - * null if the sender is not part of an editor instance, like a component - * running in standalone mode. - * @name CKEDITOR.eventInfo.prototype.editor - * @field - * @type CKEDITOR.editor - * @example - * myButton.on( 'someEvent', function( event ) - * { - * alert( event.editor == myEditor ); // "true" - * }); - * myButton.fire( 'someEvent', null, myEditor ); - */ - -/** - * Any kind of additional data. Its format and usage is event dependent. - * @name CKEDITOR.eventInfo.prototype.data - * @field - * @type Object - * @example - * someObject.on( 'someEvent', function( event ) - * { - * alert( event.data ); // "Example" - * }); - * someObject.fire( 'someEvent', 'Example' ); - */ - -/** - * Any extra data appended during the listener registration. - * @name CKEDITOR.eventInfo.prototype.listenerData - * @field - * @type Object - * @example - * someObject.on( 'someEvent', function( event ) - * { - * alert( event.listenerData ); // "Example" - * } - * , null, 'Example' ); - */ - -/** - * Indicates that no further listeners are to be called. - * @name CKEDITOR.eventInfo.prototype.stop - * @function - * @example - * someObject.on( 'someEvent', function( event ) - * { - * event.stop(); - * }); - * someObject.on( 'someEvent', function( event ) - * { - * // This one will not be called. - * }); - * alert( someObject.fire( 'someEvent' ) ); // "false" - */ - -/** - * Indicates that the event is to be cancelled (if cancelable). - * @name CKEDITOR.eventInfo.prototype.cancel - * @function - * @example - * someObject.on( 'someEvent', function( event ) - * { - * event.cancel(); - * }); - * someObject.on( 'someEvent', function( event ) - * { - * // This one will not be called. - * }); - * alert( someObject.fire( 'someEvent' ) ); // "true" - */