[Windows 11] MenuItem with style SWT.CHECK and image doesn't show state #501

Phillipus · 2022-12-14T21:48:48Z

Windows 11
Eclipse 4.26

Run this Snippet on Windows 10 and Window 11 and compare the drop down menu after selecting it:

import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.MenuItem;
import org.eclipse.swt.widgets.Shell;

public class MenuImageTest {
    
	public static void main(String[] args) {
		final Display display = new Display();
		Shell shell = new Shell(display);
		shell.setText("Menu Image Test");
		
		Menu appMenuBar = display.getMenuBar();
		if(appMenuBar == null) {
			appMenuBar = new Menu(shell, SWT.BAR);
			shell.setMenuBar(appMenuBar);
		}
		
		MenuItem file = new MenuItem(appMenuBar, SWT.CASCADE);
		file.setText("File");
		
		Menu dropdown = new Menu(appMenuBar);
		file.setMenu(dropdown);
		
		MenuItem testMenu = new MenuItem(dropdown, SWT.CHECK);
		testMenu.setImage(new Image(display, MenuImageTest.class.getResourceAsStream("image.png")));
		testMenu.setText("Test Menu");
		
		shell.open();
		
		while (!shell.isDisposed()) {
			if (!display.readAndDispatch())
				display.sleep();
		}
		display.dispose();
	}
}

Use an image for image.png such as:

On Windows 10 selected state looks like this:

In Windows 11 selected state looks like this:

The text was updated successfully, but these errors were encountered:

- See eclipse-platform/eclipse.platform.swt#501

SyntevoAlex · 2022-12-24T15:22:09Z

SyntevoAlex · 2022-12-24T15:27:10Z

The screenshot above shows a difference between

SWT.CHECK menu with .setImage()
regular SWT.CHECK menu

It seems that on Win11, theme decided to no longer paint blue square around the icon, hence the difference. I would say that the other problem here is that the image is always painted, whether checked or not.

Phillipus · 2022-12-24T15:34:27Z

I would say that the other problem here is that the image is always painted, whether checked or not.

Isn't that the expected behaviour?

SyntevoAlex · 2022-12-24T15:36:08Z

Looking at the default check mark (in regular SWT.CHECK menu without .setImage()) I would say that check image shall only appear when item is checked.

SyntevoAlex · 2022-12-24T17:03:33Z

Studied the code more. It turns out that check and image are independent things. SWT even tries to manipulate MNS_CHECKORBMP style in attempt to save space when menu only has images and no checks.

However, since XP theming, Windows seems to ignore that; it always paints check and image at the same spot.

Here's a screenshot of a native snippet on Win7, using disable visual themes compatibility flag. On the left, flag is enabled (that is, XP theming disabled). On the right, flag is disabled (that is, XP theming enabled). The "up arrow" image is just a random image I grabbed.

It can be seen that same code, on same Windows, behaves differently based on XP theming.

SyntevoAlex · 2022-12-24T17:08:51Z

For comparison, same native snippet on Win11. It can be seen that checked image item looks the same as non-checked image item. Just like in SWT.

SyntevoAlex · 2022-12-24T17:09:14Z

Conclusions: Windows theming issue, not an SWT bug.

Phillipus · 2023-01-15T16:55:37Z

Conclusions: Windows theming issue, not an SWT bug.

If so, should we close this?

SyntevoAlex · 2023-01-15T17:51:04Z

Probably.

Phillipus · 2023-01-15T17:51:53Z

Closing...

BeckerWdf · 2023-06-21T13:55:57Z

Conclusions: Windows theming issue, not an SWT bug.

What does that mean? You mean it's a bug of Windows?

SyntevoAlex · 2023-06-21T15:02:17Z

It's hard to say if it's a "bug" or "design decision". SWT relies on how Windows styled things, but Windows decided to style it differently in Win11. Will that decision be reverted in Win11? Who knows

BeckerWdf · 2023-06-22T07:37:15Z

It's hard to say if it's a "bug" or "design decision". SWT relies on how Windows styled things, but Windows decided to style it differently in Win11. Will that decision be reverted in Win11? Who knows

