# {py:mod}`simvx.core.document`

```{py:module} simvx.core.document
```

```{autodoc2-docstring} simvx.core.document
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`Document <simvx.core.document.Document>`
  - ```{autodoc2-docstring} simvx.core.document.Document
    :summary:
    ```
* - {py:obj}`BufferRegistry <simvx.core.document.BufferRegistry>`
  - ```{autodoc2-docstring} simvx.core.document.BufferRegistry
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`log <simvx.core.document.log>`
  - ```{autodoc2-docstring} simvx.core.document.log
    :summary:
    ```
````

### API

````{py:data} log
:canonical: simvx.core.document.log
:value: >
   'getLogger(...)'

```{autodoc2-docstring} simvx.core.document.log
```

````

`````{py:class} Document(path: pathlib.Path | str | None = None, encoding: str = 'utf-8')
:canonical: simvx.core.document.Document

```{autodoc2-docstring} simvx.core.document.Document
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.document.Document.__init__
```

````{py:property} content
:canonical: simvx.core.document.Document.content
:type: str

```{autodoc2-docstring} simvx.core.document.Document.content
```

````

````{py:property} dirty
:canonical: simvx.core.document.Document.dirty
:type: bool

```{autodoc2-docstring} simvx.core.document.Document.dirty
```

````

````{py:property} title
:canonical: simvx.core.document.Document.title
:type: str

```{autodoc2-docstring} simvx.core.document.Document.title
```

````

````{py:method} load() -> bool
:canonical: simvx.core.document.Document.load

```{autodoc2-docstring} simvx.core.document.Document.load
```

````

````{py:method} save(path: pathlib.Path | str | None = None) -> bool
:canonical: simvx.core.document.Document.save

```{autodoc2-docstring} simvx.core.document.Document.save
```

````

`````

`````{py:class} BufferRegistry()
:canonical: simvx.core.document.BufferRegistry

```{autodoc2-docstring} simvx.core.document.BufferRegistry
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.document.BufferRegistry.__init__
```

````{py:method} open(path: pathlib.Path | str) -> simvx.core.document.Document
:canonical: simvx.core.document.BufferRegistry.open

```{autodoc2-docstring} simvx.core.document.BufferRegistry.open
```

````

````{py:method} create(content: str = '') -> simvx.core.document.Document
:canonical: simvx.core.document.BufferRegistry.create

```{autodoc2-docstring} simvx.core.document.BufferRegistry.create
```

````

````{py:method} close(doc: simvx.core.document.Document) -> bool
:canonical: simvx.core.document.BufferRegistry.close

```{autodoc2-docstring} simvx.core.document.BufferRegistry.close
```

````

````{py:property} active
:canonical: simvx.core.document.BufferRegistry.active
:type: simvx.core.document.Document | None

```{autodoc2-docstring} simvx.core.document.BufferRegistry.active
```

````

````{py:property} buffers
:canonical: simvx.core.document.BufferRegistry.buffers
:type: list[simvx.core.document.Document]

```{autodoc2-docstring} simvx.core.document.BufferRegistry.buffers
```

````

````{py:property} has_dirty
:canonical: simvx.core.document.BufferRegistry.has_dirty
:type: bool

```{autodoc2-docstring} simvx.core.document.BufferRegistry.has_dirty
```

````

`````