Proposed improvement on API naming

cura/API/SidebarContextMenu.py → cura/API/Sidebar.py

@@ -9,26 +9,26 @@ from cura.CuraApplication import CuraApplication
 #   Usage:
 #       ``from cura.API import CuraAPI
 #       api = CuraAPI()
-#       api.sidebar_context_menu.getSidebarMenuItems()
+#       api.sidebar.getContextMenuItems()
 #       menu_actions = []
-#       menu_actions.append("sidebarMenuItemOnClickHander")
+#       menu_actions.append("sidebarMenuItemOnClickHandler")
 #       data = {
 #           "name": "My Plugin Action",
 #           "iconName": "my-plugin-icon",
 #           "actions": menu_actions,
 #           "menu_item": MyPluginAction(self)
 #       }
-#       api.sidebar_context_menu.addSidebarMenuItems([])``
-class SidebarContextMenu:
+#       api.sidebar.addContextMenuItem(data)``
+class Sidebar:
 
     _application = CuraApplication.getInstance()  # type: CuraApplication
 
     ##  Add items to the sidebar context menu.
     #   \param menu_item dict containing the menu item to add.
-    def addSidebarMenuItem(self, menu_item: dict) -> None:
+    def addContextMenuItem(self, menu_item: dict) -> None:
         self._application.addSidebarCustomMenuItem(menu_item)
 
     ##  Get all custom items currently added to the sidebar context menu.
     #   \return List containing all custom context menu items.
-    def getSidebarMenuItems(self) -> list:
+    def getContextMenuItems(self) -> list:
         return self._application.getSidebarCustomMenuItems()

cura/API/__init__.py

@@ -2,7 +2,7 @@
 # Cura is released under the terms of the LGPLv3 or higher.
 from UM.PluginRegistry import PluginRegistry
 from cura.API.Backups import Backups
-from cura.API.SidebarContextMenu import SidebarContextMenu
+from cura.API.Sidebar import Sidebar
 
 ##  The official Cura API that plug-ins can use to interact with Cura.
 #
@@ -19,4 +19,4 @@ class CuraAPI:
     backups = Backups()
 
     # Sidebar Context Menu API
-    sidebar_context_menu = SidebarContextMenu()
+    sidebar = Sidebar()