Could we "work around" this in SWT? Or can we open a bug report at MS?

tmssngr · 2023-06-22T09:45:45Z

It should be easy to work around (not perfectly, but good enough) using this (partly) pseudo-code

final int margin = getDpiScalingFactor(display);
final Rectangle size = image.getBounds();
final Image selectedImage = new Image(image.getDevice(), size.width + 2 * margin, size.height + 2 * margin);
final GC gc = new GC(selectedImage);
try {
	final Color background = createBlendedColor(image.getDevice().getSystemColor(SWT.COLOR_LIST_BACKGROUND),
	                                            image.getDevice().getSystemColor(SWT.COLOR_LIST_SELECTION), 0.25);
	gc.setBackground(background);
	gc.fillRectangle(0, 0, size.width + 2 * margin, size.height + 2 * margin);
	gc.drawImage(image, margin, margin);
}
finally {
	gc.dispose();
}

Gudi-24 · 2023-06-22T09:46:14Z

It is very easy to say that this is a bug! Even if you like to call it "design decision" to hide important information, it is still a bug. For example in the junit view it is not possible to see any more which layout (horizontally, vertically or automatically) is currently applied.
Please reopen this issue and implement a solution!

Phillipus · 2023-06-22T09:47:38Z

Please reopen this issue and implement a solution!

Are you able to provide a solution and pull request?

tmssngr · 2023-06-22T09:50:45Z

Please reopen this issue and implement a solution!

Maybe you misunderstood Alex. He told that the problem occurs with pure native code, too, so this is no bug in SWT, but rather in Windows (if Microsoft not intentionally changed this). You need to send your request for a solution to Microsoft!

Alternatively, SWT is open source - please feel free to send a pull request with the solution.

Gudi-24 · 2023-06-22T10:01:09Z

Please reopen this issue and implement a solution!

Maybe you misunderstood Alex. He told that the problem occurs with pure native code, too, so this is no bug in SWT, but rather in Windows (if Microsoft not intentionally changed this). You need to send your request for a solution to Microsoft!

One thing is for sure: There is a bug in Eclipse! And this is independent from the fact if I send a pull request or not!

Phillipus · 2023-06-22T10:03:16Z

One thing is for sure: There is a bug in Eclipse! And this is independent from the fact if I send a pull request or not!

What part of "this is no bug in SWT, but rather in Windows" do you not understand?

Gudi-24 · 2023-06-22T10:13:51Z

One thing is for sure: There is a bug in Eclipse! And this is independent from the fact if I send a pull request or not!

What part of "this is no bug in SWT, but rather in Windows" do you not understand?

Well, I understand that, but it doesn't help. Because most probably it won't be fixed by Windows and then the bug will stay in many eclipse views. And this is a major problem. Or do you have a different opinion?

Phillipus · 2023-06-22T10:18:55Z

Or do you have a different opinion?

If this is how it is because of a change in Windows 11, as @SyntevoAlex explains above, then you're out of luck. However, if you want to implement a workaround then I suggest to follow the suggested code hint from @tmssngr in the comment above.

BeckerWdf · 2023-06-22T10:50:27Z

It should be easy to work around (not perfectly, but good enough) using this (partly) pseudo-code

final int margin = getDpiScalingFactor(display);
final Rectangle size = image.getBounds();
final Image selectedImage = new Image(image.getDevice(), size.width + 2 * margin, size.height + 2 * margin);
final GC gc = new GC(selectedImage);
try {
	final Color background = createBlendedColor(image.getDevice().getSystemColor(SWT.COLOR_LIST_BACKGROUND),
	                                            image.getDevice().getSystemColor(SWT.COLOR_LIST_SELECTION), 0.25);
	gc.setBackground(background);
	gc.fillRectangle(0, 0, size.width + 2 * margin, size.height + 2 * margin);
	gc.drawImage(image, margin, margin);
}
finally {
	gc.dispose();
}

