Uranium
Application Framework
UM.Extension.Extension Class Reference
Inheritance diagram for UM.Extension.Extension:
UM.PluginObject.PluginObject

Public Member Functions

None __init__ (self)
 
None addMenuItem (self, str name, Callable[[], Any] function)
 
None setMenuName (self, str name)
 
Optional[str] getMenuName (self)
 
None activateMenuItem (self, str name)
 
List[str] getMenuItemList (self)
 
- Public Member Functions inherited from UM.PluginObject.PluginObject
None __init__ (self, *args, **kwags)
 
str getId (self)
 
None setPluginId (self, str plugin_id)
 
None setMetaData (self, Dict[str, Any] metadata)
 
Dict[str, Any] getMetaData (self)
 
str getPluginId (self)
 
None setVersion (self, str version)
 
str getVersion (self)
 

Detailed Description

Base class for plugins that extend the functionality of Uranium.

Every extension adds a (sub) menu to the extension menu with one or
more menu items.

Constructor & Destructor Documentation

◆ __init__()

None UM.Extension.Extension.__init__ (   self)

Reimplemented from UM.PluginObject.PluginObject.

Member Function Documentation

◆ activateMenuItem()

None UM.Extension.Extension.activateMenuItem (   self,
str  name 
)
Call function associated with option

:param name: :type{string}

◆ addMenuItem()

None UM.Extension.Extension.addMenuItem (   self,
str  name,
Callable[[], Any]  function 
)
Add an item to the sub-menu of the extension

:param name: :type{string}
:param function: :type{function}

◆ getMenuItemList()

List[str] UM.Extension.Extension.getMenuItemList (   self)
Get list of all menu item names

:return: :type{list}

◆ getMenuName()

Optional[str] UM.Extension.Extension.getMenuName (   self)
Get the name of the menu where all menu items are placed in

◆ setMenuName()

None UM.Extension.Extension.setMenuName (   self,
str  name 
)
Set name of the menu where all menu items are placed in

:param name: :type{string}

The documentation for this class was generated from the following file: