63 lines
1.6 KiB
Python
63 lines
1.6 KiB
Python
# SPDX-License-Identifier: LGPL-2.1-or-later
|
|
|
|
from Base.Metadata import export
|
|
from Base.BaseClass import BaseClass
|
|
from typing import Any, Final, Tuple
|
|
|
|
@export(
|
|
Include="Gui/Selection/SelectionObject.h",
|
|
Delete=True,
|
|
)
|
|
class SelectionObject(BaseClass):
|
|
"""
|
|
This class represents selections made by the user. It holds information about the object, document and sub-element of the selection.
|
|
|
|
Author: Juergen Riegel (FreeCAD@juergen-riegel.net)
|
|
Licence: LGPL
|
|
"""
|
|
|
|
def remove(self) -> None:
|
|
"""
|
|
Remove this selection item from the selection.
|
|
remove() -> None
|
|
--
|
|
This object becomes invalid.
|
|
"""
|
|
...
|
|
|
|
def isObjectTypeOf(self, type: Any, /) -> bool:
|
|
"""
|
|
Test for a certain father class.
|
|
isObjectTypeOf(type) -> Bool
|
|
"""
|
|
...
|
|
ObjectName: Final[str] = ""
|
|
"""Name of the selected object"""
|
|
|
|
SubElementNames: Final[Tuple[str, ...]] = ()
|
|
"""Name of the selected sub-element if any"""
|
|
|
|
FullName: Final[str] = ""
|
|
"""Name of the selected object"""
|
|
|
|
TypeName: Final[str] = ""
|
|
"""Type name of the selected object"""
|
|
|
|
DocumentName: Final[str] = ""
|
|
"""Name of the document of the selected object"""
|
|
|
|
Document: Final[Any] = ...
|
|
"""Document of the selected object"""
|
|
|
|
Object: Final[Any] = ...
|
|
"""Selected object"""
|
|
|
|
SubObjects: Final[Tuple[Any, ...]] = ()
|
|
"""Selected sub-element, if any"""
|
|
|
|
PickedPoints: Final[Tuple[Any, ...]] = ()
|
|
"""Picked points for selection"""
|
|
|
|
HasSubObjects: Final[bool] = False
|
|
"""Selected sub-element, if any"""
|