Changeset 4:e099638ff236 in glemon-0.x for graph_displayer_canvas.h

Timestamp:

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

Author:

Hegyi Péter

Branch:

gui

Phase:

public

Convert:

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

Message:

Small documentation is added to GUI

File:

• graph_displayer_canvas.h (modified) (2 diffs)

graph_displayer_canvas.h

@@ -9 +9 @@
 #include <libgnomecanvasmm/polygon.h>
 
+///This class is the canvas, on which the graph can be drawn.
 class GraphDisplayerCanvas : public Gnome::Canvas::CanvasAA
 {
@@ -17 +18 @@
   virtual ~GraphDisplayerCanvas();
 
+  ///Changes the linewidth attribute according to the given map.
+  ///\param mapname is the name of the map which contains the new values
   int changeLineWidth (std::string mapname);
+
+  ///Changes the linecolor attribute according to the given map.
+  ///\param mapname is the name of the map which contains the new values
   int changeColor (std::string mapname);
+
+  ///Changes the text of line attribute according to the given map.
+  ///\param mapname is the name of the map which contains the new values
   int changeText (std::string mapname);
+
+  ///Changes the dot-pro-pixel to be able to show the whole graph.
   int rezoom();
 
 protected:
 
+  //maximizing, minimizing, restoring window, etc. 
   virtual bool on_expose_event(GdkEventExpose *);
 
 private:
 
-  ///Event handler function that handles dragging nodes of displayed_graph
+  ///This function is responsible for the correct
+  ///reaction of any action happened in the territory
+  ///of the canvas
   bool event_handler(GdkEvent* e, Node n);
 
   ///The graph, on which we work
   Graph g;
-  ///Map of nodes of planefigure
+
+  ///Map of nodes of graph
   Graph::NodeMap<Gnome::Canvas::Ellipse *> nodesmap;
-  ///Map of edges of planefigure
+
+  ///Map of edges of graph
   Graph::EdgeMap<Gnome::Canvas::Line *> edgesmap;