mirror of
https://github.com/Ultimaker/Cura.git
synced 2025-07-15 18:57:52 -06:00
68318d20fd
Converted doxygen style comments to reStructuredText style in the files found in Cura/cura/API directory recursively using the script dox_2_rst.py (provided in the Uranium repo). Comments were manually checked and changed if needed. Comments from the hidden attributes in the class CuraAPI (_acount, _backups, _interface) were moved to the public property getters, so they docstrings are exposed to the user.
31 lines
917 B
Python
31 lines
917 B
Python
# Copyright (c) 2018 Ultimaker B.V.
|
|
# Cura is released under the terms of the LGPLv3 or higher.
|
|
|
|
from typing import TYPE_CHECKING
|
|
|
|
from cura.API.Interface.Settings import Settings
|
|
|
|
if TYPE_CHECKING:
|
|
from cura.CuraApplication import CuraApplication
|
|
|
|
|
|
class Interface:
|
|
"""The Interface class serves as a common root for the specific API
|
|
|
|
methods for each interface element.
|
|
|
|
Usage:
|
|
|
|
.. code-block:: python
|
|
|
|
from cura.API import CuraAPI
|
|
api = CuraAPI()
|
|
api.interface.settings.addContextMenuItem()
|
|
api.interface.viewport.addOverlay() # Not implemented, just a hypothetical
|
|
api.interface.toolbar.getToolButtonCount() # Not implemented, just a hypothetical
|
|
# etc
|
|
"""
|
|
|
|
def __init__(self, application: "CuraApplication") -> None:
|
|
# API methods specific to the settings portion of the UI
|
|
self.settings = Settings(application)
|