ltt/branches/poly/doc/developer/gui_layout.txt

   1 GUI Layout
   2
   3
   4 Mathieu Desnoyers, June 2003
   5
   6
   7 In order to implement the GUI, choices has to be made based on habitual interfaces that we know users are familiar with. The inspiration for these choices came mainly from the Mozilla browser project and also from Openoffice, which are currently used as two userfriendly applications in various Linux distribution at the time of this writing.
   8
   9 This document describes the layout of the GUI in three sections : containers, menus and toolbars.
  10
  11 A status bar is also placed at the bottom of the window.
  12
  13 - Containers
  14
  15 elements hierarchy
  16
  17 Window Mainwindow
  18 |->vbox
  19    |->menus
  20    |->toolbar of the main window
  21    |->toolbar of the currently selected viewer
  22    |->notebook
  23    |  |->vpaned
  24    |  |->viewer's widget
  25    |  |->vpaned
  26    |  |->viewer's widget
  27    |  |->vpaned
  28    |  |->...
  29    |->Status bar
  30
  31 - Menus
  32
  33 Here is a short description of each menu entry
  34 *   by itself means a separator
  35
  36
  37 - File
  38 *New -> *Empty trace set : open a new window with an empty trace set.
  39         *Clone trace set : copy the content of the current window in a new
  40                            window.
  41 *Open : open a trace set. Calls a file selection dialog.
  42 *Close : close the current window.
  43 *
  44 *Add trace : Add a trace to the window's traceset. Calls file selection dialog.
  45 *Remove trace : Removes a trace from the traceset.
  46 *Save : save the trace set. Calls a file save dialog of no current filename.
  47 *Save as : save a trace set. Calls a file save dialog.
  48 *
  49 *Quit : quit the program.
  50
  51 - Edit ? (not needed for now)
  52
  53 - View
  54 *Zoom In : Multiply the zoom factor by a certain quantity.
  55 *Zoom Out : Divide the zoom factor by a certain quantity.
  56 *Zoom Extended : Show the entire traceset's largest time interval.
  57 *Go to time : Keep same zoom, ask user for time to center view on and make
  58               it the current time.
  59 *Show time frame : ask user for time interval to show.
  60               (modify zoom and current event in consequence)
  61
  62 - Tools (this is an example of how viewer's menu entries should look like)
  63 *Move viewer up -> Moves the current viewer up one position.
  64 *Move viewer down -> Moves the current viewer down one position.
  65 *Remove : remove the current viewer
  66 *
  67 *DumpToFile -> *Dump Text (This is a text module which adds graphical menu
  68                            entries)
  69                *Dump binary
  70 * (separator between text tools and graphical tools implies different function
  71    to register each type of menu entries)
  72 *Insert Events View : insert this type of viewer
  73 *Insert ControlFlow View
  74 - Plugins
  75 *Load module : ask the user a module to load (list modules in search path).
  76 *Unload module : list all modules, click to choose, then unload button.
  77 *Add module search path : ask user for a new path (file selection dialog).
  78
  79 - Options
  80 //FIXME *Color : change the color of the currently selected element ?
  81 *Filter : Show traceset's filter option window.
  82 *Save configuration : Save the currently loaded modules/traceset/filters
  83                       to gconf.
  84
  85
  86 (aligned to the right)
  87 - Help
  88 *Content
  89 *About
  90
  91
  92 - Toolbar
  93
  94 The toolbar is separated in two parts : like the two lines used in Openoffice. The first one is applying to the top level window (or current tab) while the one below contains the current viewer's toolbar.
  95
  96 So we have something like this :
  97
  98 --------------------------------------------------------------------------------
  99 | Menus                                                                        |
 100 --------------------------------------------------------------------------------
 101 | Toolbar of the top level window                                              |
 102 --------------------------------------------------------------------------------
 103 | Toolbar of the current viewer                                                |
 104 --------------------------------------------------------------------------------
 105 | viewers in vpaned                                                            |
 106 |                                                                              |
 107 |                                                                              |
 108 --------------------------------------------------------------------------------
 109 | Status bar                                                                   |
 110 --------------------------------------------------------------------------------
 111
 112
 113 The toolbar of the top level window is the only one described in this document, as the second one is defined by the viewers and specific to each of them.
 114
 115 This toolbar is mainly a selection of the menu entries.
 116
 117 New : New window with empty trace set.
 118 Open : open a trace set.
 119 Add Trace
 120 Remove Trace
 121 Save : save the current trace set.
 122 Save as
 123 *
 124 Zoom in
 125 (Show the current zoom factor, modifiable)
 126 Zoom out
 127 Zoom Extended
 128 Go to time (shows time directly)
 129 Show time frame (Could be a special field showing the time frame)
 130 *
 131 Move up current viewer
 132 Move down current viewer
 133 Delete current viewer
 134 *
 135 Add viewer's specific insertion buttons are added here.
 136
 137