Can we put this into SWT? I understand that this is a bug or design decision of MS but I also see that Eclipse (and other SWT-based apps really have an issue with it. So I think it's work to fix this in SWT.
What do you think?

Phillipus · 2023-06-22T18:10:51Z

As there is an active interest in this issue, let's re-open it so it's visible.

merks · 2023-06-22T18:41:19Z

I don’t think anybody will care whose fault the problem is. If I can’t tell whether a menu item in my Eclipse application is checked or not then my perception will be that it’s a bug and a really bad one at that. We could tell 100,000 users it’s someone else’s fault but do we want to tell them we can’t do anything about it? Or worse that we don’t want to do anything about it. Of course it’s free so no one is obligated to do anything.

Phillipus · 2023-07-04T15:08:29Z

It turns out that some of my images are not centred in themselves, even though they're the same size.

Try this snippet:

import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.MenuItem;
import org.eclipse.swt.widgets.Shell;

public class MenuImageTest {
    
	public static void main(String[] args) {
		final Display display = new Display();
		Shell shell = new Shell(display);
		shell.setText("Menu Image Test");
		shell.setBounds(200, 200, 200, 200);
		
		Menu appMenuBar = display.getMenuBar();
		if(appMenuBar == null) {
			appMenuBar = new Menu(shell, SWT.BAR);
			shell.setMenuBar(appMenuBar);
		}
		
		MenuItem file = new MenuItem(appMenuBar, SWT.CASCADE);
		file.setText("File");
		
		Menu dropdown = new Menu(appMenuBar);
		file.setMenu(dropdown);
		
		Image image = new Image(display, MenuImageTest.class.getResourceAsStream("image.png"));
		
		for(int i = 0; i < 6; i++) {
		    MenuItem m = new MenuItem(dropdown, SWT.CHECK);
	        m.setImage(image);
	        m.setText("Test Menu");
	        m.setSelection(true);
        }
		
		shell.open();
		
		while (!shell.isDisposed()) {
			if (!display.readAndDispatch())
				display.sleep();
		}
		display.dispose();
	}
}

With this image.png

Now gives this result, unchecked and checked:

laeubi · 2023-07-04T15:09:51Z

@Phillipus any chance to post a screenshot good / bad to see the difference?

SyntevoAlex · 2023-07-04T15:10:03Z

So the approach works fine and has now apparent problems?

Phillipus · 2023-07-04T15:12:03Z

So the approach works fine and has now apparent problems?

Problems I see:

Space is taken even if not checked
Needs more margin between image and text

SyntevoAlex · 2023-07-04T15:15:01Z

Space is taken even if not checked

This doesn't sound like a problem to me.
Afterall checkbox needs to live somewhere.
Saving some space in a menu where ALL items are not checked sounds more like a problem to me: menus would look different.

Needs more margin between image and text

Just add a few pixels in MenuItem.wmMeasureChild

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

Lines 1175 to 1178 in 7d58a7d

    
           if (image != null) { 
        
           	Rectangle rect = image.getBoundsInPixels (); 
        
           	width = rect.width; 
        
           	height = rect.height;

iloveeclipse · 2023-07-04T15:15:25Z

Problems I see:

Space is taken even if not checked

Needs more margin between image and text

Compared with current state (no indication of checked state at all) we probably should accept the problems.
WDYT? PR for M1?

Phillipus · 2023-07-04T15:15:38Z

Saving some space in a menu where ALL items are not checked sounds more like a problem to me

That's how it works on Mac.

Phillipus · 2023-07-04T15:16:27Z

Compared with current state (no indication of checked state at all) we probably should accept the problems.
WDYT? PR for M1?

As it's a Windows 11 issue, Windows 10 users might not like the change.

SyntevoAlex · 2023-07-04T15:18:24Z

The change in code can be guarded with OS.WIN32_BUILD >= OS.WIN32_BUILD_WIN11_21H2

SyntevoAlex · 2023-07-04T15:19:19Z

Also, this code should only be enabled if a menu has items with both SWT.CHECK and an image.

iloveeclipse · 2023-07-04T15:19:59Z

@SyntevoAlex : would you please push a patch we can check?

SyntevoAlex · 2023-07-04T15:21:16Z

To my knowledge, our product doesn't use this scenario (menu items that have both image and SWT.CHECK). For this reason, I won't be able to contribute a workaround.

I think my boss will complain if I do :)

tmssngr · 2023-07-05T05:12:15Z

Now gives this result, unchecked and checked:

If this look is considered bad, how it should look like in good state? Our products use no images in menus and these look similar (Windows 10, 4k monitor):

Phillipus · 2023-07-05T06:38:33Z

If this look is considered bad, how it should look like in good state?

It looked bad when my images were not aligned. Using the same image it's better. It now needs a couple more pixels margin between the image and the text.

Phillipus · 2023-07-05T06:42:52Z

Maybe it would be better to figure out how to draw the (blue) highlight around the checked image, as it's done now in Windows 10. If it had worked like that from the get go in 11, this would not be an issue.

Phillipus · 2023-07-05T07:35:03Z

Another problem I just noticed is that menu item heights are smaller if using the tick and image. I think W11 theme uses bigger menu item heights.

Phillipus · 2023-07-05T10:30:01Z

And with accelerator text (mnemonic) things are a bit squashed:

And the menu background is different.

Basically, if theming is not used it looks bad and doesn't look like a native W11 menu.

ShahzaibIbrahim · 2023-11-27T13:19:23Z

Have we found any acceptable resolution for this? I would like to hear it as this relates to my issue: https://github.com/vi-eclipse/Eclipse-JDT/issues/15

merks · 2023-11-27T13:23:42Z

Sorry, no. I have not had time to work on this, despite good intentions to do so. I'm still on Windows 10 so I still avoid the issue. 😱

tmssngr · 2023-11-27T13:52:18Z

@ShahzaibIbrahim: maybe a workaround would help you for the moment?

It should be easy to work around (not perfectly, but good enough) using this (partly) pseudo-code

final int margin = getDpiScalingFactor(display);
final Rectangle size = image.getBounds();
final Image selectedImage = new Image(image.getDevice(), size.width + 2 * margin, size.height + 2 * margin);
final GC gc = new GC(selectedImage);
try {
	final Color background = createBlendedColor(image.getDevice().getSystemColor(SWT.COLOR_LIST_BACKGROUND),
	                                            image.getDevice().getSystemColor(SWT.COLOR_LIST_SELECTION), 0.25);
	gc.setBackground(background);
	gc.fillRectangle(0, 0, size.width + 2 * margin, size.height + 2 * margin);
	gc.drawImage(image, margin, margin);
}
finally {
	gc.dispose();
}

wuendi · 2024-03-14T21:02:05Z

Is there any plan to fix the issue in June 2024? When more customers are starting to use Windows 11, this issue causes a lot of confusion as no indicator shows menu is selected or not

iloveeclipse · 2024-04-14T16:11:23Z

Is there any plan to fix the issue in June 2024? When more customers are starting to use Windows 11, this issue causes a lot of confusion as no indicator shows menu is selected or not

This is an open source project and every change can be moved forward by contributing a fix.
Feel free to contribute one, may be based on workaround proposed here.

Phillipus added a commit to archimatetool/archi that referenced this issue Dec 14, 2022

Don't use an mage in Search menu items on Windows 11

efb42b8

- See eclipse-platform/eclipse.platform.swt#501

Phillipus added a commit to archimatetool/archi that referenced this issue Dec 14, 2022

Don't use an image in Search menu items on Windows 11

6333189

- See eclipse-platform/eclipse.platform.swt#501

Phillipus added a commit to archimatetool/archi that referenced this issue Dec 14, 2022

Don't use an image in Search menu items on Windows 11

2c6b38b

- See eclipse-platform/eclipse.platform.swt#501

Phillipus closed this as completed Jan 15, 2023

Phillipus mentioned this issue Feb 1, 2023

Selection of the image is missing in Menuitem with radio option and image in Windows 11 #543

Open

Phillipus reopened this Jun 22, 2023

merks mentioned this issue Sep 6, 2023

[Eclipse 4.28] Toggled State for view menu actions with Icon not visible in Win 11 eclipse-platform/eclipse.platform.ui#1083

Closed

fedejeanne mentioned this issue Nov 27, 2023

Change title from "Skip All Breakpoints" to "Unskip All Breakpoints" when toggled vi-eclipse/Eclipse-JDT#15

Open

ShahzaibIbrahim mentioned this issue Dec 5, 2023

Change action name from "Skip All Breakpoints" to "Toggle Skip All Breakpoints" eclipse-platform/eclipse.platform#864

Closed

merks mentioned this issue Dec 18, 2023

Windows 11: Selection is not visible in MenuItem with image of type "check" #946

Closed

HeikoKlare mentioned this issue Feb 12, 2024

Change action name from "Skip All Breakpoints" to "Toggle Skip All eclipse-platform/eclipse.platform.releng.aggregator#1559

Draft

iloveeclipse added help wanted Extra attention is needed bug Something isn't working Windows Happens on Windows OS labels Apr 14, 2024

[Windows 11] MenuItem with style SWT.CHECK and image doesn't show state #501

[Windows 11] MenuItem with style SWT.CHECK and image doesn't show state #501

Comments

Phillipus commented Dec 14, 2022

SyntevoAlex commented Dec 24, 2022

SyntevoAlex commented Dec 24, 2022

Phillipus commented Dec 24, 2022

SyntevoAlex commented Dec 24, 2022

SyntevoAlex commented Dec 24, 2022 • edited Loading

SyntevoAlex commented Dec 24, 2022 • edited Loading

SyntevoAlex commented Dec 24, 2022

Phillipus commented Jan 15, 2023

SyntevoAlex commented Jan 15, 2023

Phillipus commented Jan 15, 2023

BeckerWdf commented Jun 21, 2023

SyntevoAlex commented Jun 21, 2023

BeckerWdf commented Jun 22, 2023

tmssngr commented Jun 22, 2023 • edited Loading

Gudi-24 commented Jun 22, 2023 • edited Loading

Phillipus commented Jun 22, 2023

tmssngr commented Jun 22, 2023 • edited Loading

Gudi-24 commented Jun 22, 2023 • edited Loading

Phillipus commented Jun 22, 2023

Gudi-24 commented Jun 22, 2023

Phillipus commented Jun 22, 2023 • edited Loading

BeckerWdf commented Jun 22, 2023

Phillipus commented Jun 22, 2023

merks commented Jun 22, 2023

Phillipus commented Jul 4, 2023 • edited Loading

laeubi commented Jul 4, 2023

SyntevoAlex commented Jul 4, 2023

Phillipus commented Jul 4, 2023

SyntevoAlex commented Jul 4, 2023 • edited Loading

iloveeclipse commented Jul 4, 2023

Phillipus commented Jul 4, 2023

Phillipus commented Jul 4, 2023 • edited Loading

SyntevoAlex commented Jul 4, 2023

SyntevoAlex commented Jul 4, 2023

iloveeclipse commented Jul 4, 2023

SyntevoAlex commented Jul 4, 2023

tmssngr commented Jul 5, 2023 • edited Loading

Phillipus commented Jul 5, 2023

Phillipus commented Jul 5, 2023

Phillipus commented Jul 5, 2023

Phillipus commented Jul 5, 2023 • edited Loading

ShahzaibIbrahim commented Nov 27, 2023

merks commented Nov 27, 2023

tmssngr commented Nov 27, 2023

wuendi commented Mar 14, 2024

iloveeclipse commented Apr 14, 2024

SyntevoAlex commented Dec 24, 2022 •

edited

Loading

SyntevoAlex commented Dec 24, 2022 •

edited

Loading

tmssngr commented Jun 22, 2023 •

edited

Loading

Gudi-24 commented Jun 22, 2023 •

edited

Loading

tmssngr commented Jun 22, 2023 •

edited

Loading

Gudi-24 commented Jun 22, 2023 •

edited

Loading

Phillipus commented Jun 22, 2023 •

edited

Loading

Phillipus commented Jul 4, 2023 •

edited

Loading

SyntevoAlex commented Jul 4, 2023 •

edited

Loading

Phillipus commented Jul 4, 2023 •

edited

Loading

tmssngr commented Jul 5, 2023 •

edited

Loading

Phillipus commented Jul 5, 2023 •

edited

Loading