Display Default Values and Required Properties in Algorithm Dialogs

[Peter Peterson]

• Where a property requires user input its name will be shown in a bold font.
• Where a property has a default value it will be shown in grey placeholder text.
• Where a property is about to overwrite an existing workspace, show an icon.
• Where a property has been restored from a previously-entered value, show an icon.

Tool tips should show relevant information.

[Nick Draper]

Bulk move of tickets at the end of iteration 28

[Nick Draper]

Accepted and assigned tickets moved at iteration 29 code freeze

[Nick Draper]

Bulk move of tickets to iteration 31 at the iteration 30 code freeze

[Nick Draper]

Moved to iteration 33 at iteration 32 code freeze

[Nick Draper]

Moved at end of release 2.1

[Nick Draper]

Moved at the end of release 2.2

[Nick Draper]

Moved to milestone 2.4

[Nick Draper]

Moved to r2.6 at the end of r2.5

[Nick Draper]

Moved to backlog at the code freeze for R2.6

[Nick Draper]

Bulk move to assigned at the introduction of the triage step

[Peter Parker]

Refs #2480 - Display default values and mandatory props in alg diags.

Take same definition of mandatory as WikiMaker, i.e. when a property needs input from the user or else a red asterisk will appear.

Account for instances of EMPTY_* and *_MAX macros. Catch a few that even WikiMaker doesn't.

Changeset: b0f0b220916fee4e54f8c36a6b8ecb4cf8ceaf4c

[Peter Parker]

Refs #2480 - Fix compiler warnings.

Changeset: 6b5886b3a92a794f9a43d0b9fdb6f5845827ffb1

[Peter Parker]

Refs #2480 - Fix compiler warning.

A quick google indicates this could be a bug in the version of GCC used on RHEL6. We use boost::optional elsewhere in Mantid, so hopefully this will fix.

Changeset: 83399d52ab17b0d9e5a32a99b21f9f38c0be0190

[Peter Parker]

Refs #2480 - Fix compiler warning.

Okay, we use get() instead of dereferencing elsewhere, so this should work.

Changeset: bea4d5b7df17145ee74ef0ad450d7d21658d1dd7

[Peter Parker]

Refs #2480 - Abandon use of boost::optional.

After a discussion with Martyn it seems likely that for the version of GCC and/or Boost we have for RHEL6 we are unable to return boost::optional objects from functions without getting the warning I've been trying to fix. Elsewhere, we pass them into functions by reference and therefore avoid the problem.

I'm not a huge fan of that option, so in this case exceptions will provide the functionality I need instead.

Also, renamed a function and some variables to make things clearer.

Changeset: 34d31448b985ee62f156c6fcfbd60d5f0b9cc9c9

[Peter Parker]

Refs #2480 - Only round extremely long numbers.

Changeset: fb3fffeb90a00d6a3db348b30dfd702823ce3dc7

[Peter Parker]

Refs #2480 - Show further information in prop widgets.

• Show icon when workspace is about to be replaced.
• Show icon when value has been restored from a previously-entered value.

Changeset: dc8a6cc9f042e9071f87831873402a56ce947ef4

[Peter Parker]

Merge branch 'feature/2480_show_required_props_and_default_vals_in_alg_diags' into develop

Conflicts:

Code/Mantid/MantidQt/API/CMakeLists.txt

Refs #2480.

Changeset: 018a586b7478f18d76fe5aba4b0fd05ee5a22ce3

[Peter Parker]

Refs #2480 - Fix doxygen warnings.

Changeset: 7c4b1fbd8334a48a166a255a021d6d050b7915ee

[Peter Parker]

Ticket Scope:

These changes will only work for dialogs that use instances of PropertyWidget, which at the moment are the generic, dynamically-generated algorithm dialogs as well as the StartLiveData dialog. All other custom dialogs (i.e. LoadAscii, CatalogPublish, etc) will be unchanged. #9149 has been opened to make the use of PropertyWidget and its child classes more widespread.

Also, please realise that external code has very limited access to algorithm logic. If a property is validated inside an algorithm's exec() method rather than in init() using a validator, then there is no way for the dialog to know about this and so no way, for example, to work out that a property is required and its name should put in a bold font.

In general, I've aimed to do at least as well as the WikiMaker does when displaying optional/required properties and showing default values. #9153 has been opened to review problematic algorithm properties exposed by this ticket and by WikiMaker.

To Test:

Ensure that the four proposed features in the ticket description have been implemented and work as you would expect.

Since these changes are supposed to give visual clues to users to give a better understanding of what's going on, if something is not obvious to you (even after reading tool tips) then feel free to bounce the ticket and suggest a way that the feature could be improved.

Finally, note that the "replace" and "restored" icons are different to the "fading background" functionality I proposed in the Mantid Review meeting on this topic, but hopefully are more intuitive. In any event, getting this in now will mean people have plenty of time to use it and suggest improvements before the release.

[Peter Peterson]

I am closing this ticket, but there is a bug described in #9356.

[Pete Peterson]

Merge remote-tracking branch 'origin/feature/2480_show_required_props_and_default_vals_in_alg_diags'

Full changeset: ​6b79121a8f2a7f5885c56950a0acf11f0eefad9f

[Stuart Campbell]

This ticket has been transferred to github issue ​3327