Changeset 1440:3d2e3cfb2a6c in lemon-0.x for gui/main_win.h

Timestamp:

05/27/05 12:34:20 (18 years ago)

Author:

Hegyi Péter

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1915

Message:

Small documentation is added to GUI

File:

• gui/main_win.h (modified) (1 diff)

gui/main_win.h

@@ -10 +10 @@
 #include <libgnomecanvasmm/polygon.h>
 
+///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<Gtk::ActionGroup> ag;
 
-  //UIManager for menu
+  ///UIManager for menu
   Glib::RefPtr<Gtk::UIManager> 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();