Fix #128231: Wrong padding for gizmo and menu tooltips #128243

Pratik Borhade · 2024-09-27T12:42:54+02:00

Pratik Borhade commented

2024-09-27 12:42:54 +02:00

This is due to wrong is_pad is passed as argument. It should be false
for gizmo tooltips. For menus when fields size is zero i.e. no
element is appended yet, the python message will be at the top of
tooltip region.

This is due to wrong `is_pad` is passed as argument. It should be false for gizmo tooltips. For menus when fields size is zero i.e. no element is appended yet, the python message will be at the top of tooltip region.

Pratik Borhade requested review from Harley Acheson 2024-09-27 12:43:17 +02:00

Pratik Borhade added the

Module

User Interface

label 2024-09-27 12:43:25 +02:00

Pratik Borhade requested review from Pablo Vazquez 2024-09-27 12:43:34 +02:00

Pratik Borhade referenced this pull request

2024-09-27 12:43:54 +02:00

Tooltips unnecessary large padding #128231

Harley Acheson commented

2024-09-27 17:57:08 +02:00

Good find. That "is_pad" only adds a space above the item being added, so shouldn't happen for UI_TIP_STYLE_HEADER.

Note for the change in ui_tooltip_data_from_gizmo (1178) you could just remove that argument since it has a default value of false. Whatever you find more readable.

I'm curious about the proposed change at ui_tooltip_data_from_button_or_extra_icon (1041). Is there something special about that one versus other instances of items added with is_pad true in the same function?

Good find. That "is_pad" only adds a space above the item being added, so shouldn't happen for UI_TIP_STYLE_HEADER. Note for the change in `ui_tooltip_data_from_gizmo` (1178) you could just remove that argument since it has a default value of false. Whatever you find more readable. I'm curious about the proposed change at `ui_tooltip_data_from_button_or_extra_icon` (1041). Is there something special about that one versus other instances of items added with is_pad true in the same function?

Pratik Borhade commented

2024-10-04 13:40:02 +02:00

I'm curious about the proposed change at ui_tooltip_data_from_button_or_extra_icon (1041). Is there something special about that one versus other instances of items added with is_pad true in the same function?

Yes. Padding for python tip is useful if it has any content above it ([0]).
In other cases[1], when no other content is printed in tooltip-region, padding to python tip would misalign the text.

[0]: Example: Auto keyframing panel (downarrow)
[1]: Example: Object menu in header: When menu button already has the label, tooltip-region ignores that text:

		source/blender/editors/interface/regions/interface_region_tooltip.cc
		Lines 852 to 860 in c1634dbe4b
	
				  /* Regular (non-custom) label. Only show when the button doesn't already show the label. Check

				   * prefix instead of comparing because the button may include the shortcut. Buttons with dynamic

				   * tool-tips also don't get their default label here since they can already provide more accurate

				   * and specific tool-tip content. */

				  else if (!but_label.empty() && !blender::StringRef(but->drawstr).startswith(but_label) &&

				           !but->tip_func)

				  {

				    UI_tooltip_text_field_add(*data, but_label, {}, UI_TIP_STYLE_HEADER, UI_TIP_LC_NORMAL);

				  }

> I'm curious about the proposed change at ui_tooltip_data_from_button_or_extra_icon (1041). Is there something special about that one versus other instances of items added with is_pad true in the same function? Yes. Padding for python tip is useful if it has any content above it ([0]). In other cases[1], when no other content is printed in tooltip-region, padding to python tip would misalign the text. [0]: Example: Auto keyframing panel (downarrow) [1]: Example: Object menu in header: When menu button already has the label, tooltip-region ignores that text: https://projects.blender.org/blender/blender/src/commit/c1634dbe4b2742c2066dc4493e69604e63f591fe/source/blender/editors/interface/regions/interface_region_tooltip.cc#L852-L860

Harley Acheson commented

2024-10-04 18:45:02 +02:00

@blender-bot build