]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/qt-console/README
Add new tray-monitor files that were omitted in the backport from Enterprise
[bacula/bacula] / 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 6/24/07
10 There is now one dependency, it is qwt.  It compiles just fine with
11 either qwt-5.0.2 or qwt-5.0.1.  You can either install the qwt package
12 yourself or if your distro does not have it, we have included the source
13 in depkgs-qt, which you can download from the Bacula Source Forge        
14 download area.
15
16 Building and running bat is done much like bconsole, the gnome console,
17 or the wxWidgets console.  You add the appropriate options to your   
18 ./configure, then simply do a make.  Please see the Installation chapter
19 of the manual for more details.
20
21
22 Win32 mingw infos for QT4 :
23  - http://silmor.de/29
24  - http://doc.qtfr.org/post/2007/04/10/Cross-Compilation-Native-dapplication-Qt-depuis-Linux
25
26 Development status as of 05/06/07
27
28 Items not implemented:
29 - Nothing on the brestore page
30
31 Translations:
32 - All translatable strings should be written as tr("string") ...
33 - To extract the strings for translation run:
34  
35    lupdate bat.pro
36
37 - To translate the strings, do:
38
39    linguist ts/bat_xx.ts
40
41   where xx is the country code (e.g. fr or de)
42
43 - To "compile" the translated strings do:
44
45   lrelease bat.pro
46
47   The necessary binary files will be in ts/bat_xx.qm
48   As far as I can tell, these files must be on your path or
49   in the same directory as bat for them to be used, otherwise
50   it reverts to English. Selecting the translation is based on
51   how your system is setup or the LANG environment variable.
52          
53 Design decisions:
54 - If possible all code for a particular component will be kept in
55   an appropriate subdirectory.
56 - All private class variables are named "m_xxx" this makes it very
57   clear if one is referencing a class variable or a local.
58 - All signal/slots are connected by explicit code (most all are
59   done in the MainWin constructor), rather than using designer.      
60 - Each page has a separate designer .ui file in a subdirectory.
61 - All windows are created with designer and have
62   a name such as xxxForm i.e. the main window is MainForm and kept
63   in main.ui.  
64
65 Major projects:
66 - Implement other restore interfaces such as brestore ...
67 - Implement a database browser
68 - Implement a resource (conf file) browser
69 - Implement a reports page -- e.g. something similar to bweb
70 - Implement Qt plugins to add new functionality to bat
71 - Implement a GUI configuration file editor (something like JBacula).
72 ...
73
74 Partially Done:
75 ===========================
76 - Implement graphical commands that allow updating most aspects of
77   the database (i.e. commands for label, update Volume, ...)
78       still need to be able to edit a pool object
79
80 - None of the menu items except About, Select Font, and Quit.
81     Print and save don't do anything, does save need to??
82 Done:
83 ============================
84 Design/implementation considerations:
85 - Need icons in front of the Director.
86 - The console page should be in a DockWidget so it can be removed
87   from the main window. It is currently in a dock window, but it
88   does not remove properly -- more research needed.
89 - Need to figure out a good implementation of adding pages and even
90   having plugins that load as pages.  Currently the page mechanism
91   is a bit kludged.
92
93 - We need to have multiple Directors
94 - Each Director should have its own console
95 - The Console class needs to be a list or be attached to the
96   currently active Director.
97 - Will automatically connect to the first Director in the
98   conf file. Doesn't know about multiple Directors.
99
100 - The Label menu bar item, prints on the shell window what you entered.
101 - The Run menu bar item, prints on the console window what you entered.
102 - The Restore menu bar item, brings up dialog, then when OK is
103   clicked, it goes on to the next dialog, which is meant to be
104   a tree view, but for the moment does nothing ...  It is a bit
105   ugly. Canceling it should get you back to the normal command prompt.
106
107 - Implement a restore page that does a directory tree restore selection
108   much like wx-console does.
109
110 Not working:
111 - The left selection window and the right window (where the console
112   is) are dockable windows so should be movable once they are properly
113   clicked.  Well, they sort of move, but then get stuck.  I haven't figured
114   out what is going on, so for the current time, I am implementing most
115   stuff through dialogs.
116      
117 Items implemented:
118   See RELEASEFEATURES