VAPOR GUI Naming Conventions

Jump to bottom

Samuel Li edited this page Apr 23, 2018 · 1 revision

The following describes how files and objects are named in the GUI.

[objectName] GUI

Indicates a user-interface defined in a .ui file, which gets compiled into a header file to be included. All Subtabs and promoted Widgets will need their own GUI to define their structure and layout. Example:
```
TFWidgetGUI.ui/.h
VariablesWidgetGUI.ui/.h
TwoDVariablesSubtab.ui/.h
```
[objectName] Widget

Indicates a functionally implemented reusable GUI component. These objects are "promoted Qt widgets" that can be plugged into subtabs or any other UI element. These object will inherit from its associated [objectName]GUI. Example:
```
TFWidget.cpp/.h
VariablesWidget.cpp/.h
```
[objectName] Subtab

Indicates a functionally implemented composition of UI elements. These UI elements may consist of the reusable promoted "Widgets" described above. They may also be stand-alone Qt elements such as push-buttons and sliders. Signals and slots for the stand-alone Qt elements will need to be implemented here. Examples:
```
TwoDVariablesSubtab.cpp/.h
HelloVariablesSubtab.cpp/.h
TwoDAppearanceSubtab.cpp/.h
HelloAppearanceSubtab.cpp/.h
```