Skip to content

Latest commit

 

History

History
103 lines (81 loc) · 3.08 KB

menu_bar.rst

File metadata and controls

103 lines (81 loc) · 3.08 KB
Raw

Menu Bar

Menu bar is a set of options linked to actions, or submenus.

Attributes

The following are the menus available in the menu bar:
  1. File
  2. Scenarios
  3. Preferences
  4. Help
*File* has the following submenus or options:
  1. Load project
  2. New project
  3. Save project
  4. Save project as
  5. Export project
  6. Exit open_plan
*Scenarios* has the following submenus:
  1. New scenario
  2. Load scenario
  3. Compare scenarios
  4. ---- (separating horizontal line)
  5. List of scenarios in the system
*Preferences* has the following submenus:
  1. Language
  2. Display
  3. Display welcome view
*Help* has the following submenus:
  1. Read documentation
  2. Examples and use cases
  3. Contact developers
  4. Feedback
  5. License information
  6. About open_plan...

Actions

Clicking on any of the menus' option results in a drop-down list of sub-menu's options if applicable, otherwise trigger an action

File
  1. Load project
  2. New project
  3. Save project
  4. Save project as
  5. Export project: display :ref:`export_project-label`
  6. Exit open_plan
Scenarios
  1. New scenario: display :ref:`create_scenario-label`
  2. Load scenario: display :ref:`load_scenario-label`
  3. Compare scenarios: display view :ref:`scenario_comparison-label`
  4. ---- (separating horizontal line)
  5. List of scenarios in the system
Preferences
  1. Language: not sure whether this will be implemented
  2. Display
  3. Display welcome view: display :ref:`welcome-label`
Help
  1. Read documentation: redirect to ReadTheDocs documentation
  2. Examples and use cases: redirect to ReadTheDocs usecases TODO: add link
  3. Contact developers: redirect to Github issues
  4. Feedback redirect to Github issues
  5. License information: redirect to Github license
  6. About open_plan...: redirect to open_plan website TODO: add link

Requirement

  1. The menu/submenu's options that are not applicable are greyed out or inactive and thus, nothing happens when clicked upon

Link with views

:ref:`scenario_comparison-label`

Link with other view-components

:ref:`welcome-label`
The welcome view-component can be re-enabled if it was disabled by the user from appearing everytime the tool is launched.

:ref:`progression_bar-label`

:ref:`export_project-label`

:ref:`create_scenario-label`

:ref:`load_scenario-label`

Rendering of the view-component

  • Rectangular drop-down menu buttons present on a horizontal bar on top of the :ref:`main-window-def`
  • Rendered on every view of the tool UI
  • The current scenario is highlighted in the drop-down list which results when the Scenarios menu is clicked