Changeset 2019 for trunk/sources/HeuristicLab.Visualization

Timestamp:

06/04/09 21:50:11 (16 years ago)

Author:

bspisic

Message:

Added some comments (#664)

Location:

trunk/sources/HeuristicLab.Visualization/3.2

Files:

• IMouseEventListener.cs (modified) (1 diff)
• PanListener.cs (modified) (1 diff)
• ZoomListener.cs (modified) (1 diff)

trunk/sources/HeuristicLab.Visualization/3.2/IMouseEventListener.cs

@@ -3 +3 @@
 
 namespace HeuristicLab.Visualization {
+  /// <summary>
+  /// Interface for MouseEventListeners like ZoomListener, PanListener etc. to simplify state handling.
+  /// </summary>
   public interface IMouseEventListener {
+    /// <summary>
+    /// Call this method on mouse move.
+    /// </summary>
+    /// <param name="sender"></param>
+    /// <param name="e"></param>
     void MouseMove(object sender, MouseEventArgs e);
+
+    /// <summary>
+    /// Call this method on mouse up.
+    /// </summary>
+    /// <param name="sender"></param>
+    /// <param name="e"></param>
     void MouseUp(object sender, MouseEventArgs e);
   }

trunk/sources/HeuristicLab.Visualization/3.2/PanListener.cs

@@ -3 +3 @@
 
 namespace HeuristicLab.Visualization {
+  /// <summary>
+  /// Supports the state panning.
+  /// </summary>
   public class PanListener : IMouseEventListener {
     private Point startPoint;
 
+    /// <summary>
+    /// This event will be fired every MouseMove call.
+    /// </summary>
     public event MoveHandler Pan;
 

trunk/sources/HeuristicLab.Visualization/3.2/ZoomListener.cs

@@ -4 +4 @@
 
 namespace HeuristicLab.Visualization {
+  /// <summary>
+  /// Supports the state zooming.
+  /// </summary>
   public class ZoomListener : IMouseEventListener {
     private readonly Point startPoint;
 
+    /// <summary>
+    /// This event will be fired every MouseMove call.
+    /// </summary>
     public event RectangleHandler DrawRectangle;
+
+    /// <summary>
+    /// This event will be fired on the MouseUp call.
+    /// </summary>
     public event RectangleHandler Zoom;