Uranium
Application Framework
Loading...
Searching...
No Matches
UM.Stage.Stage Class Reference
Inheritance diagram for UM.Stage.Stage:
UM.PluginObject.PluginObject

Public Member Functions

None __init__ (self, Optional[QObject] parent=None, Optional[str] active_view=None)
None onStageSelected (self)
None onStageDeselected (self)
None addDisplayComponent (self, str name, Union[str, QUrl] source)
QUrl getDisplayComponent (self, str name)
Optional[str] getActiveView (self)
None setActiveView (self, str name)
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)

Static Public Attributes

 activeViewChanged = pyqtSignal()

Protected Attributes

dict _components = {}
QUrl _icon_source = QUrl()
Optional[str] _active_view = active_view
Protected Attributes inherited from UM.PluginObject.PluginObject
 _plugin_id = None
 _version = None
dict _metadata = {}
 _name = None

Detailed Description

Stages handle combined views in an Uranium application.

The active stage decides which QML component to show where.
Uranium has no notion of specific view locations as that's application specific.

Member Function Documentation

◆ addDisplayComponent()

None UM.Stage.Stage.addDisplayComponent ( self,
str name,
Union[str, QUrl] source )
Add a QML component to the stage

◆ getDisplayComponent()

QUrl UM.Stage.Stage.getDisplayComponent ( self,
str name )
Get a QUrl by name.

◆ onStageDeselected()

None UM.Stage.Stage.onStageDeselected ( self)
Something to do when this Stage is deselected

◆ onStageSelected()

None UM.Stage.Stage.onStageSelected ( self)
Something to do when this Stage is selected

◆ setActiveView()

None UM.Stage.Stage.setActiveView ( self,
str name )
Set the currently active view for this stage.
:param name:  The name of the view to set as active

The documentation for this class was generated from the following file:
  • UM/Stage.py