File size: 12,455 Bytes
985c397 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 | # SPDX-License-Identifier: LGPL-2.1-or-later
from __future__ import annotations
from PropertyContainer import PropertyContainer
from DocumentObject import DocumentObject
from typing import Final, Sequence
class Document(PropertyContainer):
"""
This is the Document class.
"""
DependencyGraph: Final[str] = ""
"""The dependency graph as GraphViz text"""
ActiveObject: Final[DocumentObject] = None
"""The last created object in this document"""
Objects: Final[list[DocumentObject]] = []
"""The list of objects in this document"""
TopologicalSortedObjects: Final[list[DocumentObject]] = []
"""The list of objects in this document in topological sorted order"""
RootObjects: Final[list[DocumentObject]] = []
"""The list of root objects in this document"""
RootObjectsIgnoreLinks: Final[list[DocumentObject]] = []
"""The list of root objects in this document ignoring references from links."""
UndoMode: int = 0
"""The Undo mode of the Document (0 = no Undo, 1 = Undo/Redo)"""
UndoRedoMemSize: Final[int] = 0
"""The size of the Undo stack in byte"""
UndoCount: Final[int] = 0
"""Number of possible Undos"""
RedoCount: Final[int] = 0
"""Number of possible Redos"""
UndoNames: Final[list[str]] = []
"""A list of Undo names"""
RedoNames: Final[list[str]] = []
"""A List of Redo names"""
Name: Final[str] = ""
"""The internal name of the document"""
RecomputesFrozen: bool = False
"""Returns or sets if automatic recomputes for this document are disabled."""
HasPendingTransaction: Final[bool] = False
"""Check if there is a pending transaction"""
InList: Final[list[Document]] = []
"""A list of all documents that link to this document."""
OutList: Final[list[Document]] = []
"""A list of all documents that this document links to."""
Restoring: Final[bool] = False
"""Indicate if the document is restoring"""
Partial: Final[bool] = False
"""Indicate if the document is partially loaded"""
Importing: Final[bool] = False
"""Indicate if the document is importing. Note the document will also report Restoring while importing"""
Recomputing: Final[bool] = False
"""Indicate if the document is recomputing"""
Transacting: Final[bool] = False
"""Indicate whether the document is undoing/redoing"""
OldLabel: Final[str] = ""
"""Contains the old label before change"""
Temporary: Final[bool] = False
"""Check if this is a temporary document"""
def save(self) -> None:
"""
Save the document to disk.
"""
...
def saveAs(self, path: str, /) -> None:
"""
Save the document under a new name to disk.
"""
...
def saveCopy(self, path: str, /) -> None:
"""
Save a copy of the document under a new name to disk.
"""
...
def load(self, path: str, /) -> None:
"""
Load the document from the given path.
"""
...
def restore(self) -> None:
"""
Restore the document from disk
"""
...
def isSaved(self) -> bool:
"""
Checks if the document is saved
"""
...
def getProgramVersion(self) -> str:
"""
Get the program version that a project file was created with
"""
...
def getFileName(self) -> str:
"""
For a regular document it returns its file name property.
For a temporary document it returns its transient directory.
"""
...
def getUniqueObjectName(self, objName: str, /) -> str:
"""
Return the same name, or the name made unique, for Example Box -> Box002 if there are conflicting name
already in the document.
Args:
objName: Object name candidate.
Returns:
Unique object name based on objName.
"""
...
def mergeProject(self, path: str, /) -> None:
"""
Merges this document with another project file.
"""
...
def exportGraphviz(self, path: str = None, /) -> str | None:
"""
Export the dependencies of the objects as graph.
If path is passed, graph is written to it. if not a string is returned.
"""
...
def openTransaction(self, name: str, /) -> None:
"""
Open a new Undo/Redo transaction.
This function no long creates a new transaction, but calls
FreeCAD.setActiveTransaction(name) instead, which will auto creates a
transaction with the given name when any change happened in any opened document.
If more than one document is changed, all newly created transactions will have
the same internal ID and will be undo/redo together.
"""
...
def abortTransaction(self) -> None:
"""
Abort an Undo/Redo transaction (rollback)
"""
...
def commitTransaction(self) -> None:
"""
Commit an Undo/Redo transaction
"""
...
def addObject(
self,
type: str,
name: str = None,
objProxy: object = None,
viewProxy: object = None,
attach: bool = False,
viewType: str = None,
) -> DocumentObject:
"""
Add an object to document.
Args:
type: the type of the document object to create.
name: the optional name of the new object.
objProxy: the Python binding object to attach to the new document object.
viewProxy: the Python binding object to attach the view provider of this object.
attach: if True, then bind the document object first before adding to the document
to allow Python code to override view provider type. Once bound, and before adding to
the document, it will try to call Python binding object's attach(obj) method.
viewType: override the view provider type directly, only effective when attach is False.
"""
...
def addProperty(
self,
type: str,
name: str,
group: str = "",
doc: str = "",
attr: int = 0,
read_only: bool = False,
hidden: bool = False,
locked: bool = False,
enum_vals: list[str] | None = None,
) -> Document:
"""
Add a generic property.
Args:
type: The type of the property to add.
name: The name of the property.
group: The group to which the property belongs. Defaults to "".
doc: The documentation string for the property. Defaults to "".
attr: Attribute flags for the property. Defaults to 0.
read_only: Whether the property is read-only. Defaults to False.
hidden: Whether the property is hidden. Defaults to False.
locked: Whether the property is locked. Defaults to False.
Returns:
The document instance with the added property.
"""
...
def removeProperty(self, name: str, /) -> None:
"""
Remove a generic property.
Note, you can only remove user-defined properties but not built-in ones.
"""
...
def removeObject(self, name: str, /) -> None:
"""
Remove an object from the document.
"""
...
def copyObject(
self,
object: DocumentObject,
*,
recursive: bool = False,
return_all: bool = False,
) -> tuple[DocumentObject, ...]:
"""
Copy an object or objects from another document to this document.
Args:
object: can either be a single object or sequence of objects
recursive: if True, also recursively copies internal objects
return_all: if True, returns all copied objects, or else return only the copied
object corresponding to the input objects.
"""
...
def moveObject(
self,
object: DocumentObject,
with_dependencies: bool = False,
/,
) -> DocumentObject:
"""
Transfers an object from another document to this document.
Args:
object: can either a single object or sequence of objects
with_dependencies: if True, all internal dependent objects are copied too.
"""
...
def importLinks(
self,
object: DocumentObject = None,
/,
) -> tuple[DocumentObject, ...]:
"""
Import any externally linked object given a list of objects in
this document. Any link type properties of the input objects
will be automatically reassigned to the imported object
If no object is given as input, it import all externally linked
object of this document.
"""
...
def undo(self) -> None:
"""
Undo one transaction
"""
...
def redo(self) -> None:
"""
Redo a previously undone transaction
"""
...
def clearUndos(self) -> None:
"""
Clear the undo stack of the document
"""
...
def clearDocument(self) -> None:
"""
Clear the whole document
"""
...
def setClosable(self, closable: bool, /) -> None:
"""
Set a flag that allows or forbids to close a document
"""
...
def isClosable(self) -> bool:
"""
Check if the document can be closed. The default value is True
"""
...
def setAutoCreated(self, autoCreated: bool, /) -> None:
"""
Set a flag that indicates if a document is autoCreated
"""
...
def isAutoCreated(self) -> bool:
"""
Check if the document is autoCreated. The default value is False
"""
...
def recompute(
self,
objs: Sequence[DocumentObject] = None,
force: bool = False,
check_cycle: bool = False,
/,
) -> int:
"""
Recompute the document and returns the amount of recomputed features.
"""
...
def mustExecute(self) -> bool:
"""
Check if any object must be recomputed
"""
...
def purgeTouched(self) -> None:
"""
Purge the touched state of all objects
"""
...
def isTouched(self) -> bool:
"""
Check if any object is in touched state
"""
...
def getObject(self, name: str, /) -> DocumentObject:
"""
Return the object with the given name
"""
...
def getObjectsByLabel(self, label: str, /) -> list[DocumentObject]:
"""
Return the objects with the given label name.
NOTE: It's possible that several objects have the same label name.
"""
...
def findObjects(
self,
Type: str = None,
Name: str = None,
Label: str = None,
) -> list[DocumentObject]:
"""
Return a list of objects that match the specified type, name or label.
Name and label support regular expressions. All parameters are optional.
Args:
Type: Type of the feature.
Name: Name
Label: Label
"""
...
def getLinksTo(
self,
obj: DocumentObject,
options: int = 0,
maxCount: int = 0,
/,
) -> tuple[DocumentObject, ...]:
"""
Return objects linked to 'obj'
Args:
options: 1: recursive, 2: check link array. Options can combine.
maxCount: to limit the number of links returned.
"""
...
def supportedTypes(self) -> list[str]:
"""
A list of supported types of objects
"""
...
def getTempFileName(self) -> str:
"""
Returns a file name with path in the temp directory of the document.
"""
...
def getDependentDocuments(self, sort: bool = True, /) -> list[DocumentObject]:
"""
Returns a list of documents that this document directly or indirectly links to including itself.
Args:
sort: whether to topologically sort the return list
"""
...
|