Proposed Custom Confirmation Dialogs #106691

New Issue

Harley Acheson · 2023-04-07T21:52:17+02:00

Harley Acheson commented

2023-04-07 21:52:17 +02:00

Although we try to avoid blocking operations there are times when we must pause in order to confirm with the user before proceeding with potentially harmful operations. For example when we load Defaults, Delete data, etc.

We currently have only two ways to allow an operator to have a user confirmation. One is using WM_operator_confirm which has no configurability. It simply opens a popup menu with "OK?" as the title and a single button that contains the operator name. It can contain no other information, like the operator description, and there is no obvious and visible way to cancel.

The other way is to create a bespoke popup dialog block like we have done for the dialog we get when closing Blender with unsaved changes. But that requires a lot of work. That "close" dialog requires about 280 lines of code.

I am proposing a third option. One that allows us to create a complex dialog containing multiple buttons and improved information in just a few lines of code.

This would involve adding an optional warning callback for operators. If not set calling WM_operator_confirm would result in behavior that is identical to today.

But if you create such a callback you are passed the context, operator, and a structure containing dialog information. Make changes to that passed struct and you change the contents, look, and behavior of the confirmation.

For the example above it could look like this:

static void save_homefile_warning(bContext * /*C*/, wmOperator * /*op*/, wmWarningDetails *warning)
{
  STRNCPY(warning->confirm_button, IFACE_("Save"));
  warning->size = WM_WARNING_SIZE_LARGE;
  warning->position = WM_WARNING_POSITION_CENTER;
}

The code above changes the "confirm" button to say "Save", shows it at a larger size, and in the center of the window. The contents are not changed here so it will just just use the operator's description:

But you can change the title, the content, the icon, the size, the behavior (like closing by moving your mouse away), position, and even if the "confirm" button should be red.

There is a PR that you can apply to test this proposal: #104670

Although we try to avoid blocking operations there are times when we must pause in order to confirm with the user before proceeding with potentially harmful operations. For example when we load Defaults, Delete data, etc. We currently have only two ways to allow an operator to have a user confirmation. One is using `WM_operator_confirm` which has no configurability. It simply opens a popup menu with "OK?" as the title and a single button that contains the operator name. It can contain no other information, like the operator description, and there is no obvious and visible way to cancel. ![image](/attachments/ce72c76e-daed-4bd1-be7c-a973e9f955cb) The other way is to create a bespoke popup dialog block like we have done for the dialog we get when closing Blender with unsaved changes. But that requires a lot of work. That "close" dialog requires about 280 lines of code. I am proposing a third option. One that allows us to create a complex dialog containing multiple buttons and improved information in just a few lines of code. This would involve adding an optional `warning` callback for operators. If not set calling `WM_operator_confirm` would result in behavior that is identical to today. But if you create such a callback you are passed the context, operator, and a structure containing dialog information. Make changes to that passed struct and you change the contents, look, and behavior of the confirmation. For the example above it could look like this: ``` static void save_homefile_warning(bContext * /*C*/, wmOperator * /*op*/, wmWarningDetails *warning) { STRNCPY(warning->confirm_button, IFACE_("Save")); warning->size = WM_WARNING_SIZE_LARGE; warning->position = WM_WARNING_POSITION_CENTER; } ``` The code above changes the "confirm" button to say "Save", shows it at a larger size, and in the center of the window. The contents are not changed here so it will just just use the operator's description: ![image](/attachments/706ed6bb-5c0b-4bee-b3aa-673df102aafb) But you can change the title, the content, the icon, the size, the behavior (like closing by moving your mouse away), position, and even if the "confirm" button should be red. There is a PR that you can apply to test this proposal: https://projects.blender.org/blender/blender/pulls/104670

image.png

30 KiB

image.png

37 KiB

👍 1

Harley Acheson added the

Type

Design

label 2023-04-07 21:52:17 +02:00

Harley Acheson added this to the Module: User Interface project 2023-04-07 21:52:18 +02:00

~~Harley Acheson referenced this issue 2023-04-12 02:51:13 +02:00~~

UI: Improved Operator Confirmations #104670