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 29 Jan 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 (initally shows disconnected) will connect to
  34   the first Director defined in the conf file.
  35 - The Director name will appear in the Selection tree followed
  36   by Console and Restore.
  37 - Clicking on Console brings forward the console display screen
  38   (default at startup).
  39 - Clicking on Restore brings up a dummy two tab "restore" page.
  40 - The command line is implemented.
  41 - The status line (below the command line) is implemented.
  42
  43 Items not implemented:
  44 - None of the menu items except About, Quit.
  45 - None of the tool bar icons except the connect/disconnect.
  46 - Nothing on the restore page
  47
  48 Design/implementation considerations:
  49 - We need to have multiple Directors
  50 - Each Director should have its own console
  51 - The Console class needs to be a list or be attached to the
  52   currently active Director.
  53 - Need icons in front of the Director.
  54 - Need indication if a director is connected or not.
  55 - The console page should be in a DockWidget so it can be removed
  56   from the main window.
  57 - Need to figure out a good implementation of adding pages and even
  58   having plugins that load as pages.  Currently the page mechanism
  59   is a bit kludged.
  60 - Each page should in principle be a separate designer .ui file
  61   Currently the two pages console, restore are part of main.ui,
  62   but they should be pulled out into their own .ui files.
  63
  64 Design decisions:
  65 - If possible all windows will be created with designer and have
  66   a name such as xxxForm i.e. the main window is MainForm and kept
  67   in main.ui.
  68 - If possible all code for a particular component will be kept in
  69   and appropriate subdirectory.
  70 - All private class variables are named "m_xxx" this makes it very
  71   clear if one is referencing a class variable or a local.
  72 - All signal/slots are connected by explict code (most all are
  73   done in the MainWin constructor), rather than using designer.
  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 ...
  87