1.1 --- a/gui/main_win.h	Thu May 26 16:32:26 2005 +0000
     1.2 +++ b/gui/main_win.h	Fri May 27 10:34:20 2005 +0000
     1.3 @@ -9,34 +9,41 @@
     1.4  #include <libgnomecanvasmm.h>
     1.5  #include <libgnomecanvasmm/polygon.h>
     1.6  
     1.7 +///This class is the main window of GUI.
     1.8 +///It has menus, but the main part of it is the canvas.
     1.9  class MainWin : public Gtk::Window
    1.10  {
    1.11  public:
    1.12 +  ///Constructor of the \ref MainWin. It creates the menu and the \ref GraphDisplayerCanvas on which the graph will be drawn.
    1.13 +  ///\param title is the title of the window
    1.14 +  ///\param graph is the graph that will be drawn here. It will be given further to the \ref GraphDisplayerCanvas
    1.15 +  ///\param cm stores the coordinates of the nodes of the graph
    1.16 +  ///\param ms is the \ref MapStorage in which the different visualizable maps are stored
    1.17    MainWin(const std::string& title, Graph &, CoordinatesMap &, MapStorage &);
    1.18  
    1.19  protected:
    1.20 -  //Window of map-showing setup
    1.21 +  ///Window of map-showing setup. Its type is \ref MapWin
    1.22    MapWin mapwin;
    1.23  
    1.24 -  //Member widgets:
    1.25 +  ///The graph will be drawn on this \ref GraphDisplayerCanvas
    1.26    GraphDisplayerCanvas gd_canvas;
    1.27  
    1.28 -  //ActionGroup for menu
    1.29 +  ///ActionGroup for menu
    1.30    Glib::RefPtr<Gtk::ActionGroup> ag;
    1.31  
    1.32 -  //UIManager for menu
    1.33 +  ///UIManager for menu
    1.34    Glib::RefPtr<Gtk::UIManager> uim;
    1.35  
    1.36 -  //Container
    1.37 +  ///Container
    1.38    Gtk::VBox vbox;
    1.39  
    1.40 -  //Pops up map-setup window
    1.41 +  ///This function makes map-setup window popped up.
    1.42    virtual void showMaps();
    1.43  
    1.44 -  //Exit
    1.45 +  ///Exit
    1.46    virtual void quit();
    1.47  
    1.48 -  //Refit screen
    1.49 +  ///Refit screen to be able to show the whole graph.
    1.50    virtual void rezoom();
    1.51  
    1.52  };