1 /* 2 * CKEditor - The text editor for Internet - http://ckeditor.com 3 * Copyright (C) 2003-2008 Frederico Caldeira Knabben 4 * 5 * == BEGIN LICENSE == 6 * 7 * Licensed under the terms of any of the following licenses at your 8 * choice: 9 * 10 * - GNU General Public License Version 2 or later (the "GPL") 11 * http://www.gnu.org/licenses/gpl.html 12 * 13 * - GNU Lesser General Public License Version 2.1 or later (the "LGPL") 14 * http://www.gnu.org/licenses/lgpl.html 15 * 16 * - Mozilla Public License Version 1.1 or later (the "MPL") 17 * http://www.mozilla.org/MPL/MPL-1.1.html 18 * 19 * == END LICENSE == 20 */ 21 22 /** 23 * @fileOverview Defines the "virtual" {@link CKEDITOR.commandDefinition} class, 24 * which contains the defintion of a command. This file is for 25 * documentation purposes only. 26 */ 27 28 /** 29 * (Virtual Class) Do not call this constructor. This class is not really part 30 * of the API. It just illustrates the features of command objects to be 31 * passed to the {@link CKEDITOR.editor.prototype.addCommand} function. 32 * @name CKEDITOR.commandDefinition 33 * @constructor 34 * @example 35 */ 36 37 /** 38 * Executes the command. 39 * @name CKEDITOR.commandDefinition.prototype.exec 40 * @function 41 * @param {CKEDITOR.editor} editor The editor within which run the command. 42 * @param {Object} [data] Additional data to be used to execute the command. 43 * @example 44 * editorInstance.addCommand( 'sample', 45 * { 46 * exec : function( editor ) 47 * { 48 * alert( 'Executing a command for the editor name "' + editor.name + '"!' ); 49 * } 50 * }); 51 */ 52