Changeset 863 for trunk/sources/HeuristicLab.Visualization/MouseEventListener.cs

Timestamp:

11/29/08 12:23:52 (15 years ago)

Author:

bspisic

Message:

#319

MouseEventListener xml comments created

File:

• trunk/sources/HeuristicLab.Visualization/MouseEventListener.cs (modified) (4 diffs)

trunk/sources/HeuristicLab.Visualization/MouseEventListener.cs

@@ -2 +2 @@
 
 namespace HeuristicLab.Visualization {
+  /// <summary>
+  /// Helper class for different OnMouseMove and OnMouseUp implementations.
+  /// </summary>
   public class MouseEventListener {
+    /// <summary>
+    /// Fired when the MouseMove method was called.
+    /// </summary>
     public event MouseEventListenerHandler OnMouseMove;
+
+    /// <summary>
+    /// Fired when the MouseUp method was called.
+    /// </summary>
     public event MouseEventListenerHandler OnMouseUp;
 
     private Point startPoint;
 
+    /// <summary>
+    /// Call this method to fire the OnMouseMove event.
+    /// </summary>
+    /// <param name="actualPoint"></param>
     public void MouseMove(Point actualPoint) {
       if (OnMouseMove != null) {
@@ -14 +28 @@
     }
 
+    /// <summary>
+    /// Call this method to fire the OnMouseUp event.
+    /// </summary>
+    /// <param name="actualPoint">Actual point of the mouse</param>
     public void MouseUp(Point actualPoint) {
       if (OnMouseUp != null) {
@@ -20 +38 @@
     }
 
+    /// <summary>
+    /// Gets or sets the starting point of the mouse.
+    /// </summary>
     public Point StartPoint {
       get { return startPoint; }
@@ -26 +47 @@
   }
 
+  /// <summary>
+  /// Handler for the MouseEventListener events.
+  /// </summary>
+  /// <param name="startPoint">Starting point of the mouse.</param>
+  /// <param name="actualPoint">Actual point of the mouse.</param>
   public delegate void MouseEventListenerHandler(Point startPoint, Point actualPoint);
 }