3D-printing/Cura
1
0
Fork 0
mirror of https://github.com/Ultimaker/Cura.git synced 2025-07-15 10:47:49 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Proposed improvement on API naming

Browse source
This commit is contained in:
Ian Paschal 2018-08-10 16:08:54 +02:00
parent a1bc2f3ebf
commit 6d237b09e8
2 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

34
cura/API/SidebarContextMenu.py
View file

@ -1,34 +0,0 @@
# Copyright (c) 2018 Ultimaker B.V.
# Cura is released under the terms of the LGPLv3 or higher.
from cura.CuraApplication import CuraApplication
## The sidebar context menu API provides a version-proof bridge between Cura's
# Sidebar Context Menu and plug-ins that hook into it.
#
# Usage:
# ``from cura.API import CuraAPI
# api = CuraAPI()
# api.sidebar_context_menu.getSidebarMenuItems()
# menu_actions = []
# menu_actions.append("sidebarMenuItemOnClickHander")
# data = {
# "name": "My Plugin Action",
# "iconName": "my-plugin-icon",
# "actions": menu_actions,
# "menu_item": MyPluginAction(self)
# }
# api.sidebar_context_menu.addSidebarMenuItems([])``
class SidebarContextMenu:
_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:
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:
return self._application.getSidebarCustomMenuItems()