]> git.saurik.com Git - wxWidgets.git/blame - wxPython/wx/tools/XRCed/README.txt
Respect the REUSEADDR flag to allow rebinding; bind to local port prior to connecting...
[wxWidgets.git] / wxPython / wx / tools / XRCed / README.txt
CommitLineData
09f3d4e6
RD
1********************************************************************************
2
3 XRCed README
4
5********************************************************************************
6
8b9a4190
RD
7System requirements
8-------------------
09f3d4e6 9
306b6fe9
RR
10wxPython version must be recent enough to support all features (a warning
11message is shown if not).
09f3d4e6 12
306b6fe9
RR
13
14User requirements
15-----------------
16
17To use XRCed it is really important to be familiar with wxWindows class names
18and at least partially with XRC resource format (read
19wxWindows/doc/tech/tn0014.txt for reference).
09f3d4e6 20
09f3d4e6
RD
21
22Short manual
23------------
24
f0c20d94
RD
25XRCed's idea is very straightforward: it is a visual tool for editing an XML
26file conforming to XRC format. Every operation performed in XRCed has direct
27correspondence to XML structure. So it is not really a usual point-and-click
28GUI builder, but don't let that scare you.
29
09f3d4e6 30To start xrced, change to the directory where you installed it and run
f0c20d94
RD
31"python2.2 xrced.py".
32
33On UNIX you can edit wrapper script "xrced.sh" to point to your installation
34directory.
09f3d4e6
RD
35
36To create an object, first you should select some object in the tree (or the
f0c20d94
RD
37root item if it's empty) then press the right mouse button and select an
38appropriate command. The pulldown menu is context-dependent on the selected
39object.
09f3d4e6
RD
40
41XRCed tries to guess if new object should be added as a next sibling or a
42child of current object, depending on the possibility of the object to have
43child objects and expanded state (if tree item is collapsed, new object will
44be sibling). You can change this behavior to create siblings by pressing and
f0c20d94
RD
45holding the Shift and Control keys before clicking the mouse.
46
47Pressed Control key while pressing right button makes next item a sibling of
48selected item regardless of its expanded state.
09f3d4e6 49
f0c20d94
RD
50Pressed Shift key changes the place for inserting new child to be before
51selected child, not after as by default.
09f3d4e6
RD
52
53Panel on the right contains object properties. Properties which are optional
f0c20d94
RD
54should be "checked" first. This panel can be made separate by unchecking
55"Embed Panel" in View menu.
09f3d4e6
RD
56
57All properties can be edited as text, and some are supplied with special
58editing controls.
59
306b6fe9
RR
60When no 'Edit' button is provided for editing a property's value, it is
61supposed to be copied verbatim to XRC file.
62
f0c20d94 63The names of the properties are exactly as in XRC file, and it's usually not
306b6fe9 64hard to guess what they do. "XML ID" is the name of the window, and must be
f0c20d94
RD
65present for top-level windows (though this is not enforced by XRCed).
66
09f3d4e6 67To display the preview window double-click a top-level object (you should
f0c20d94
RD
68assign an XMLID to it first), press "Test" toolbar button or select command
69from View menu, or press F5. After that, if you select a child object, it
09f3d4e6
RD
70becomes highlighted, and if you change it, preview is updated when you select
71another item or press Ctrl-R (refresh). To turn off automatic update, toggle
f0c20d94 72"View->Auto-refresh" or toolbar auto-refresh button (to the right of the
306b6fe9
RR
73refresh button). If you double-click a non-window object (a button for
74example), then test view is created for a closest ancestor which is a window.
75
76
77Bugs
78----
79
80- Some combinations of parent/child windows are not valid but possible to put
81 into XML tree by using XRCed. Usually this produces a meaningful error
82 message from XRC library when test view is opened.
83
84- Be careful when replacing a non-empty container control with another class,
85 and check parameters which can be copied from the previous object but not
86 valid for the new one. Is it not possible to undo replacement yet.
87
09f3d4e6
RD
88
89--------------------------------------------------------------------------------
90
306b6fe9 91Copyright 2001-2005 Roman Rolinsky <rollrom@xrced.sourceforge.net>