MNT: Clean up macosx backend set_message

greglucas · greglucas · commit e14107f9fc5a · 2021-11-26T21:45:33.000-07:00
Remove some unnecessary calculations and add some comments. Switch
to string passing since we are guaranteed UTF-8 with Python 3 now.
diff --git a/lib/matplotlib/backends/backend_macosx.py b/lib/matplotlib/backends/backend_macosx.py
@@ -116,9 +116,6 @@ def prepare_configure_subplots(self):
         _tool = SubplotTool(self.canvas.figure, toolfig)
         return canvas
 
-    def set_message(self, message):
-        _macosx.NavigationToolbar2.set_message(self, message.encode('utf-8'))
-
 
 @_Backend.export
 class _BackendMac(_Backend):
diff --git a/src/_macosx.m b/src/_macosx.m
@@ -1085,22 +1085,21 @@ -(void)save_figure:(id)sender
     [self->handler installCallbacks: actions forButtons: buttons];
 
     NSFont* font = [NSFont systemFontOfSize: 0.0];
-    rect.size.width = 300;
-    rect.size.height = 0;
-    rect.origin.x += height;
-    NSTextView* messagebox = [[NSTextView alloc] initWithFrame: rect];
+    // rect.origin.x is now at the far right edge of the buttons
+    // we want the messagebox to take up the rest of the toolbar area
+    rect.size.width = bounds.size.width - rect.origin.x;
+    rect.origin.x = bounds.size.width - rect.size.width;
+    NSTextView* messagebox = [[[NSTextView alloc] initWithFrame: rect] autorelease];
     if (@available(macOS 10.11, *)) {
         messagebox.textContainer.maximumNumberOfLines = 2;
         messagebox.textContainer.lineBreakMode = NSLineBreakByTruncatingTail;
+        messagebox.alignment = NSTextAlignmentRight;
     }
     [messagebox setFont: font];
     [messagebox setDrawsBackground: NO];
     [messagebox setSelectable: NO];
     /* if selectable, the messagebox can become first responder,
      * which is not supposed to happen */
-    rect = [messagebox frame];
-    rect.origin.y = 0.5 * (height - rect.size.height);
-    [messagebox setFrameOrigin: rect.origin];
     [[window contentView] addSubview: messagebox];
     [messagebox release];
     [[window contentView] display];
@@ -1130,25 +1129,29 @@ -(void)save_figure:(id)sender
 {
     const char* message;
 
-    if (!PyArg_ParseTuple(args, "y", &message)) { return NULL; }
+    if (!PyArg_ParseTuple(args, "s", &message)) { return NULL; }
 
     NSTextView* messagebox = self->messagebox;
 
     if (messagebox) {
         NSString* text = [NSString stringWithUTF8String: message];
         [messagebox setString: text];
 
-        // Adjust width with the window size
+        // Adjust width and height with the window size and content
         NSRect rectWindow = [messagebox.superview frame];
         NSRect rect = [messagebox frame];
+        // Entire region to the right of the buttons
         rect.size.width = rectWindow.size.width - rect.origin.x;
         [messagebox setFrame: rect];
-
-        // Adjust height with the content size
+        // We want to control the vertical position of
+        // the rect by the content size to center it vertically
+        // TODO: This seems to disable the cursor updates with newlines that
+        //       are included in the image hover text. It is only when trying
+        //       to set the frame height based on the contentRect's size.
         [messagebox.layoutManager ensureLayoutForTextContainer: messagebox.textContainer];
-        NSRect contentSize = [messagebox.layoutManager usedRectForTextContainer: messagebox.textContainer];
-        rect = [messagebox frame];
-        rect.origin.y = 0.5 * (self->height - contentSize.size.height);
+        NSRect contentRect = [messagebox.layoutManager usedRectForTextContainer: messagebox.textContainer];
+        rect.origin.y = 0.5 * (self->height - contentRect.size.height);
+        rect.size.height = contentRect.size.height;
         [messagebox setFrame: rect];
     }
 
