MenuItem Image Scaling with DPI aware metrics #62

This commit contributes to scaling of the MenuItem::hBitmap with the DPI
-aware System Metrics for the size of the SM_CYMENUCHECK or the size
obtained by menuItem zoom. It also corrects the zoom in specific cases
where the images are not consistently drawn on the context menu.

Contributes to
#62 and
#127

Author: amartya4256

bundles/org.eclipse.swt/Eclipse SWT PI/win32/org/eclipse/swt/internal/win32/OS.java

@@ -1248,6 +1248,7 @@ public class OS extends C {
 	public static final int SM_CYFOCUSBORDER = 84;
 	public static final int SM_CYHSCROLL = 0x3;
 	public static final int SM_CYMENU = 0xf;
+	public static final int SM_CYMENUCHECK = 72;
 	public static final int SM_CXMINTRACK = 34;
 	public static final int SM_CYMINTRACK = 35;
 	public static final int SM_CXMAXTRACK = 59;

bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/MenuItem.java

@@ -781,8 +781,7 @@ public void setImage (Image image) {
 		info.hbmpItem = OS.HBMMENU_CALLBACK;
 	} else {
 		if (OS.IsAppThemed ()) {
-			if (hBitmap != 0) OS.DeleteObject (hBitmap);
-			info.hbmpItem = hBitmap = image != null ? Display.create32bitDIB (image, getZoom()) : 0;
+			info.hbmpItem = hBitmap = getMenuItemIconBitmapHandle(image);
 		} else {
 			info.hbmpItem = image != null ? OS.HBMMENU_CALLBACK : 0;
 		}
@@ -792,6 +791,52 @@ public void setImage (Image image) {
 	parent.redraw ();
 }
 
+private long getMenuItemIconBitmapHandle(Image image) {
+	if (image == null) {
+		return 0;
+	}
+	if (hBitmap != 0) OS.DeleteObject (hBitmap);
+	int zoom = adaptZoomForMenuItem(getZoom());
+	return Display.create32bitDIB (image, zoom);
+}
+
+private int adaptZoomForMenuItem(int currentZoom) {
+	int primaryMonitorZoomAtAppStartUp = getPrimaryMonitorZoomAtStartup();
+	/*
+	 * Windows has inconsistent behavior when setting the size of MenuItem image and
+	 * hence we need to adjust the size of the images as per different kind of zoom
+	 * level, i.e. full (100s), half (50s) and quarter (25s). The image size per
+	 * zoom level is also affected by the primaryMonitorZoomAtAppStartUp. The
+	 * implementation below is based on the pattern observed for all the zoom values
+	 * and what fits the best for these zoom level types.
+	 */
+	if (primaryMonitorZoomAtAppStartUp > currentZoom && isQuarterZoom(currentZoom)) {
+		return currentZoom - 25;
+	}
+	if (!isHalfZoom(primaryMonitorZoomAtAppStartUp) && isHalfZoom(currentZoom)) {
+		// Use the size recommended by System Metrics. This value only holds
+		// for this case and does not work consistently for other cases.
+		double expectedSize = getSystemMetrics(OS.SM_CYMENUCHECK);
+		return (int) ((expectedSize / image.getBounds().height) * 100);
+	}
+	return currentZoom;
+}
+
+private static boolean isHalfZoom(int zoom) {
+	return zoom % 50 == 0 && zoom % 100 != 0;
+}
+
+private static boolean isQuarterZoom(int zoom) {
+	return zoom % 10 != 0 && zoom % 25 == 0;
+}
+
+private static int getPrimaryMonitorZoomAtStartup() {
+	long hDC = OS.GetDC(0);
+	int dpi = OS.GetDeviceCaps(hDC, OS.LOGPIXELSX);
+	OS.ReleaseDC(0, hDC);
+	return DPIUtil.mapDPIToZoom(dpi);
+}
+
 /**
  * Sets the receiver's pull down menu to the argument.
  * Only <code>CASCADE</code> menu items can have a