Changes between Version 15 and Version 16 of AttributeUsage


Ignore:
Timestamp:
Apr 20, 2012, 3:33:39 PM (9 years ago)
Author:
Michael Schäfer
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • AttributeUsage

    v15 v16  
    3333
    3434''' Parameters: '''
    35  1. string author: the authors name
    36  1. string email: the authors e-mail address
    37  1. string institute: the authors institute
    38  1. string url: an url to the authors web site
     35 1. string author: the author's name
     36 1. string email: the author's e-mail address
     37 1. string institute: the author's institute
     38 1. string url: an url to the author's web site
    3939
    4040''' Example: '''
     
    5454
    5555''' Parameters: '''
    56  1. ComponentCategory category: set the plugins category
     56 1. ComponentCategory category: set the plugin's category
    5757
    5858''' Example: '''
     
    7474== DontSaveAttribute == #DontSaveAttribute
    7575
    76 Used as flag to mark a plugins property so that it would not be saved in the workspace file.
     76Used as flag to mark a plugin's property so that it would not be saved in the workspace file.
    7777
    7878''' Useability: ''' Optional
     
    9696This attribute should be only used by editor plugins, like for example the workspace manager.
    9797
    98 Used to provide information about the editors abilities.
     98Used to provide information about the editor's abilities.
    9999
    100100''' Useability: ''' Insignificant
    101101
    102102''' Parameters: '''
    103  1. string defaultExtension: represents the editors default file extension
     103 1. string defaultExtension: represents the editor's default file extension
    104104 1. bool showAsNewButton: adds the editor to the "new"-button; default: true
    105105 1. bool showLogPanel: show the log panel; default: true
     
    152152 1. string resourceFile: the resource file - optional
    153153 1. string caption: general name of the method
    154  1. string toolTip: the tooltips text
     154 1. string toolTip: the tooltip's text
    155155 1. string descriptionUrl: URI to description, if provided
    156  1. params string[] icons: URIs to the plugins icons
     156 1. params string[] icons: URIs to the plugin's icons
    157157 
    158158''' Example: '''
     
    218218   * string backGroundColor: set the background color
    219219   * Orientation orientation: set the orientation
    220    * string widthCol1: Column width of column one. Is only used when no group is selected. Value samples: Auto, Auto or 1*, 2* Last sample indicates that column 1 wants to be given twice as much of the available space as the row marked with 1*.
     220   * string widthCol1: Column width of column one. Is only used when no group is selected. Value samples: Auto, Auto or 1*, 2*. Last sample indicates that column 1 wants to be given twice as much of the available space as the row marked with 1*.
    221221   * string widthCol2: Column width of column two. Is only used when no group is selected.
    222222   * string verticalGroup: group some properties
     
    247247''' Parameters: '''
    248248
    249  1. string caption: the settings tabs name
     249 1. string caption: the settings' tabs name
    250250 1. string address: the position in the settings tree
    251  1. double priority: A double that represents the settings tab priority. Tabs with higher priority will shown first. default: 0.5
     251 1. double priority: A double that represents the settings tab priority. Tabs with higher priority will be shown first. default: 0.5
    252252
    253253''' Example: '''
     
    294294
    295295 * mandatory
    296    1. string caption: parameters name
    297    1. string toolTip: parameters tooltip
    298    1. string groupName: parameters group
     296   1. string caption: parameter's name
     297   1. string toolTip: parameter's tooltip
     298   1. string groupName: parameter's group
    299299   1. int order: A number to change the order of the parameters in the same group. Parameters with a lower number are displayed first. Parameters with same number are alphabetically arranged.
    300300   1. bool changeableWhileExecuting: parameter is during the execution changable, if set to true
    301    1. ControlType controlType: parameters control type
     301   1. ControlType controlType: parameter's control type
    302302 
    303303 * optional
    304304   * params string[] controlValues: control values used to display in ComboBox
    305    * ValidationType validationType: possibility to validate the inputs type
     305   * ValidationType validationType: possibility to validate the input's type
    306306   * int integerMinValue: minimum value for instance for ControlType.NumericUpDown
    307307   * int integerMaxValue: maximum value for instance for ControlType.NumericUpDown