comet.document¶
The comet.document module provides global document access for the current session, e.g. finding open documents or opening new ones.
See also
- Class
CDocument
Document object specific functionality
Methods¶
- comet.document.open(path, appendToRecent=True)¶
Open a document. When the document is already opened it is returned instead.
- Parameters
- Returns
The newly opened or already open document
- Return type
- Raises
TypeError – When parameter types are invalid
ValueError – When parameter path is empty
CometError – When document could not be opened
- Available
- CScript
- comet.document.getFront()¶
Return the current front document if any, else returns None
- Returns
The current front document
- Return type
- Available
- CScript
- comet.document.getOpen()¶
Fetch a list of all currently open documents
- Returns
List of opened documents.
- Return type
- Available
- CScript