diff -r 2c43106bef85 -r 3d2e3cfb2a6c gui/main_win.h --- a/gui/main_win.h Thu May 26 16:32:26 2005 +0000 +++ b/gui/main_win.h Fri May 27 10:34:20 2005 +0000 @@ -9,34 +9,41 @@ #include #include +///This class is the main window of GUI. +///It has menus, but the main part of it is the canvas. class MainWin : public Gtk::Window { public: + ///Constructor of the \ref MainWin. It creates the menu and the \ref GraphDisplayerCanvas on which the graph will be drawn. + ///\param title is the title of the window + ///\param graph is the graph that will be drawn here. It will be given further to the \ref GraphDisplayerCanvas + ///\param cm stores the coordinates of the nodes of the graph + ///\param ms is the \ref MapStorage in which the different visualizable maps are stored MainWin(const std::string& title, Graph &, CoordinatesMap &, MapStorage &); protected: - //Window of map-showing setup + ///Window of map-showing setup. Its type is \ref MapWin MapWin mapwin; - //Member widgets: + ///The graph will be drawn on this \ref GraphDisplayerCanvas GraphDisplayerCanvas gd_canvas; - //ActionGroup for menu + ///ActionGroup for menu Glib::RefPtr ag; - //UIManager for menu + ///UIManager for menu Glib::RefPtr uim; - //Container + ///Container Gtk::VBox vbox; - //Pops up map-setup window + ///This function makes map-setup window popped up. virtual void showMaps(); - //Exit + ///Exit virtual void quit(); - //Refit screen + ///Refit screen to be able to show the whole graph. virtual void rezoom(); };