]>
Commit | Line | Data |
---|---|---|
1 | ******************************************************************************** | |
2 | ||
3 | XRCed README | |
4 | ||
5 | ******************************************************************************** | |
6 | ||
7 | Installation on UNIX | |
8 | -------------------- | |
9 | ||
10 | XRCed requires wxGTK and wxPython greater than 2.3.2, and Python 2.2 (it may | |
11 | work with earlier version, but was not tested). | |
12 | ||
13 | Of course wxGTK's XRC library (libwxxrc) must be installed. | |
14 | ||
15 | Installation on Windows | |
16 | ----------------------- | |
17 | ||
18 | Works with wxPython 2.3.2 for Python 2.2. | |
19 | ||
20 | Short manual | |
21 | ------------ | |
22 | ||
23 | XRCed's idea is very straightforward: it is a visual tool for editing an XML | |
24 | file conforming to XRC format. Every operation performed in XRCed has direct | |
25 | correspondence to XML structure. So it is not really a usual point-and-click | |
26 | GUI builder, but don't let that scare you. | |
27 | ||
28 | To start xrced, change to the directory where you installed it and run | |
29 | "python2.2 xrced.py". | |
30 | ||
31 | On UNIX you can edit wrapper script "xrced.sh" to point to your installation | |
32 | directory. | |
33 | ||
34 | To create an object, first you should select some object in the tree (or the | |
35 | root item if it's empty) then press the right mouse button and select an | |
36 | appropriate command. The pulldown menu is context-dependent on the selected | |
37 | object. | |
38 | ||
39 | XRCed tries to guess if new object should be added as a next sibling or a | |
40 | child of current object, depending on the possibility of the object to have | |
41 | child objects and expanded state (if tree item is collapsed, new object will | |
42 | be sibling). You can change this behavior to create siblings by pressing and | |
43 | holding the Shift and Control keys before clicking the mouse. | |
44 | ||
45 | Pressed Control key while pressing right button makes next item a sibling of | |
46 | selected item regardless of its expanded state. | |
47 | ||
48 | Pressed Shift key changes the place for inserting new child to be before | |
49 | selected child, not after as by default. | |
50 | ||
51 | Panel on the right contains object properties. Properties which are optional | |
52 | should be "checked" first. This panel can be made separate by unchecking | |
53 | "Embed Panel" in View menu. | |
54 | ||
55 | All properties can be edited as text, and some are supplied with special | |
56 | editing controls. | |
57 | ||
58 | The names of the properties are exactly as in XRC file, and it's usually not | |
59 | hard to guess what they do. XML ID is the name of the window, and must be | |
60 | present for top-level windows (though this is not enforced by XRCed). | |
61 | ||
62 | To display the preview window double-click a top-level object (you should | |
63 | assign an XMLID to it first), press "Test" toolbar button or select command | |
64 | from View menu, or press F5. After that, if you select a child object, it | |
65 | becomes highlighted, and if you change it, preview is updated when you select | |
66 | another item or press Ctrl-R (refresh). To turn off automatic update, toggle | |
67 | "View->Auto-refresh" or toolbar auto-refresh button (to the right of the | |
68 | refresh button). | |
69 | ||
70 | -------------------------------------------------------------------------------- | |
71 | ||
72 | Copyright 2001 Roman Rolinsky <rolinsky@mema.ucl.ac.be> |