polish behavior of tool tips and reduce meory footprint.

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@23777 72102866-910b-0410-8b05-ffd578937521

ChangeLog

@@ -1,3 +1,10 @@
+2006-10-06 Richard Frith-Macdonald <rfm@gnu.org>
+
+	* Source/GSToolTips.h: Remove some ivars
+	* Source/GSToolTips.m: Move ivars to be static variables for common
+	use by all tool tips.  Cancel an in-progress tooltip when a new one
+	starts.
+
 2006-10-04 Richard Frith-Macdonald <rfm@gnu.org>
 
 	* Source/GSToolTips.h: create tool tip wondow fully on screen

Source/GSToolTips.h

@@ -36,10 +36,6 @@
 {
   NSView		*view;
   NSTrackingRectTag	toolTipTag;
-  NSTimer		*timer;
-  NSWindow		*window;
-  NSSize		offset;
-  BOOL			restoreMouseMoved;
 }
 
 /** Destroy object handling tips for aView.

Source/GSToolTips.m

@@ -96,6 +96,10 @@ typedef struct NSView_struct
 @implementation GSToolTips
 
 static NSMapTable	*viewsMap = 0;
+static NSTimer		*timer;
+static NSWindow		*window;
+static NSSize		offset;
+static BOOL		restoreMouseMoved;
 
 + (void) initialize
 {
@@ -192,40 +196,46 @@ static NSMapTable	*viewsMap = 0;
 
 - (void) mouseEntered: (NSEvent *)theEvent
 {
-  if (timer == nil)
+  GSTTProvider	*provider;
+  NSString	*toolTipString;
+
+  if (timer != nil)
     {
-      GSTTProvider	*provider = (GSTTProvider*)[theEvent userData];
+      /* Moved from one tooltip view to another, so reset the timer.
-      NSString		*toolTipString;
+       */
-
+      [timer invalidate];
-      if ([[provider object] respondsToSelector:
+      timer = nil;
-	@selector(view:stringForToolTip:point:userData:)] == YES)
-	{
-	  toolTipString = [[provider object] view: view
-				 stringForToolTip: [theEvent trackingNumber]
-					    point: [theEvent locationInWindow]
-					 userData: [provider data]];
-	}
-      else
-        {
-	  toolTipString = [[provider object] description];
-	}
-
-      timer = [NSTimer scheduledTimerWithTimeInterval: 0.5
-	                                         target: self
-			                       selector: @selector(_timedOut:)
-			                       userInfo: toolTipString
-                                                repeats: YES];
-      if ([[view window] acceptsMouseMovedEvents] == YES)
-        {
-	  restoreMouseMoved = NO;
-	}
-      else
-        {
-	  restoreMouseMoved = YES;
-          [[view window] setAcceptsMouseMovedEvents: YES];
-	}
-      [NSWindow _setToolTipVisible: self];
     }
+
+  provider = (GSTTProvider*)[theEvent userData];
+  if ([[provider object] respondsToSelector:
+    @selector(view:stringForToolTip:point:userData:)] == YES)
+    {
+      toolTipString = [[provider object] view: view
+			     stringForToolTip: [theEvent trackingNumber]
+					point: [theEvent locationInWindow]
+				     userData: [provider data]];
+    }
+  else
+    {
+      toolTipString = [[provider object] description];
+    }
+
+  timer = [NSTimer scheduledTimerWithTimeInterval: 0.5
+					     target: self
+					   selector: @selector(_timedOut:)
+					   userInfo: toolTipString
+					    repeats: YES];
+  if ([[view window] acceptsMouseMovedEvents] == YES)
+    {
+      restoreMouseMoved = NO;
+    }
+  else
+    {
+      restoreMouseMoved = YES;
+      [[view window] setAcceptsMouseMovedEvents: YES];
+    }
+  [NSWindow _setToolTipVisible: self];
 }
 
 - (void) mouseExited: (NSEvent *)theEvent
