Fix #117116: Online manual option not working in context menu #117237

Philipp Oeser · 2024-01-17T16:34:46+01:00

Philipp Oeser commented

2024-01-17 16:34:46 +01:00

This was the case when the context menu was spawned from a button in a
menu that was in turn spawned via WM_OT_call_menu.
Then, UI_context_active_but_get (or
UI_context_active_but_get_respect_menu even) are not getting an active
button.
Reason for this is that the current context region (or the region stored
in the popup) is freed from its blocks somewhere along the way when
actually executing the operator. The code around nested menus is a bit
hard to follow, the underlying issue (not having a valid region in
context to work with at all times) should definitely be solved (for
another reason, see NOTE / DOWNSIDE below).

However, there is another way to solve this, and this is calling
doc_view_manual directly with its doc_id set already (the doc_id
is already available when building the context menu, used for the
Online Python Reference).

NOTE: the same failure is true for Copy Python Command -- and the
"workaround fix" is a bit more work there (it does not have a vairiant
not using the context buttons).

DOWNSIDE: we loose the shortcut (F1) shown in the context menu, because
that still needs to point to doc_view_manual_ui_context

This was the case when the context menu was spawned from a button in a menu that was in turn spawned via `WM_OT_call_menu`. Then, `UI_context_active_but_get` (or `UI_context_active_but_get_respect_menu` even) are not getting an active button. Reason for this is that the current context region (or the region stored in the popup) is freed from its blocks _somewhere_ along the way when actually executing the operator. The code around nested menus is a bit hard to follow, the underlying issue (not having a valid region in context to work with at all times) should definitely be solved (for another reason, see NOTE / DOWNSIDE below). However, there is another way to solve this, and this is calling `doc_view_manual` directly with its `doc_id` set already (the `doc_id` is already available when building the context menu, used for the `Online Python Reference`). NOTE: the same failure is true for `Copy Python Command` -- and the "workaround fix" is a bit more work there (it does not have a vairiant **not** using the context buttons). DOWNSIDE: we loose the shortcut (F1) shown in the context menu, because that still needs to point to `doc_view_manual_ui_context`

Philipp Oeser added 1 commit 2024-01-17 16:34:55 +01:00

f0ed536672 Fix #117116 : Online manual option not working in context menu

This was the case when the context menu was spawned from a button in a
menu that was in turn spawned via `WM_OT_call_menu`.
Then, `UI_context_active_but_get` (or
`UI_context_active_but_get_respect_menu` even) are not getting an active
button.
Reason for this is that the current context region (or the region stored
in the popup) is freed from its blocks _somewhere_ along the way when
actually executing the operator. The code around nested menus is a bit
hard to follow, the underlying issue (not having a valid region in
context to work with at all times) should definitely be solved (for
another reason, see NOTE / DOWNSIDE below).

However, there is another way to solve this, and this is calling
`doc_view_manual` directly with its `doc_id` set already (the `doc_id`
is already available when building the context menu, used for the
`Online Python Reference`).

NOTE: the same failure is true for `Copy Python Command` -- and the
"workaround fix" is a bit more work there (it does not have a vairiant
**not** using the context buttons).

DOWNSIDE: we loose the shortcut (F1) shown in the context menu, because
that still needs to point to `doc_view_manual_ui_context`

Philipp Oeser referenced this pull request

2024-01-17 16:35:40 +01:00

Some operators (e.g. "Online manual", "Reset to Default Value", "Copy Data Path", "Copy Python Command", ...) not working in context menu spawned from certain popups (operator dialogs, context menus, ...) #117116

Philipp Oeser added this to the User Interface project 2024-01-18 13:14:36 +01:00

Pratik Borhade commented

2024-01-19 12:09:43 +01:00

Hi, this indeed fixes the problem. WM_OT_doc_view_manual_ui_context can be removed then?

I never used F1 for searching docs but others might be using it regularly.

(not sure whom to ask for review: Pablo/Harley?)

Hi, this indeed fixes the problem. `WM_OT_doc_view_manual_ui_context` can be removed then? I never used `F1` for searching docs but others might be using it regularly. (not sure whom to ask for review: Pablo/Harley?)

Merge conflict checking is in progress. Try again in few moments.

View command line instructions.

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u 117116_c:lichtwerk-117116_c

git checkout lichtwerk-117116_c

Sign in to join this conversation.

No reviewers

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Fix #117116: Online manual option not working in context menu #117237

Checkout