git.sur5r.net Git - bacula/bacula/blob - bacula/src/qt-console/README

   1
   2 This directory contains the Bacula Admin Tool (bat).
   3
   4 At the current time, the contents of this directory are under
   5 development.  If you want to help, please contact Kern directly.
   6 If you want to build it, you need Qt4 loaded and setup as your
   7 default Qt or with the appropriate Qt Environment variables set.
   8
   9 To build bat, you simply enter:
  10
  11   qmake
  12   make
  13
  14 then to execute it
  15
  16   ./bat
  17
  18 The qmake command needs to be entered only if you add a new file, in
  19 which case, you should edit bat.pro and add the new filename
  20 in the appropriate place.  In running qmake, it will build a new
  21 Makefile, and there after, you simply use "make". In fact, providing
  22 you edit bat.pro, doing a "make" will automatically call qmake to
  23 rebuild the Makefile.
  24
  25 Development status as of 11 Feb 07.
  26
  27 Items implemented:
  28 - Reads a basic bat.conf (same as documented for the gnome-console
  29    except that the Font part is unimplemented).
  30 - Basic main window structure
  31 - About dialog
  32 - Quit menu item
  33 - Connect button will connect to the first Director defined in the conf file.
  34 - The Director name will appear in the Selection tree followed
  35   by Console and Restore.
  36 - Clicking on Console brings forward the console display screen
  37   (default at startup).
  38 - Clicking on Restore brings up a brestore page that is not active.
  39 - The command line is implemented.
  40 - The status line (below the command line) is implemented.
  41 - Selection of Font is implemented.
  42 - The Font and the window size are saved on exit and restored on
  43   execution of bat.
  44
  45 Items not implemented:
  46 - None of the menu items except About, Quit.
  47 - Nothing on the restore page
  48
  49 Design/implementation considerations:
  50 - We need to have multiple Directors
  51 - Each Director should have its own console
  52 - The Console class needs to be a list or be attached to the
  53   currently active Director.
  54 - Need icons in front of the Director.
  55 - The console page should be in a DockWidget so it can be removed
  56   from the main window. It is currently in a dock window, but it
  57   does not remove properly -- more research needed.
  58 - Need to figure out a good implementation of adding pages and even
  59   having plugins that load as pages.  Currently the page mechanism
  60   is a bit kludged.
  61 - moc files should be moved into a subdirectory.
  62
  63 Design decisions:
  64 - If possible all code for a particular component will be kept in
  65   and appropriate subdirectory.
  66 - All private class variables are named "m_xxx" this makes it very
  67   clear if one is referencing a class variable or a local.
  68 - All signal/slots are connected by explict code (most all are
  69   done in the MainWin constructor), rather than using designer.
  70 - Each page has a separate designer .ui file in a subdirectory.
  71 - All windows are created with designer and have
  72   a name such as xxxForm i.e. the main window is MainForm and kept
  73   in main.ui.
  74
  75 Major projects:
  76 - Implement a restore page that does a directory tree restore selection
  77   much like wx-console does.
  78 - Implement other restore interfaces such as brestore ...
  79 - Implement a database browser
  80 - Implement graphical commands that allow updating most aspects of
  81   the database (i.e. commands for label, update Volume, ...)
  82 - Implement a resource (conf file) browser
  83 - Implement a reports page -- e.g. something similar to bweb
  84 - Implement Qt plugins to add new functionality to bat
  85 - Implement a GUI configuration file editor (something like JBacula).
  86 ...