A new version of XRCed from Roman Rolinsky with a few tweaks by me.

[wxWidgets.git] / wxPython / tools / XRCed / README

diff --git a/wxPython/tools/XRCed/README b/wxPython/tools/XRCed/README
index ee7108f4e224a23eec6cdccce2f7d7ecaf4d5a84..133ee2a2e55f019fa6a5e68d89fe165d53dde313 100644 (file)
--- a/wxPython/tools/XRCed/README
+++ b/wxPython/tools/XRCed/README
@@ -7,53 +7,65 @@
 Installation on UNIX
 --------------------
 
 Installation on UNIX
 --------------------
 

-XRCed was developed using Python 2.1.1. xml.dom.minidom module should be
-available. XML support requires Expat package (http://expat.sourceforge.net),
-and you have to uncomment expat lines in Modules/Setup file of Python source:
+XRCed requires wxGTK and wxPython greater than 2.3.2, and Python 2.2 (it may
+work with earlier version, but was not tested).

 
 

-EXPAT_DIR=$(HOME)/expat
-pyexpat pyexpat.c -I$(EXPAT_DIR)/xmlparse -L$(EXPAT_DIR) -lexpat
+Of course wxGTK's XRC library (libwxxrc) must be installed.

 
 

-wxPython version used was 2.3.1, which itself uses wxGTK 2.3.1. wxPython
-should be modified to support some extra functions. To update it, go to
-wxPython source directory and untar "wxPython-update.tgz" (included with
-xrced) file there. Then recompile (run "b 21" for example) it and install as
-usual (or you can set your environment to use it from the source tree).
+Installation on Windows
+-----------------------

 
 

+Works with wxPython 2.3.2 for Python 2.2.

 
 Short manual
 ------------
 
 
 Short manual
 ------------
 

+XRCed's idea is very straightforward: it is a visual tool for editing an XML
+file conforming to XRC format. Every operation performed in XRCed has direct
+correspondence to XML structure. So it is not really a usual point-and-click
+GUI builder, but don't let that scare you.
+

 To start xrced, change to the directory where you installed it and run
 To start xrced, change to the directory where you installed it and run

-"python2.1 xrced.py".
+"python2.2 xrced.py".
+
+On UNIX you can edit wrapper script "xrced.sh" to point to your installation
+directory.

 
 To create an object, first you should select some object in the tree (or the
 
 To create an object, first you should select some object in the tree (or the

-root item if it's empty) then press the right mouse button and select right
-(in another sense now :) ) command. The pulldown menu is context-dependent on
-the selected object.
+root item if it's empty) then press the right mouse button and select an
+appropriate command. The pulldown menu is context-dependent on the selected
+object.

 
 XRCed tries to guess if new object should be added as a next sibling or a
 child of current object, depending on the possibility of the object to have
 child objects and expanded state (if tree item is collapsed, new object will
 be sibling). You can change this behavior to create siblings by pressing and
 
 XRCed tries to guess if new object should be added as a next sibling or a
 child of current object, depending on the possibility of the object to have
 child objects and expanded state (if tree item is collapsed, new object will
 be sibling). You can change this behavior to create siblings by pressing and

-holding the Control key before clicking the mouse.
+holding the Shift and Control keys before clicking the mouse.
+
+Pressed Control key while pressing right button makes next item a sibling of
+selected item regardless of its expanded state.

 
 

-Same applies for copy/paste, but at the moment Control key is ignored.
+Pressed Shift key changes the place for inserting new child to be before
+selected child, not after as by default.

 
 Panel on the right contains object properties. Properties which are optional
 
 Panel on the right contains object properties. Properties which are optional

-should be "checked" first. XMLID of the object is the textbox to the right of
-the class name.
+should be "checked" first. This panel can be made separate by unchecking
+"Embed Panel" in View menu.

 
 All properties can be edited as text, and some are supplied with special
 editing controls.
 
 
 All properties can be edited as text, and some are supplied with special
 editing controls.
 

+The names of the properties are exactly as in XRC file, and it's usually not
+hard to guess what they do. XML ID is the name of the window, and must be
+present for top-level windows (though this is not enforced by XRCed).
+

 To display the preview window double-click a top-level object (you should
 To display the preview window double-click a top-level object (you should

-assign an XMLID to it first). After that, if you select a child object, it
+assign an XMLID to it first), press "Test" toolbar button or select command
+from View menu, or press F5. After that, if you select a child object, it

 becomes highlighted, and if you change it, preview is updated when you select
 another item or press Ctrl-R (refresh). To turn off automatic update, toggle
 becomes highlighted, and if you change it, preview is updated when you select
 another item or press Ctrl-R (refresh). To turn off automatic update, toggle

-"View->Auto-refresh" or toolbar auto-refresh button (to the right of refresh
-button).
-
+"View->Auto-refresh" or toolbar auto-refresh button (to the right of the
+refresh button).

 
 --------------------------------------------------------------------------------
 
 
 --------------------------------------------------------------------------------