1Summary of function 2=================== 3 4This tool is used to edit various initial settings/preferences for various 5parameters of tkeclipse. The new settings can be applied to the current 6session, or saved as the user defined defaults for future sessions of 7tkeclipse. 8 9Layout 10====== 11 12Parameters editors 13------------------ 14 15The window is divided into sections, each for which is for one 16parameter. The left side shows the parameter name, and the right side 17allows the value of the parameter to be edited. 18 19Button bar 20---------- 21 22"Apply Preferences" button -- apply the settings in the parameter 23 editors to the current session of tkeclipse. 24 25"Save Preferences" button -- save the settings in the parameter editors so 26 that future sessions of tkeclipse will use those values. 27 28"Close" -- close the Preference Editor 29 30Functionality 31============= 32 33The user can specify various initial default preferences for the tkeclipse 34development tools and toplevel, which will override the predefined 35defaults. This tool provides an interface to allow these parameters to be 36changed. The preferences can then be applied immediately to the current 37session, or be saved as the defaults for future sessions of tkeclipse. 38 39If the tkeclipse tools are used with tkeclipse toplevel, then the 40preferences for the toplevel will be available for editing through this 41tool as well. 42 43When the editor is invoked, the initial values for the parameters are the 44current settings for these parameters. 45 46The preference values can be changed via the tool. The changes will only be 47saved if the "Save Preferences" button is clicked. Otherwise, the changes 48will not be recorded when the tool is closed or destroyed. The changes 49can also be applied immediately by clicking on the "Apply Preferences" 50button. Note however that not all preferences will lead to immediate 51changes, as some preferences can only apply at start-up. 52 53On saving the values, all the parameters will be saved, unless its entry is 54left blank. In this case, the value will not be saved, and the default 55value restored. On applying the preferences, any blank entries will not be 56applied (the setting will be left at its current value). 57 58Preference Parameters 59===================== 60 61The Preference editor provides an interface to changing the preferences, 62but it is also possible to directly change them without using the 63editor. See the toplevel help file for a more detailed description of this. 64 65Note that on Unix, the defaults file will be saved into the current working 66directory if the defaults file already exist there. Otherwise it is saved 67into the user's home directory. Any old version of the file will be 68overwritten. 69 70Description of parameters 71------------------------- 72 73See the toplevel help file for a description of the toplevel parameters. 74 75Development tools: 76------------------ 77 78balloonhelp 0 or 1 Initial state for balloonhelp. 0 79 for off initially, 1 for on 80 initially. Default is 0. 81 82defaultextension string The extension (e.g. ".ecl") that 83 will be added to the names of 84 files when using the file browser 85 if no extension was 86 specified. Default is .ecl 87 88dgf_spiedonly 0 or 1 Initial state for the "spied only" 89 setting of the delay goals tool. 1 90 for on initially, 0 for off 91 initially. Default is 0. 92 93dgf_tracedonly 0 or 1 Initial state for the "trace only" 94 setting of the delay goals tool. 1 95 for on initially, 0 for off 96 initially. Default is 1. 97 98dgf_wakeonly 0 or 1 Initial state for the "scheduled only" 99 setting of the delay goals tool. 1 100 for on initially, 0 for off 101 initially. Default is 0. 102 103editor string The command that will be invoked 104 by tkeclipse to start an editor 105 when the user selects the edit 106 function from tkeclipse. The selected 107 file name will be appended to the 108 command. By default on Unix, the 109 editor specified in the VISUAL or 110 EDITOR environment variables is 111 started with a xterm. On Window, 112 wordpad is started. 113 114edit_line_option string The command line option to use with 115 the editor command which specifies 116 the line in the file the editor should 117 start at. For some common editors 118 where this option is known, it will 119 be set depending on the editor 120 parameter. If the option needs a space 121 between the option and the line number, 122 it should be included here. 123 124inspect_prdepth +ve integer The initial print depth that the 125 inspector will used. Default is 5. 126 127inspect_ldepth +ve integer The threshold for special 128 treatment of lists and printing 129 arg. number for 130 structures. Default is 20. 131 132inspect_nosymbols 0 or 1 If type symbols icons will 133 initially appear with the 134 inspector. 1 for no symbols, 0 for 135 symbols. Default is 1. 136 137monofont_family string A Tk font family name. This gives 138 the default font family that will 139 be used by development tools in 140 places where a mono-spaced font 141 would be expected, e.g. text 142 windows. Defaults to a platform 143 specific monospace font family 144 145monofont_size +ve integer The size in points for the default 146 mono-spaced font used by the 147 development tools. Defaults to the 148 Tk default font size for the 149 user setup. 150 151labelfont_family string A Tk font family name. This is the 152 default font family that will be 153 used by the development tools in 154 places where the mono-spaced font 155 is not used, e.g. for 156 labels. Defaults to the Helvetica 157 family with weight bold. 158 159labelfont_size +ve integer The size in points for the default 160 labelfont used by the development 161 tools. Defaults to the Tk default 162 font size for the user setup. 163 164background_colour string The default background colour for 165 the development tools' windows. 166 Defaults to the Tk default 167 background colour. 168 169stats_interval +ve decimal The time interval at which the 170 or integer statistics tool will update. Units 171 is seconds, and the default is 1. 172 173text_truncate +ve integer The threshold at which a line of 174 text would be considered for 175 truncation when printed on the 176 various tracer, inspector and 177 delay goal windows. The toplevel 178 Output window is also controlled 179 by this threshold. Units are 180 characters, and the default is 181 2000. Tk text windows can only 182 cope correctly with lines that are 183 not too long, and setting this 184 value too high may cause tkeclipse 185 to crash or otherwise behave 186 incorrectly. Truncation is 187 indicated by `...' at the end of 188 the printed line. 189 190 191 192trace_refresh_dg 0 or 1 The initial state of the `refresh 193 delay goals at every trace line' 194 option for the tracer. 1 is on, 0 195 is off. Default is 1. 196 197tracer_prdepth +ve integer The initial print depth used by 198 the tracer. Default is 5. 199 200 201 202Known Problem 203============= 204 205There seems to be a bug with the version of Tcl/Tk used with tkeclipse in 206that a font size of 12 points cannot be specified. The default font size is 207usually 12 points, but if 12 points is explicitly specified, the actual 208font sized used seems to be 13 points. Leave these entries blank to ensure 209that the Tk built-in default is used. 210 211 212 213 214 215