OperatorType's get_name callback is useless with any layout-based API-defined UI code. #112253

New Issue

Bastien Montagne · 2023-09-11T20:32:12+02:00

Bastien Montagne commented

2023-09-11 20:32:12 +02:00

The wmOperatorType.get_name callback is currently useless in a vast majority of cases, due to how layout-based UI code currently works (see e.g. the call to WM_operatortype_name in uiItemFullO_ptr_ex): this callback is never called as part of the definition of the button, because no operator properties have been set yet.

An initial quick attempt to implement this as part of post-processing in UI_block_end uncovered at least two issues:

The button does not currently know whether its label was set by calling code, or automatically defined (from operator type here).
A lot of layout code relies on the required size to fit the label text, changing that text later on when finalizing the block will break all of the layout work.

While issue 1. seems relatively easy to address (this info could be stored as a button flag or so), the issue 2. looks harder to address.

NOTE: This was found out while investigating solutions for !112246.

The `wmOperatorType.get_name` callback is currently useless in a vast majority of cases, due to how layout-based UI code currently works (see e.g. the call to `WM_operatortype_name` in `uiItemFullO_ptr_ex`): this callback is never called as part of the definition of the button, because no operator properties have been set yet. An initial quick attempt to implement this as part of post-processing in `UI_block_end` uncovered at least two issues: 1. The button does not currently know whether its label was set by calling code, or automatically defined (from operator type here). 2. A lot of layout code relies on the required size to fit the label text, changing that text later on when finalizing the block will break all of the layout work. While issue 1. seems relatively easy to address (this info could be stored as a button flag or so), the issue 2. looks harder to address. NOTE: This was found out while investigating solutions for !112246.

Bastien Montagne added the

labels 2023-09-11 20:32:12 +02:00

Bastien Montagne commented

2023-09-11 20:32:51 +02:00

@JulianEisel FYI.

In the meantime, will update to documentation of the get_name callback about this limitation.

@JulianEisel FYI. In the meantime, will update to documentation of the `get_name` callback about this limitation.

Bastien Montagne referenced this issue from a commit