wxPython/tools/XRCed/README

   1 ********************************************************************************
   2
   3                                   XRCed README
   4
   5 ********************************************************************************
   6
   7 Installation on UNIX
   8 --------------------
   9
  10 XRCed was developed using Python 2.1.1. xml.dom.minidom module should be
  11 available. XML support requires Expat package (http://expat.sourceforge.net),
  12 and you have to uncomment expat lines in Modules/Setup file of Python source:
  13
  14 EXPAT_DIR=$(HOME)/expat
  15 pyexpat pyexpat.c -I$(EXPAT_DIR)/xmlparse -L$(EXPAT_DIR) -lexpat
  16
  17 wxPython version used was 2.3.1, which itself uses wxGTK 2.3.1. wxPython
  18 should be modified to support some extra functions. To update it, go to
  19 wxPython source directory and untar "wxPython-update.tgz" (included with
  20 xrced) file there. Then recompile (run "b 21" for example) it and install as
  21 usual (or you can set your environment to use it from the source tree).
  22
  23
  24 Short manual
  25 ------------
  26
  27 To start xrced, change to the directory where you installed it and run
  28 "python2.1 xrced.py".
  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 right
  32 (in another sense now :) ) command. The pulldown menu is context-dependent on
  33 the selected 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 Control key before clicking the mouse.
  40
  41 Same applies for copy/paste, but at the moment Control key is ignored.
  42
  43 Panel on the right contains object properties. Properties which are optional
  44 should be "checked" first. XMLID of the object is the textbox to the right of
  45 the class name.
  46
  47 All properties can be edited as text, and some are supplied with special
  48 editing controls.
  49
  50 To display the preview window double-click a top-level object (you should
  51 assign an XMLID to it first). After that, if you select a child object, it
  52 becomes highlighted, and if you change it, preview is updated when you select
  53 another item or press Ctrl-R (refresh). To turn off automatic update, toggle
  54 "View->Auto-refresh" or toolbar auto-refresh button (to the right of refresh
  55 button).
  56
  57
  58 --------------------------------------------------------------------------------
  59
  60 Copyright 2001 Roman Rolinsky <rolinsky@mema.ucl.ac.be>