ACE/examples/ConfigViewer/README

   1
   2
   3 Configuration Viewer 1.0
   4 ========================
   5
   6 This is something I quickly threw together to allow GUI editing of
   7 ACE_Configuration files.  I thought it would be useful and serve as a
   8 better example of how to use ACE_Configuration.  I developed this under
   9 Windows 2000, but it should easily port to any platform that wxWindows
  10 supports (see http://www.wxwindows.org.).
  11
  12 ==============
  13    Usage
  14 ==============
  15 All functionality is delivered through the file menu and right mouse button
  16 context menus.  The file menu lets you create the different types of
  17 ACE_Configurations such as a transient heap, persistent heap or Win32
  18 Registry heap.  A new persistent heap may be created, or an older one
  19 may be opened.  The win32 registry will require you to enter the path
  20 from HKEY_LOCAL_MACHINE that you want to open.  For example: "Software/TAO"
  21 would set the Win32Registry's root to HKEY_LOCAL_MACHINE/Software/TAO.
  22 Note that this quick implementation loads the entire tree, so if you
  23 enter "Software" it may take a minute to load up - beware!  Next you
  24 may import or export entries from a heap to an INI file using the
  25 Import/Export file commands.
  26
  27 The right mouse button opens up a context menu in both the tree control
  28 and the list control.
  29 From the tree context menu, you can:
  30 1) Create new keys (these hold name/value pairs)
  31 2) Create new string values
  32 3) Create new integer values
  33 4) Delete a key (beware, everything beneath it will be removed as well)
  34
  35 From the list control context menu, you can:
  36 1) Modify a the value of an entry
  37 2) Delete the entry
  38 3) Rename the entry
  39
  40 Known Bugs/Issues:
  41 *) You cannot enter/edit binary types
  42 *) Adding a new string/integer value with the same name as an existing
  43    entry will overwrite the existing entry without warning.  I think there
  44    is a memory leak that occurs as well.
  45 *) You can add entries to the root key, but they will not be imported
  46    or exported.  I think this is by design and the GUI should prevent
  47    this.  I need to investigate this further.
  48 *) The entire configuration file is loaded into the tree when it is opened.
  49    For large configurations, this may take a while.  A good improvement
  50    would be to load items as the user expands them.
  51 *) At the time of this writing, there is a nasty bug in
  52    ACE_Configuration_Heap that has to do with changing the value
  53    of an existing entry.  I have submitted a patch to fix this, but
  54    it may not go in until 5.1.3 (current version is 5.1.2).  I strongly
  55    recommend that you get the patch/newer version!
  56 *) Renaming of Keys is not supported.  This requires an enhancement to
  57    ACE_Configuration first.
  58 *) No makefiles for other platforms exist, can you donate one?
  59 *) This has only been tested for non MFC DLL builds of ACE, it
  60    should work fine in the other configurations, but I haven't tested it.
  61
  62 =============================================
  63
  64 This was developed using:
  65 *) wxWindows 2.1.15
  66 *) ACE 5.0.16 + My patch to fix a bug in ACE_Configuration_Heap
  67 *) Windows 2000
  68 *) MSVC 6.0 + SP3
  69
  70 If you have any questions or comments, please send me an email.  I really
  71 enjoy hearing about others that find this contribution useful!
  72
  73 Chris Hafey
  74 May 2, 2000
  75 chris@stentorsoft.com
  76