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