TaskPanel Design - sliptonic/FreeCAD GitHub Wiki

Task Panels

Task panels are the UI concept used modal actions requiring user input. Task Panels appear on the 'Tasks' tab of the comboview.

General Guidelines

  • Tasks should always correspond to a transaction. Thus pressing the 'undo' button immediately after closing a task, should revert everything done in that task.

Main Task Panel Buttons

  • Task Panels should have either two or three buttons at the top of the panel which control the state of the task.
  • Task Panels should always provide at least two buttons to control the task:
  1. 'ok' button commits the current task configuration and dismisses the panel.
  2. 'cancel' dismisses the panel and reverts all changes to the state prior to opening the task.

*Use of 'Apply' button

  1. Panels may optionally include an Apply button as well. The apply button will apply the current configuration to the affected items and update the 3D view but not close the task panel.
  2. Tasks whose calculation requires substantial time to complete should use an 'apply' button
  3. if the task panel has an apply button, no changes to any items should affect the 3D window until the apply button is pressed.
  4. If the task panel does not have an apply button, the 3D view should be updated as each property value is changed.