@@ -438,7 +448,14 @@ static NSMapTable	*viewsMap = 0;
 
 - (void) _timedOut: (NSTimer *)aTimer
 {
-  NSString *toolTipString = [aTimer userInfo];
+  NSString		*toolTipString = [aTimer userInfo];
+  NSAttributedString	*toolTipText = nil;
+  NSSize		textSize;
+  NSPoint		mouseLocation = [NSEvent mouseLocation];
+  NSRect		visible;
+  NSRect		rect;
+  NSColor		*color;
+  NSMutableDictionary	*attributes;
 
   if (timer != nil)
     {
@@ -449,78 +466,84 @@ static NSMapTable	*viewsMap = 0;
       timer = nil;
     }
 
-  if (window == nil)
+  if (window != nil)
     {
-      NSAttributedString	*toolTipText = nil;
+      /* Moved from one tooltip view to another ... so stop displaying
-      NSSize			textSize;
+       * the old tool tip before we start the new one.
-      NSPoint			mouseLocation = [NSEvent mouseLocation];
+       * This is similar to the case in -mouseEntered: where we cancel
-      NSRect			visible;
+       * the timer for one tooltip view because we have entered another
-      NSRect			rect;
+       * one.
-      NSColor			*color;
+       * To think about ... if we entered a tooltip rectangle without
-      NSMutableDictionary	*attributes;
+       * having left the previous one, then when we leave this rectangle
-
+       * we are probably back in the other one and should really restart
-      attributes = [NSMutableDictionary dictionary];
+       * the timer for the original view.  However, this is a rare case
-      [attributes setObject: [NSFont toolTipsFontOfSize: 10.0]
+       * so it's probably better to ignore it than add a lot of code to
-		     forKey: NSFontAttributeName];
+       * keep track of all entry and exit.
-      toolTipText =
-	[[NSAttributedString alloc] initWithString: toolTipString
-	                                attributes: attributes];
-      textSize = [toolTipText size];
-
-      /* Create window just off the current mouse position
-       * Constrain it to be on screen, shrinking if necessary.
        */
-      rect = NSMakeRect(mouseLocation.x + 8,
+      [self _endDisplay];
-        mouseLocation.y - 16 - (textSize.height+3),
-        textSize.width + 4, textSize.height + 4);
-      visible = [[NSScreen mainScreen] visibleFrame];
-      if (NSMaxY(rect) > NSMaxY(visible))
-        {
-	  rect.origin.y -= (NSMaxY(rect) - NSMaxY(visible));
-	}
-      if (NSMinY(rect) < NSMinY(visible))
-        {
-	  rect.origin.y += (NSMinY(visible) - NSMinY(rect));
-	}
-      if (NSMaxY(rect) > NSMaxY(visible))
-        {
-	  rect.origin.y = visible.origin.y;
-	  rect.size.height = visible.size.height;
-	}
-        
-      if (NSMaxX(rect) > NSMaxX(visible))
-        {
-	  rect.origin.x -= (NSMaxX(rect) - NSMaxX(visible));
-	}
-      if (NSMinX(rect) < NSMinX(visible))
-        {
-	  rect.origin.x += (NSMinX(visible) - NSMinX(rect));
-	}
-      if (NSMaxX(rect) > NSMaxX(visible))
-        {
-	  rect.origin.x = visible.origin.x;
-	  rect.size.width = visible.size.width;
-	}
-      offset.height = rect.origin.y - mouseLocation.y;
-      offset.width = rect.origin.x - mouseLocation.x;
-
-      window = [[NSWindow alloc] initWithContentRect: rect
-					   styleMask: NSBorderlessWindowMask
-					     backing: NSBackingStoreRetained
-					       defer: YES];
-
-      color
-	= [NSColor colorWithDeviceRed: 1.0 green: 1.0 blue: 0.90 alpha: 1.0];
-      [window setBackgroundColor: color];
-      [window setReleasedWhenClosed: YES];
-      [window setExcludedFromWindowsMenu: YES];
-      [window setLevel: NSStatusWindowLevel];
-
-      [window orderFront: nil];
-
-      [self _drawText: toolTipText];
-      RELEASE(toolTipText);
     }
+
+  attributes = [NSMutableDictionary dictionary];
+  [attributes setObject: [NSFont toolTipsFontOfSize: 10.0]
+		 forKey: NSFontAttributeName];
+  toolTipText =
+    [[NSAttributedString alloc] initWithString: toolTipString
+				    attributes: attributes];
+  textSize = [toolTipText size];
+
+  /* Create window just off the current mouse position
+   * Constrain it to be on screen, shrinking if necessary.
+   */
+  rect = NSMakeRect(mouseLocation.x + 8,
+    mouseLocation.y - 16 - (textSize.height+3),
+    textSize.width + 4, textSize.height + 4);
+  visible = [[NSScreen mainScreen] visibleFrame];
+  if (NSMaxY(rect) > NSMaxY(visible))
+    {
+      rect.origin.y -= (NSMaxY(rect) - NSMaxY(visible));
+    }
+  if (NSMinY(rect) < NSMinY(visible))
+    {
+      rect.origin.y += (NSMinY(visible) - NSMinY(rect));
+    }
+  if (NSMaxY(rect) > NSMaxY(visible))
+    {
+      rect.origin.y = visible.origin.y;
+      rect.size.height = visible.size.height;
+    }
+    
+  if (NSMaxX(rect) > NSMaxX(visible))
+    {
+      rect.origin.x -= (NSMaxX(rect) - NSMaxX(visible));
+    }
+  if (NSMinX(rect) < NSMinX(visible))
+    {
+      rect.origin.x += (NSMinX(visible) - NSMinX(rect));
+    }
+  if (NSMaxX(rect) > NSMaxX(visible))
+    {
+      rect.origin.x = visible.origin.x;
+      rect.size.width = visible.size.width;
+    }
+  offset.height = rect.origin.y - mouseLocation.y;
+  offset.width = rect.origin.x - mouseLocation.x;
+
+  window = [[NSWindow alloc] initWithContentRect: rect
+				       styleMask: NSBorderlessWindowMask
+					 backing: NSBackingStoreRetained
+					   defer: YES];
+
+  color
+    = [NSColor colorWithDeviceRed: 1.0 green: 1.0 blue: 0.90 alpha: 1.0];
+  [window setBackgroundColor: color];
+  [window setReleasedWhenClosed: YES];
+  [window setExcludedFromWindowsMenu: YES];
+  [window setLevel: NSStatusWindowLevel];
+
+  [window orderFront: nil];
+
+  [self _drawText: toolTipText];
+  RELEASE(toolTipText);
 }
 
 @end