Update documentation & typing

CURA-5772

cura/Stages/CuraStage.py

@@ -5,19 +5,28 @@ from PyQt5.QtCore import pyqtProperty, QUrl
 from UM.Stage import Stage
 
 
+# Since Cura has a few pre-defined "space claims" for the locations of certain components, we've provided some structure
+# to indicate this.
+# * The StageMenuComponent is the horizontal area below the stage bar. This should be used to show stage specific
+#   buttons and elements. This component will be drawn over the bar & main component.
+# * The MainComponent is the component that will be drawn starting from the bottom of the stageBar and fills the rest
+#   of the screen.
 class CuraStage(Stage):
-
-    def __init__(self, parent = None):
+    def __init__(self, parent = None) -> None:
         super().__init__(parent)
 
     @pyqtProperty(str, constant = True)
-    def stageId(self):
+    def stageId(self) -> str:
         return self.getPluginId()
 
     @pyqtProperty(QUrl, constant = True)
-    def mainComponent(self):
+    def mainComponent(self) -> QUrl:
         return self.getDisplayComponent("main")
 
     @pyqtProperty(QUrl, constant = True)
-    def sidebarComponent(self):
+    def sidebarComponent(self) -> QUrl:
         return self.getDisplayComponent("sidebar")
+
+    @pyqtProperty(QUrl, constant=True)
+    def stageMenuComponent(self) -> QUrl:
+        return self.getDisplayComponent("menu")

resources/qml/PrepareSidebar.qml

@@ -86,7 +86,8 @@ Rectangle
         }
     }
 
-    SidebarHeader {
+    SidebarHeader
+    {
         id: header
         width: parent.width
         visible: !hideSettings && (machineExtruderCount.properties.value > 1 || Cura.MachineManager.hasMaterials || Cura.MachineManager.hasVariants)
@@ -96,7 +97,8 @@ Rectangle
         onHideTooltip: base.hideTooltip()
     }
 
-    Rectangle {
+    Rectangle
+    {
         id: headerSeparator
         width: parent.width
         visible: settingsModeSelection.visible && header.visible