| blob | b3f33fecd03f8b88163f3b83a0aec901715e9f01 |
1 #-----------------------------------------------------------------
2 # Procedures to generate and display a help window in xcircuit
3 #-----------------------------------------------------------------
13 "Change justification of the currently selected or\
28 "When editing a label, split the label into two separate labels at\
39 "When editing a label, declare a tab stop at the current horizontal cursor\
40 position. This may be used to align text in multiple lines to certain\
43 "When editing a label, make text superscripted (about 2/3 size, and\
46 "When editing a label, make text subscripted (about 2/3 size, and\
49 "When editing a label, return from a subscript or superscript alignment\
52 "When editing a label, change the font at the cursor position to the\
53 next font family in the list. This will cycle through all of the\
56 "When editing a label, change the current font family to a boldface\
59 "When editing a label, change the current font family to an italic\
62 "When editing a label, change the current font family to a regular\
71 "When editing a label, append a linebreak to the label. This generates\
78 "When editing a label, insert a special character. This is a command\
79 that brings up the font encoding array, allowing the user to select\
82 "When editing a label, insert a parameter. The parameter must first\
83 exist in the current object. If only one parameter is defined, it\
84 will be inserted. If more than one parameter is defined, a selection\
85 box will appear, allowing the user to select which parameter to\
88 "When editing a polygon, parameterize the X and Y position of the\
89 currently edited point. The point may then be at a different\
92 "When editing a polygon, break the polygon into two pieces at\
95 "When editing a polygon, remove the currently edited point, and\
98 "When editing a polygon, insert a point at the same position as\
101 "When editing a polygon, append a point at the same position as\
102 the currently edited point, and move the currently edited point\
107 "When editing a polygon, select the nearest element that is not\
108 the polygon, and force the currently edited point to terminate\
109 on that element. The element to attach to may be a polygon, an\
110 arc, a spline, or a path. The edit point will continue to follow\
111 the cursor within the constraint that it must remain connected to\
114 "Create a virtual library instance of the currently selected\
115 object instance. This will duplicate the existing library entry\
116 but will have the scale and rotation of the selected instance,\
119 "When on a library page, go to the next defined library. The\
120 User Library is always last, and then the function cycles back\
125 "When on a library page, select the object under the cursor and\
126 any selected objects, and return to the originating page in\
129 "When on a library page, edit the name of an object by editing\
132 "When on a library page, remove the selected object from the\
133 library. An object can be removed only if there are no instances\
134 of that object on any page or in the hierarchy of another object.\
137 "When on a library page, create a duplicate object of the selected\
140 "When on a library page, remove the selected object from view but\
141 do not destroy it. An object can be hidden from view only if\
142 it exists in the hierarchy of another object (such as the arrow
145 "When on a library page, create a duplicate instance of the\
146 selected object. The duplicate instance may have different\
147 (instanced) parameters. Default parameters are defined by\
148 the master object. The name of the master object is printed\
149 in black, while the names of virtual instances are in gray.\
150 To define a virtual copy with different scale or rotation,\
153 "When on a library page, move the position of an object relative\
154 to other objects. If one object is selected, it will be moved\
155 to the position nearest the cursor. If two objects are selected,\
156 their positions will be swapped. If in the Page Directory, the\
167 "Scale and position the view of the current page so that elements\
168 on the page fill the window to the maximum extent possible (minus\
171 "Increase the magnification of the view of the current page in\
172 the window. The location of the page at the center point of the\
175 "Decrease the magnification of the view of the current page in\
176 the window. The location of the page at the center point of the\
179 "Change the view of the current page. There are various modes,\
180 including here, center, left, right, up, down, and follow. Pan\
181 center changes the view such that the point nearest\
182 the cursor becomes the center point of the window. Pan up, down,\
183 right, and left change the view by one-half page in the indicated\
190 "Display the Output Properties and File Write window. If output\
191 properties are changed but user does not want to write the file\
192 (such as when attaching multiple pages or schematics), use the\
193 Cancel button to accept all applied changes and pop down the\
196 "Rotate the selected elements, or element nearest the cursor, by\
197 the number of degrees in the argument. A positive number indicates\
198 a clockwise rotation, a negative number, a counterclockwise\
201 "Flip the selected elements, or element nearest the cursor, in the\
202 horizontal (X) direction (that is, across the Y axis). The axis\
203 defining the flip is the vertical line passing through the cursor X\
206 "Flip the selected elements, or element nearest the cursor, in the\
207 vertical (Y) direction (that is, across the X axis). The axis\
208 defining the flip is the horizontal line passing through the cursor\
211 "Snap the selected elements, or element nearest the cursor, to the\
212 nearest point on the snap grid. Each point of a polygon is snapped.\
213 Spline control points and arc centers are snapped. Label and object\
218 "Edit the object represented by the selected object instance, or the\
219 object instance closest to the cursor. The current page is pushed\
224 "Select the element or elements near the cursor. If multiple\
225 elements match the selection criteria, an interactive method is\
226 initiated in which individual elements may be selected or rejected\
229 "Begin drawing a box in the current default style. One corner of\
230 the box is anchored at the cursor position, and the other corner\
231 dragged with the cursor. The box is completed by pressing buttons\
234 "Begin drawing a circle in the current default style. The center\
235 of the circle is anchored at the cursor position, and the radius\
236 is defined by dragging the cursor to the desired position. Button\
237 2 completes the arc, and button 3 cancels it. Button 1 switches\
238 from defining the arc radius to (in sequence) defining the arc\
241 "Begin a normal text label. In text edit mode, all keystrokes are\
242 interpreted as input to the label, except for the key that is bound\
243 to action Text Return. Mouse buttons 1 and 2 complete the text\
246 "If two elements are selected, their relative positions (drawing\
247 order) are swapped (drawing order determines what objects obscure\
248 other objects when overlapping). If one element is selected, it\
249 is brought to the front of the drawing, unless it is already at\
252 "Make a copy of the selected elements or element closest to the\
253 cursor. Elements are dragged as a group with the cursor. Mouse\
254 button 1 places the copies, creates a new set of copies, and\
255 continues the copy operation. Mouse button 2 places the copies\
256 and ends the copy operation. Mouse button 3 removes the current\
259 "Move the selected elements or element nearest the cursor. This\
260 function is normally handled by the mouse button press, not the\
263 "Join selected elements into a single element. If all of the selected\
264 elements are polygons, the new element will be a single polygon. If\
265 the selected elements include a mixture of one or more types\
266 (polygons, arcs, splines, and paths), the resulting type will be a\
269 "Break the selected path or path nearest the cursor into its\
272 "Begin a bezier curve (inconsistently and, technically, incorrectly\
273 referred to in XCircuit documentation as a spline). The curve is\
274 anchored at the cursor position, and the other endpoint of the\
275 curve is dragged with the cursor. Mouse button 2 completes the\
276 curve. Mouse button 3 cancels (deletes) the curve. Mouse button\
279 "Edit the selected element or element nearest the cursor. The\
280 edit function applies to polygons, arcs, splines, paths, and\
281 labels, but not to object instances (editing the instance implies\
282 editing the object itself, which requires the Push function).\
283 Editing a label, arc, or spline is the same as creating it.\
284 Editing a polygon (including boxes and wires) allows individual\
285 points to be selected and moved. In all cases except labels,\
286 mouse button 1 moves to the next point, mouse button 2 completes\
291 "Perform again the last action which was undone with the Undo\
294 "Take all of the selected elements and turn them into a new\
295 object. The individual elements will be removed from the page\
296 and replaced with an instance of the newly defined object, and\
297 the object itself will be placed in the User Library. The\
300 "Remove the element closest to the cursor from the list of\
303 "Set the border style of the selected elements or element\
306 "Set the border style of the selected elements or element\
309 "Set the border style of the selected elements or element\
314 "Create a solder dot, connecting wires passing through it. The\
315 dot is placed at the current cursor position. If a library\
318 "Begin drawing a wire (or unclosed polygon). The wire is anchored\
319 at the cursor position, and the other end is dragged with the\
320 cursor. Mouse button 1 anchors the endpoint and starts a new\
321 wire segment. Mouse button 2 anchors the endpoint and completes\
326 "Exit the program immediately without prompting for action on\
329 "General-purpose start function, normally associated with mouse\
332 "General-purpose completion function, normally associated with mouse\
335 "General-purpose cancelation function, normally associated with mouse\
338 "Toggle the state of the snapping function. If on, points and element\
339 positions are always snapped to the snap grid. If off, points and\
344 "Switch between editing a schematic and its symbol. If the schematic\
345 covers multiple pages, will switch between the secondary page, primary\
348 "Create a local pin, a label that is interpreted as\
351 "Create a global pin, a label that is interpreted as\
352 belonging to the same network whereever it occurs on\
355 "Create an info label, a label that is not displayed\
356 except when editing the object, and which is parsed\
357 to extract information on how to output the device in\
360 "Highlight the connectivity of the electrical network\
361 that includes the selected item or that is closest\
364 "Generate a .sim (flat) netlist from the current page schematic,\
365 especially for use with the IRSIM simulator and the netgen and\
368 "Generate a .spc (hierarchical) netlist from the current page\
369 schematic. The format is compatible with Berkeley spice3 and\
372 "Generate a .pcbnet netlist from the current page schematic.\
375 "Generate a .fspc (flattened) SPICE netlist from the current\
378 }
379 }
381 #-----------------------------------------------------------------
382 # Procedure to generate the help window
383 #-----------------------------------------------------------------
387 wm withdraw .help
390 frame .help.listwin
418 }
420 #-----------------------------------------------------------------
421 # Procedure to update and display the help window
422 #-----------------------------------------------------------------
426 # Create the help window if it doesn't exist
429 }
431 .help.listwin.func delete 0 end
432 .help.listwin.keys delete 0 end
436 .help.listwin.func insert end "Function"
437 .help.listwin.keys insert end "Keys"
438 .help.listwin.func insert end ""
439 .help.listwin.keys insert end ""
445 }
447 wm deiconify .help
448 }
450 #-----------------------------------------------------------------