1 /*
  2 Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.
  3 For licensing, see LICENSE.html or http://ckeditor.com/license
  4 */
  5
  6 /**
  7  * @fileOverview Defines the "virtual" {@link CKEDITOR.commandDefinition} class,
  8  *		which contains the defintion of a command. This file is for
  9  *		documentation purposes only.
 10  */
 11
 12 /**
 13  * (Virtual Class) Do not call this constructor. This class is not really part
 14  *		of the API. It just illustrates the features of command objects to be
 15  *		passed to the {@link CKEDITOR.editor.prototype.addCommand} function.
 16  * @name CKEDITOR.commandDefinition
 17  * @constructor
 18  * @example
 19  */
 20
 21  /**
 22  * Executes the command.
 23  * @name CKEDITOR.commandDefinition.prototype.exec
 24  * @function
 25  * @param {CKEDITOR.editor} editor The editor within which run the command.
 26  * @param {Object} [data] Additional data to be used to execute the command.
 27  * @example
 28  * editorInstance.addCommand( 'sample',
 29  * {
 30  *     exec : function( editor )
 31  *     {
 32  *         alert( 'Executing a command for the editor name "' + editor.name + '"!' );
 33  *     }
 34  * });
 35  */
 36