OOO Development Tools

https://python-ooo-dev-tools.readthedocs.io/en/latest/
Admin
OOO Development Tools (OooDev) is a Python framework with over 4,000 classes for controlling and...
Tokens:171,190
Snippets:1,444
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Full Example: Calc Cell Styling

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/help/calc/format/style/cell.html

Demonstrates the complete process of creating a Calc document, applying a style to a cell, and verifying it. Includes setup and cleanup.

```python
from __future__ import annotations
import uno
from ooodev.calc import CalcDoc
from ooodev.loader import Lo
from ooodev.format.calc.style import StyleCellKind

def main() -> int:
    with Lo.Loader(connector=Lo.ConnectSocket()):
        doc = CalcDoc.create_doc(visible=True)
        sheet = doc.sheets[0]
        Lo.delay(500)
        doc.zoom_value(400)

        cell = sheet["A1"]
        cell.value = "Hello"
        cell.style_by_name(StyleCellKind.ACCENT_1)

        name = cell.style_by_name_get()
        assert name == str(StyleCellKind.ACCENT_1)

        Lo.delay(1_000)
        doc.close()
    return 0

if __name__ == "__main__":
    SystemExit(main())
```

--------------------------------

### Test LibreOffice API Integration

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_poetry_env.html

Start a Python interpreter within the activated virtual environment and run a test script to verify the LibreOffice API integration. This example demonstrates loading LibreOffice, creating a Calc document, and writing to a cell.

```python
>>> import uno
>>> from ooodev.loader import Lo
>>> from ooodev.calc import CalcDoc
>>> 
>>> def say_hello(cell_name):
...     doc = CalcDoc.from_current_doc()
...     sheet = doc.sheets[0]
...     sheet[cell_name].value="Hello World!"
... 
>>> _ = Lo.load_office(Lo.ConnectSocket())
>>> doc = CalcDoc.create_doc(visible=True)
>>> say_hello("A1")
>>> doc.close()
>>> Lo.close_office()
```

--------------------------------

### Install Project Requirements with Poetry on Linux

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/dev_docs/dev_notes.html

After activating the virtual environment, use Poetry to install the project's dependencies. Ensure Poetry is installed on your system.

```bash
(.venv) $ poetry install
```

--------------------------------

### Install Additional Development Packages

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_poetry_env.html

Install other development packages, such as `ooo-dev-tools`, into the configured virtual environment using Poetry.

```bash
poetry add ooo-dev-tools
```

--------------------------------

### Install Python venv Package

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_manual_venv.html

Installs the 'python3.10-venv' package if the virtual environment creation fails due to it not being installed.

```bash
sudo apt install python3.10-venv

```

--------------------------------

### Install Pip if Missing

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_lo_install_pip.html

If pip is not found, use this command to download and install it using the system's Python 3 executable. This ensures pip is available for subsequent package installations.

```bash
curl -sSL https://bootstrap.pypa.io/get-pip.py | /usr/bin/python3 -
```

--------------------------------

### Install LibreOffice Script Provider

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_flatpak_automate_lo.html

Installs the necessary apt package to allow scripts to connect to LibreOffice.

```bash
sudo apt install libreoffice-script-provider-python

```

--------------------------------

### Install and Configure oooenv

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_flatpak_automate_lo.html

Installs the oooenv package within the activated virtual environment and configures it to use 'uno.py' and 'unohelper.py' for LibreOffice API access.

```bash
python -m pip install oooenv

```

```bash
oooenv cmd-link -a

```

--------------------------------

### Install ooo-dev-tools

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_linking_paths.html

Installs the 'ooo-dev-tools' package, which provides tools and typing support for LibreOffice API development within the virtual environment.

```bash
pip install ooo-dev-tools
```

--------------------------------

### Install pip Package for LibreOffice

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_lo_install_pip.html

Install a Python package, such as 'ooo-dev-tools', using pip and the LibreOffice-specific Python executable. This command defaults to user installation, which is generally recommended.

```bash
$ /usr/bin/python3 -m pip install ooo-dev-tools
Defaulting to user installation because normal site-packages is not writeable
Collecting ooo-dev-tools
Using cached ooo_dev_tools-0.11.7-py3-none-any.whl (2.2 MB)
Collecting lxml>=4.9.2 (from ooo-dev-tools)
Using cached lxml-4.9.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_24_x86_64.whl (7.1 MB)
Collecting ooouno>=2.1.2 (from ooo-dev-tools)
Using cached ooouno-2.1.2-py3-none-any.whl (9.8 MB)
Collecting types-unopy>=1.2.3 (from ooouno>=2.1.2->ooo-dev-tools)
Using cached types_unopy-1.2.3-py3-none-any.whl (5.2 MB)
Collecting typing-extensions<5.0.0,>=4.6.2 (from ooouno>=2.1.2->ooo-dev-tools)
Using cached typing_extensions-4.6.3-py3-none-any.whl (31 kB)
Collecting types-uno-script>=0.1.1 (from types-unopy>=1.2.3->ooouno>=2.1.2->ooo-dev-tools)
Using cached types_uno_script-0.1.1-py3-none-any.whl (9.3 kB)
Installing collected packages: typing-extensions, types-uno-script, lxml, types-unopy, ooouno, ooo-dev-tools
Successfully installed lxml-4.9.2 ooo-dev-tools-0.11.7 ooouno-2.1.2 types-uno-script-0.1.1 types-unopy-1.2.3 typing-extensions-4.6.3

```

--------------------------------

### Install oooenv as Development Dependency

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/windows_poetry_env.html

Install the oooenv package into the virtual environment as a development dependency using Poetry.

```powershell
poetry add oooenv --group=dev

```

--------------------------------

### Test Pip Package Installation in LibreOffice

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_install_pkg_zaz_pip.html

This code snippet demonstrates how to test an installed pip package by writing 'Hello World!' to a LibreOffice Writer document using the APSO console. Ensure the ooo-dev-tools package is installed first.

```python
APSO python console [LibreOffice]
3.10.11 (main, Nov 10 2011, 15:00:00) [GCC 12.2.0] 
Type "help", "copyright", "credits" or "license" for more information.
>>> from ooodev.write import WriteDoc
>>> def say_hello():
...     doc = WriteDoc.from_current_doc()
...     cursor = doc.get_cursor()
...     cursor.append_para(text="Hello World!")
... 
>>> say_hello()
>>> 

```

--------------------------------

### Starting LibreOffice Flatpak via subprocess

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_flatpak_automate_lo.html

This snippet shows how to start LibreOffice Flatpak using `subprocess.Popen`. It's important to use `shell=True` for this command. Note the use of `socket` for accepting connections.

```python
# is it important to use shell=True
import os
from subprocess import Popen
Popen(f'flatpak run org.libreoffice.LibreOffice/x86_64/stable --invisible --norestore --nofirststartwizard --nologo --accept="socket,host=localhost,port=2002,tcpNoDelay=1;urp;" --display {os.getenv("DISPLAY")}', shell=True)

```

--------------------------------

### Install Pip using curl (Cmd Shell)

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/windows_manual_venv.html

In a Command Prompt, use `curl` to download `get-pip.py`, then pipe its content to the virtual environment's Python interpreter to install pip.

```cmd
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py && type get-pip.py | python.exe -

```

--------------------------------

### Install Poetry on Windows

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/poetry_env.html

Execute this command in PowerShell to install Poetry on Windows systems. If Python was installed from the Microsoft Store, use 'python' instead of 'py'.

```powershell
(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -
```

--------------------------------

### Get LibreOffice FlatPak Python Version

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_flatpak_lo_pip.html

Start FlatPak LibreOffice and open the APSO extension to access the Python console and determine the installed Python version.

```text
APSO python console [LibreOffice]
3.10.11 (main, Nov 10 2011, 15:00:00) [GCC 12.2.0]
Type "help", "copyright", "credits" or "license" for more information.
>>>

```

--------------------------------

### Verify Poetry Installation

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/poetry_env.html

Run this command to check if Poetry has been installed successfully and to view its version.

```bash
poetry --version
```

--------------------------------

### Install ooo-dev-tools

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_flatpak_automate_lo.html

Installs the ooo-dev-tools package, which is required for automating LibreOffice and has a version dependency.

```bash
python -m pip install ooo-dev-tools

```

--------------------------------

### Testing installed Pip package

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/windows_install_pkg_zaz_pip.html

This code snippet demonstrates how to test an installed pip package by writing 'Hello World!' to a LibreOffice Writer document using the ooodev library.

```python
APSO python console [LibreOffice]
3.8.16 (default, Apr 28 2023, 09:24:49) [MSC v.1929 32 bit (Intel)]
Type "help", "copyright", "credits" or "license" for more information.
>>> from ooodev.loader.lo import Lo
>>> from ooodev.write import WriteDoc
>>> 
>>> def say_hello():
...     doc = WriteDoc.from_current_doc()
...     cursor = doc.get_cursor()
...     cursor.append_para(text="Hello World!")
... 
>>> say_hello()
>>>

```

--------------------------------

### Install Project Requirements with Poetry on Windows

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/dev_docs/dev_notes.html

After activating the virtual environment on Windows, use Poetry to install project dependencies. This command is run within the activated environment.

```powershell
(.venv) PS C:\python_ooo_dev_tools> poetry install
```

--------------------------------

### Verify pip Installation

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/windows_lo_install_pip.html

Check the installed version of pip to confirm a successful installation. This command ensures that pip is recognized by LibreOffice's Python environment.

```powershell
>.\python.exe -m pip --version

```

--------------------------------

### Install oooenv for LibreOffice API Access

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_poetry_env.html

Install the `oooenv` package within the activated virtual environment. This package provides `uno.py` and `unohelper.py` for interacting with the LibreOffice API.

```bash
poetry add --group=dev oooenv
```

--------------------------------

### Install pip using get-pip.py

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/windows_portable_install_pip.html

Download the get-pip.py script and execute it using the LibreOffice Portable's Python interpreter to install pip. Warnings about script locations can be ignored.

```powershell
(Invoke-WebRequest -Uri https://bootstrap.pypa.io/get-pip.py -UseBasicParsing).Content | .\python.exe -

```

--------------------------------

### Install Pip using Invoke-WebRequest (PowerShell)

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/windows_manual_venv.html

With the virtual environment activated, use PowerShell's `Invoke-WebRequest` to download `get-pip.py` and execute it with the environment's Python interpreter to install pip.

```powershell
Invoke-WebRequest -Uri https://bootstrap.pypa.io/get-pip.py -UseBasicParsing).Content | python.exe -

```

--------------------------------

### Install Poetry on macOS/Linux

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/poetry_env.html

Execute this command in Terminal or PowerShell to install Poetry on macOS and Linux systems.

```bash
curl -sSL https://install.python-poetry.org | python3 -
```

--------------------------------

### Install ooo-dev-tools using Poetry

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/windows_poetry_env.html

Use poetry to add the 'ooo-dev-tools' package to your project. This command installs the package and updates the pyproject.toml file.

```bash
poetry add ooo-dev-tools

```

--------------------------------

### Install OOOENV Package

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_manual_venv.html

Installs the 'oooenv' package within the activated virtual environment. This package helps configure the environment for LibreOffice API access.

```bash
python -m pip install oooenv

```

--------------------------------

### Install pip using get-pip.py

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/windows_lo_install_pip.html

Download the get-pip.py script and execute it using LibreOffice's Python interpreter to install pip. This command fetches the script and pipes its content directly to the Python executable.

```powershell
(Invoke-WebRequest -Uri https://bootstrap.pypa.io/get-pip.py -UseBasicParsing).Content | .\python.exe - 

```

--------------------------------

### Test Installed Package with a Script

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/windows_lo_install_pip.html

Execute a Python script using LibreOffice's Python interpreter to test the installed 'ooo-dev-tools' package. This script loads LibreOffice, creates a new Writer document, appends 'Hello World!', and then closes the document and LibreOffice.

```python
>.\python.exe
Python 3.8.16 (default, Apr 28 2023, 02:01:33) [MSC v.1929 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> from ooodev.loader import Lo
>>> from ooodev.write import WriteDoc
>>> 
>>> def say_hello():
...     doc = WriteDoc.from_current_doc()
...     cursor = doc.get_cursor()
...     cursor.append_para(text="Hello World!")
... 
>>> _ = Lo.load_office(Lo.ConnectSocket())
>>> doc = WriteDoc.create_doc(visible=True)
>>> say_hello()
>>> doc.close()
>>> Lo.close_office()
True
>>>

```

--------------------------------

### Verify Pip Installation (Cmd Shell)

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/windows_manual_venv.html

Confirm the pip installation and its path within the active virtual environment by running this command in a Command Prompt.

```cmd
(.venv) D:\tmp\manual>python -m pip --version

```

--------------------------------

### Install ooo-dev-tools using pip

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest

Install the ooo-dev-tools package using pip. Support for Python 3.7 was dropped in version 0.10.0.

```bash
pip install ooo-dev-tools

```

--------------------------------

### Install ooo-dev-tools Package

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/windows_lo_install_pip.html

Install the 'ooo-dev-tools' package using pip. This package is used for testing and interacting with LibreOffice applications via Python.

```powershell
>.\python.exe -m pip install ooo-dev-tools

```

--------------------------------

### Verify Pip Installation (PowerShell)

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/windows_manual_venv.html

After installing pip, verify its version and location within the activated virtual environment using this PowerShell command.

```powershell
(myproject_3.8.16) PS D:\tmp\manual> python -m pip --version

```

--------------------------------

### Test Pip Installation

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_lo_install_pip.html

Verify that pip is installed and accessible using the same Python executable identified for LibreOffice. This command checks the pip version and its location.

```bash
$ /usr/bin/python3 -m pip --version
pip 23.1.2 from /usr/local/lib/python3.10/dist-packages/pip (python 3.10)
```

--------------------------------

### Start LibreOffice with Logging Options

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/version/version_hist.html

Illustrates how to initialize LibreOffice with specific logging options, such as setting the log level during the loading process. This is useful for debugging startup issues.

```python
from __future__ import annotations
from ooodev.io.log import logging as logger

from ooodev.calc import CalcDoc
from ooodev.loader import Lo
from ooodev.loader.inst.options import Options


def main():

    loader = Lo.load_office(connector=Lo.ConnectPipe(), opt=Options(log_level=logging.DEBUG))
    doc = None
    try:
        doc = CalcDoc.create_doc(loader=loader, visible=True)
        logger.debug("Hello World")
        # do other work
    finally:
        if doc:
            doc.close()
        Lo.close_office()
```

--------------------------------

### Build HTML Documentation (Linux)

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/dev_docs/dev_notes.html

Execute this command within the ./docs directory after activating the virtual environment to build HTML documentation.

```bash
(.venv) $ make html

```

--------------------------------

### Get LibreOffice Python Version (PowerShell)

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/windows_manual_venv.html

Use this PowerShell command to retrieve the version of the Python interpreter bundled with your LibreOffice installation. This version is needed for configuring the virtual environment.

```powershell
&"C:\Program Files\LibreOffice\program\python.exe" --version

```

--------------------------------

### Get LibreOffice Python Executable Path

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_lo_install_pip.html

Use the APSO extension in LibreOffice to find the exact Python executable path that LibreOffice is using. This is crucial for ensuring compatibility when installing packages.

```python
>>> import sys
>>> sys.executable
'/usr/bin/python3'
>>>
```

--------------------------------

### Build HTML Documentation (Windows)

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/dev_docs/dev_notes.html

Execute this command within the ./docs directory after activating the virtual environment to build HTML documentation.

```powershell
PS C:\python_ooo_dev_tools\docs> make html

```

--------------------------------

### Get LibreOffice Python Version (Cmd Shell)

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/windows_manual_venv.html

Execute this command in a Windows Command Prompt to find the version of the Python interpreter used by LibreOffice. This information is crucial for the virtual environment setup.

```cmd
"C:\Program Files\LibreOffice\program\python.exe" --version

```

--------------------------------

### Initialize Poetry Project

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/windows_poetry_env.html

Initialize a new Poetry project in the current directory. This will create a pyproject.toml file.

```powershell
cd D:\tmp\project
poetry init

```

--------------------------------

### Create Project Directory

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_manual_venv.html

Creates a new directory for your project and navigates into it.

```bash
mkdir ~/myproject
cd ~/myproject

```

--------------------------------

### Install Specific Python Version with pyenv

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/windows_poetry_env.html

Install a compatible Python version (e.g., 3.8.10) using pyenv. This version will be used for the virtual environment.

```powershell
pyenv install 3.8.10

```

--------------------------------

### Create Project Directory and Virtual Environment

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_flatpak_automate_lo.html

Sets up a new project directory and creates a Python virtual environment using a specific Python version.

```bash
$ mkdir ~/my-project
cd ~/my-project

```

```bash
/usr/bin/python3.10 -m venv .venv

```

--------------------------------

### Initialize Poetry Project

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_poetry_env.html

Use `poetry init` to create a `pyproject.toml` file for your project. This command interactively guides you through setting up project metadata and dependencies.

```bash
poetry init
```

--------------------------------

### Get Unit Length

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/src/units/index.html

Gets the instance unit length.

```APIDOC
## get_unit_length() -> UnitLength

### Description
Gets instance unit length.

### Returns
Instance unit length `UnitLength.MM`.

### Return Type
UnitLength
```

--------------------------------

### Test Installed Package in LibreOffice Writer

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_lo_install_pip.html

Run a Python script within the LibreOffice APSO console to test the functionality of an installed package, such as writing 'Hello World!' to a new document.

```python
>>> from ooodev.write import WriteDoc
>>> def say_hello():
...     doc = WriteDoc.from_current_doc()
...     cursor = doc.get_cursor()
...     cursor.append_para(text="Hello World!")
... 
>>> say_hello()
>>>
```

--------------------------------

### Run Local HTTP Server for Docs (Linux)

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/dev_docs/dev_notes.html

Start a local web server in a separate terminal to view documentation by running this script.

```bash
(.venv) $ python cmds/run_http.py

```

--------------------------------

### Create Project Directory

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_poetry_env.html

Create a new directory for your project and navigate into it. This sets up the workspace for your Poetry project.

```bash
mkdir ~/myproject
cd ~/myproject
```

--------------------------------

### Get Value in Inches

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/src/units/index.html

Gets the instance value in inch units.

```APIDOC
## get_value_inch() -> float

### Description
Gets instance value in `in` (inch) units.

### Returns
Value in `in` units.

### Return Type
float
```

--------------------------------

### Get Value in Centimeters

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/src/units/index.html

Gets the instance value converted to centimeter units.

```APIDOC
## get_value_cm() -> float

### Description
Gets instance value converted to `cm` units.

### Returns
Value in `cm` units.

### Return Type
float
```

--------------------------------

### Get Value in AppFont Units

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/src/units/index.html

Gets the instance value in AppFont units.

```APIDOC
## get_value_app_font(kind: Union[PointSizeKind, int]) -> float

### Description
Gets instance value in `AppFont` units.

### Parameters
#### Path Parameters
- **kind** (PointSizeKind or int) - The kind of `AppFont` to use.

### Returns
Value in `AppFont` units.

### Note
AppFont units have different values when converted. This is true even if they have the same value in `AppFont` units. `AppFontX(10)` is not equal to `AppFontY(10)` when they are converted to different units.
`Kind` when `int` is used, the value must be one of the following:
  * `0` is `PointSizeKind.X`,
  * `1` is `PointSizeKind.Y`,
  * `2` is `PointSizeKind.WIDTH`,
  * `3` is `PointSizeKind.HEIGHT`.

### Hint
  * `PointSizeKind` can be imported from `ooodev.utils.kind.point_size_kind`.
```

--------------------------------

### Get Unit Length

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/unit_cm.html

Gets the instance unit length, which is always UnitLength.CM.

```python
    @staticmethod
    def get_unit_length() -> UnitLength:
        """
        Gets instance unit length.

        Returns:
            UnitLength: Instance unit length ``UnitLength.CM``.
        """
        return UnitLength.CM
```

--------------------------------

### Invoke Basic Script from Python

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/version/version_hist.html

Demonstrates how to get a reference to a Basic script using `ooodev.macro.script.basic.Basic` and invoke it with arguments. The script is expected to return a value.

```python
from ooodev.macro.script.basic import Basic
def r_trim(input: str, remove: str = " ") -> str:
    script = Basic.get_basic_script(macro="RTrimStr", module="Strings", library="Tools", embedded=False)
    res = script.invoke((input, remove), (), ())
    return res[0]
result = r_trim("hello ")
assert result == "hello"
```

--------------------------------

### Get Value in 1/1000th Inches

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/src/units/index.html

Gets the instance value in 1/1000th inch units.

```APIDOC
## get_value_inch1000() -> int

### Description
Gets instance value in `1/1000th inch` units.

### Returns
Value in `1/1000th inch` units.

### Return Type
int
```

--------------------------------

### Get Value in 1/100th Inches

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/src/units/index.html

Gets the instance value in 1/100th inch units.

```APIDOC
## get_value_inch100() -> int

### Description
Gets instance value in `1/100th inch` units.

### Returns
Value in `1/100th inch` units.

### Return Type
int
```

--------------------------------

### Create and Activate Virtual Environment

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_linking_paths.html

Sets up a Python virtual environment for project isolation and activates it for use.

```bash
python3 -m venv venv
source venv/bin/activate
```

--------------------------------

### Get Value in 1/10th Inches

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/src/units/index.html

Gets the instance value in 1/10th inch units.

```APIDOC
## get_value_inch10() -> int

### Description
Gets instance value in `1/10th inch` units.

### Returns
Value in `1/10th inch` units.

### Return Type
int
```

--------------------------------

### Run Local HTTP Server for Docs (Windows)

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/dev_docs/dev_notes.html

Start a local web server in a separate terminal to view documentation by running this script.

```powershell
PS C:\python_ooo_dev_tools> python .\cmds\run_http.py

```

--------------------------------

### Connect to Snap LibreOffice

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_manual_venv_snap.html

Establish a connection to a snap-installed LibreOffice instance. This is necessary when LibreOffice is installed via Snap and requires specific path configurations.

```python
Lo.ConnectSocket(soffice="/snap/bin/libreoffice", env_vars={"PYTHONPATH": py_pth})

```

--------------------------------

### from_mm10

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/unit_mm10.html

Get instance from ``1/10th mm`` value.

```APIDOC
## from_mm10

### Description
Get instance from ``1/10th mm`` value.

### Parameters
#### Path Parameters
- **value** (float) - Required - ``1/10th mm`` value.

### Returns
- UnitMM10:
```

--------------------------------

### UnitInch10 Get Value in MM100

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/unit_inch10.html

Gets the instance value converted to 1/100th of a millimeter (mm100) units.

```python
return UnitConvert.convert(num=self.value, frm=UnitLength.IN10, to=UnitLength.MM100)
```

--------------------------------

### Test Virtual Environment Import uno on Windows

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/dev_docs/dev_notes.html

Verify that the virtual environment is set up correctly by attempting to import the `uno` module in the Python interpreter. No import error indicates a successful setup.

```python
PS C:\python_ooo_dev_tools> .\.venv\scripts\activate
(.venv) PS C:\python_ooo_dev_tools> python
Python 3.8.10 (default, Mar 23 2022, 15:43:48) [MSC v.1928 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import uno
>>> 

```

--------------------------------

### Verify LibreOffice Environment Setup on Windows

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/dev_docs/dev_notes.html

Check if the virtual environment is correctly configured for LibreOffice on Windows by running `oooenv env -u`. A successful output indicates the UNO environment is active.

```powershell
(.venv) PS C:\python_ooo_dev_tools> oooenv env -u
UNO Environment
```

--------------------------------

### Get Value in PX - UnitInch1000

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/unit_inch1000.html

Gets the instance value converted to pixels (px). Requires UnitConvert to be imported.

```python
    def get_value_px(self) -> float:
        """
        Gets instance value in ``px`` (pixel) units.

        Returns:
            int: Value in ``px`` units.
        """
        return UnitConvert.convert(num=self.value, frm=UnitLength.IN1000, to=UnitLength.PX)
```

--------------------------------

### Get Value in PT - UnitInch1000

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/unit_inch1000.html

Gets the instance value converted to points (pt). Requires UnitConvert to be imported.

```python
    def get_value_pt(self) -> float:
        """
        Gets instance value converted to ``pt`` (point) units.

        Returns:
            int: Value in ``pt`` units.
        """
        return UnitConvert.convert(num=self.value, frm=UnitLength.IN1000, to=UnitLength.PT)
```

--------------------------------

### Get Value in MM - UnitInch1000

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/unit_inch1000.html

Gets the instance value converted to millimeters (mm). Requires UnitConvert to be imported.

```python
    def get_value_mm(self) -> float:
        """
        Gets instance value converted to ``mm`` units.

        Returns:
            int: Value in ``mm`` units.
        """
        return UnitConvert.convert(num=self.value, frm=UnitLength.IN1000, to=UnitLength.MM)
```

--------------------------------

### Get Value in CM - UnitInch1000

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/unit_inch1000.html

Gets the instance value converted to centimeters (cm). Requires UnitConvert to be imported.

```python
    def get_value_cm(self) -> float:
        """
        Gets instance value converted to ``cm`` units.

        Returns:
            int: Value in ``cm`` units.
        """
        return UnitConvert.convert(num=self.value, frm=UnitLength.IN1000, to=UnitLength.CM)
```

--------------------------------

### Initialize ApplicationAppearance Theme

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/theme/theme.html

Initializes the theme with a specified name or uses the current LibreOffice theme if none is provided. Raises a ValueError if no theme name can be found or if an invalid theme name is specified and automatic theme detection is off.

```python
theme_name = "" # or ThemeKind.AUTOMATIC
theme = ApplicationAppearance(theme_name=theme_name)
```

--------------------------------

### Get LibreOffice Temp Directory Path

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/version/version_hist.html

Access the Lo.tmp_dir property to get the LibreOffice temporary directory as a pathlib.Path object.

```python
from ooodev.loader import Lo
print(str(Lo.tmp_dir))
```

--------------------------------

### Get Value in 1/100th MM - UnitInch1000

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/unit_inch1000.html

Gets the instance value in 1/100th of a millimeter (mm100). Requires UnitConvert to be imported.

```python
    def get_value_mm100(self) -> int:
        """
        Gets instance value in ``1/100th mm`` units.

        Returns:
            int: Value in ``1/100th mm`` units.
        """
        return round(UnitConvert.convert(num=self.value, frm=UnitLength.IN1000, to=UnitLength.MM100))
```

--------------------------------

### Navigate to Project Directory

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/windows_poetry_env.html

Change the current directory to your project's location before creating the virtual environment.

```powershell
cd D:\tmp\project

```

--------------------------------

### from_mm100

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/unit_mm10.html

Get instance from ``1/100th mm`` value.

```APIDOC
## from_mm100

### Description
Get instance from ``1/100th mm`` value.

### Parameters
#### Path Parameters
- **value** (int) - Required - ``1/100th mm`` value.

### Returns
- UnitMM10:
```

--------------------------------

### Import Lo from ooodev.loader.lo

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/version/version_hist.html

Demonstrates the correct import path for the Lo class from the ooodev.loader.lo module.

```python
from ooodev.loader.lo import Lo
```

--------------------------------

### Configure Virtual Environment with OOOENV

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_manual_venv.html

Uses the 'oooenv' command-line tool to automatically configure the virtual environment, enabling access to 'uno.py' and 'unohelper.py'.

```bash
oooenv cmd-link -a

```

--------------------------------

### from_mm100

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/unit_inch10.html

Get instance from ``1/100th mm`` value.

```APIDOC
## from_mm100

### Description
Get instance from ``1/100th mm`` value.

### Parameters
#### Path Parameters
- **value** (int) - Required - ``1/100th mm`` value.

### Returns
- UnitInch10:
```

--------------------------------

### UnitInch10.__init__

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/src/units/index.html

Initializes a UnitInch10 object.

```APIDOC
## UnitInch10.__init__(value: float)

### Description
Initializes a UnitInch10 object.

### Parameters
- **value** (float) - The initial value for the unit.
```

--------------------------------

### Toggle back to Original Environment

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/windows_poetry_env.html

Run this command to switch back from the UNO environment to the original Python environment.

```bash
(.venv) PS D:\tmp\project> oooenv env -t
Set to Original Environment

```

--------------------------------

### ApplicationAppearance Constructor

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/theme/theme.html

Initializes the ApplicationAppearance object. It can optionally take a theme name. If no theme name is provided, it defaults to the current LibreOffice theme.

```APIDOC
## ApplicationAppearance(theme_name: ThemeKind | str | None = None)

### Description
Initializes the ApplicationAppearance object. It can optionally take a theme name. If no theme name is provided, it defaults to the current LibreOffice theme.

### Parameters
#### Path Parameters
- **theme_name** (ThemeKind | str, optional) - Theme Name. If omitted then the current LibreOffice Theme is used.

### Returns
- None: 
```

--------------------------------

### Link LibreOffice uno.py and unohelper.py on Linux

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/dev_docs/dev_notes.html

This command creates symbolic links to `uno.py` and `unohelper.py` within your virtual environment on Linux, enabling the import of LibreOffice API modules. It searches known paths for these files.

```bash
(.venv) $ oooenv cmd-link --add
```

--------------------------------

### UnitMM from_unit_val

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/unit_mm.html

Get instance from UnitT or float value. If a float is provided, it's assumed to be in millimeters. Otherwise, it attempts to get the millimeter value from a UnitT object.

```python
try:
    unit_val = value.get_value_mm()  # type: ignore
    return cls.from_mm(unit_val)
except AttributeError:
    return cls.from_mm(float(value))  # type: ignore
```

--------------------------------

### Create a Simple Python Module

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_linking_paths.html

Defines a basic Python module 'hello.py' with a 'main' function that displays a message box using LibreOffice API.

```python
from __future__ import annotations
from ooodev.loader import Lo

def main():
    doc = Lo.current_doc
    doc.msgbox('Hello, world!')

if __name__ == '__main__':
    main()
```

--------------------------------

### Basic Logging with ooodev.io.log

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/version/version_hist.html

Use the ooodev.io.log module for basic logging. The default logging level is INFO, and output is directed to the console.

```python
from ooodev.io.log import logging as logger
logger.info("Hello World")
logger.error("Error has occured")
```

--------------------------------

### MacroLoader Context Manager Example

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/macro/macro_loader.html

Demonstrates how to use the MacroLoader as a context manager to ensure proper execution of macros within a running LibreOffice instance. This is useful for encapsulating macro-related operations.

```python
from ooodev.macro.macro_loader import MacroLoader

def show_tab_dialog(*args, **kwargs):
    with MacroLoader():
        dlg = MultiSyntaxController(model=MultiSyntaxModel(), view=MultiSyntaxView())
        dlg.start()
```

--------------------------------

### Check oooenv Version

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/windows_poetry_env.html

Verify that oooenv has been successfully installed by checking its version within the activated virtual environment.

```powershell
(.venv) PS D:\tmp\project> oooenv --version

```

--------------------------------

### Create a Simple Python Macro

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_linking_paths.html

Defines a Python macro 'say_hello.py' that displays a message box. It includes 'g_exportedScripts' to make it discoverable by LibreOffice.

```python
from __future__ import annotations
from ooodev.loader import Lo


def say_hello(*args):
    doc = Lo.current_doc
    doc.msgbox("Hello, world!")

g_exportedScripts = (say_hello,)
```

--------------------------------

### Activate Virtual Environment on Linux

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/dev_docs/dev_notes.html

Activate the created virtual environment on Linux to begin installing dependencies and running project commands within the isolated environment.

```bash
source ./.venv/bin/activate
```

--------------------------------

### unknown_color

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/theme/theme_html.html

Gets the unknown color.

```APIDOC
@property
def unknown_color(self) -> int:
    """Unknown color."""
    try:
        return self._unknown_color
    except AttributeError:
        self._unknown_color = self._get_color("HTMLUnknown")
    return self._unknown_color
```

--------------------------------

### Search OooDev CLI Help

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest

Use the OooDev CLI Help tool to search for classes and methods within the OooDev project. This tool is separate from the main project and may have compatibility issues on Windows due to its reliance on Python's built-in `sqlite`.

```bash
odh hlp -s Write.append

Choose an option (default 1):
[0],  Cancel (or press q followed by enter)
[1],  ooodev.office.write.Write.append                                 - method     - py
[2],  ooodev.office.write.Write.append_date_time                       - method     - py
[3],  ooodev.office.write.Write.append_line                            - method     - py
[4],  ooodev.office.write.Write.append_para                            - method     - py

```

--------------------------------

### keyword_color

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/theme/theme_html.html

Gets the keyword color.

```APIDOC
@property
def keyword_color(self) -> int:
    """Keyword color."""
    try:
        return self._keyword_color
    except AttributeError:
        self._keyword_color = self._get_color("HTMLKeyword")
    return self._keyword_color
```

--------------------------------

### Write Basic Macro Script to Calc Document

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/version/version_hist.html

Demonstrates how to create and add a basic BASIC macro script to a Calc document using ooodev. The macro is persisted with the document. Ensure to clean up by removing the module and library if they were created for this example.

```python
from __future__ import annotations
import logging
import uno

from ooodev.calc import CalcDoc
from ooodev.loader import Lo
from ooodev.loader.inst.options import Options
from ooodev.utils.string.str_list import StrList
from ooodev.adapter.container.name_container_comp import NameContainerComp
from ooodev.macro.script.macro_script import MacroScript


def main():
    loader = Lo.load_office(connector=Lo.ConnectPipe(), opt=Options(log_level=logging.DEBUG))
    doc = CalcDoc.create_doc(loader=loader, visible=True)
    try:
        inst = doc.basic_libraries
        mod_name = "MyModule"
        lib_name = "MyLib"
        clean = True
        added_lib = False

        if not inst.has_by_name(lib_name):
            added_lib = True
            inst.create_library(lib_name)

        inst.load_library(lib_name)

        lib = NameContainerComp(inst.get_by_name(lib_name))  # type: ignore
        if lib.has_by_name(mod_name):
            lib.remove_by_name(mod_name)

        code = StrList(sep="\n")
        code.append("Option Explicit")
        code.append("Sub Main")
        with code.indented():
            code.append('MsgBox "Hello World"')
        code.append("End Sub")
        lib.insert_by_name(mod_name, code.to_string())

        MacroScript.call(
            name="Main",
            library=lib_name,
            module=mod_name,
            location="document",
        )
        print("Macro Executed")
        if clean:
            lib.remove_by_name(mod_name)
            if added_lib:
                inst.remove_library(lib_name)

        print("Done")
    finally:
        doc.close()
        Lo.close_office()

if __name__ == "__main__":
    main()

```

--------------------------------

### Display Help for oooenv cmd-link on Linux

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/dev_docs/dev_notes.html

View available options and usage for the `oooenv cmd-link` command on Linux to understand its full capabilities.

```bash
(.venv) $ oooenv cmd-link -h
```

--------------------------------

### comment_color

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/theme/theme_html.html

Gets the comment color.

```APIDOC
@property
def comment_color(self) -> int:
    """Comment color."""
    try:
        return self._comment_color
    except AttributeError:
        self._comment_color = self._get_color("HTMLComment")
    return self._comment_color
```

--------------------------------

### Configure Poetry to use project-local virtual environments

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/poetry_env.html

Set the Poetry configuration option 'virtualenvs.in-project' to 'true' to have virtual environments created in the project's root directory. This can also be configured via a 'poetry.toml' file.

```bash
poetry config virtualenvs.in-project true
```

```toml
[virtualenvs]
in-project = true
```

--------------------------------

### Angle100.get_angle()

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/angle100.html

Gets the Angle Value as 'degrees'.

```APIDOC
## get_angle()

### Description
Gets the Angle Value as ``degrees``.

### Returns
- int: The angle value in degrees.
```

--------------------------------

### Python Script to Automate LibreOffice Flatpak

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_flatpak_automate_lo.html

This script demonstrates connecting to LibreOffice Flatpak, creating a document, setting a cell value, and optionally closing the document and office. It uses `os.getenv` to get the display and `Lo.ConnectSocket` for connection.

```python
from __future__ import annotations
import os
import uno
from ooodev.office.calc import Calc
from ooodev.gui.gui import GUI
from ooodev.utils.kind.zoom_kind import ZoomKind
from ooodev.loader.lo import Lo
from ooodev.dialog.msgbox import (
    MsgBox, MessageBoxType, MessageBoxButtonsEnum, MessageBoxResultsEnum
)


def main():
    display_str = f"--display {os.getenv('DISPLAY', ':0')}"
    _ = Lo.load_office(
        Lo.ConnectSocket(
            soffice="flatpak run org.libreoffice.LibreOffice/x86_64/stable",
            extended_args=[display_str],
        )
    )
    try:
        doc = Calc.create_doc()
        GUI.set_visible(True, doc)
        Lo.delay(500)
        Calc.zoom(doc, ZoomKind.ZOOM_100_PERCENT)

        sheet = Calc.get_sheet(doc, 0)
        Calc.set_val(value="Hello World!", sheet=sheet, cell_name="A1")

        msg_result = MsgBox.msgbox(
            "Do you wish to close document?",
            "All done",
            boxtype=MessageBoxType.QUERYBOX,
            buttons=MessageBoxButtonsEnum.BUTTONS_YES_NO,
        )
        if msg_result == MessageBoxResultsEnum.YES:
            Lo.close_doc(doc=doc, deliver_ownership=True)
            Lo.close_office()
        else:
            print("Keeping document open")

    except Exception:
        Lo.close_office()
        raise
    return


if __name__ == "__main__":
    main()

```

--------------------------------

### get_angle

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/angle.html

Gets the angle value in degrees.

```APIDOC
## get_angle

### Description
Gets Angle Value as ``degrees``

### Returns
- **int**: Angle in degrees.

### Version Added
0.17.4
```

--------------------------------

### get_unit_length

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/unit_inch100.html

Gets the instance unit length, which is UnitLength.IN100.

```APIDOC
## get_unit_length

### Description
Gets instance unit length.

### Returns
- UnitLength: Instance unit length ``UnitLength.IN100``.
```

--------------------------------

### ThemeSql Class

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/src/theme/index.html

Provides SQL-related properties populated from LibreOffice theme colors.

```APIDOC
## Class ThemeSql

Theme SQL Properties.
The properties are populated from LibreOffice theme colors.
Automatic color values are returned with a value of `-1`. All other values are positive numbers.

### Parameters

- **theme_name** (_ThemeKind_ | _str_): Theme Name. If omitted then the current LibreOffice Theme is used.

### Methods

- **__init__(theme_name = '')**
  Constructor.
```

--------------------------------

### get_unit_length

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/unit_inch1000.html

Gets the instance unit length, which is UnitLength.IN1000.

```APIDOC
## get_unit_length

### Description
Gets instance unit length.

### Returns
- UnitLength: Instance unit length ``UnitLength.IN1000``.
```

--------------------------------

### get_value_inch

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/unit_cm.html

Gets the instance value converted to inches (in).

```APIDOC
## get_value_inch

### Description
Gets instance value in ``in`` (inch) units.

### Method
GET

### Endpoint
N/A (Method within a class)

### Returns
- **float**: Value in ``in`` units.
```

--------------------------------

### Angle Class Initialization and Examples

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/angle.html

Demonstrates the initialization of the Angle class with different integer values, showcasing how negative and large positive numbers are converted to positive angles within the 0-359 range.

```python
>>> print(Angle(360))
Angle(Value=0)
>>> print(Angle(413))
Angle(Value=53)
>>> print(Angle(-235))
Angle(Value=125)
>>> print(Angle(1794))
Angle(Value=354)
```

--------------------------------

### Direct Character Styling with WriteTextCursor

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/version/version_hist.html

Provides an example of how to apply direct character styling to text using the `style_direct_char` method of a WriteTextCursor. This requires importing WriteDoc and WriteTextCursor from ooodev.write.

```python
doc = WriteDoc.create_doc(visible=True)

cursor = doc.get_cursor()
cursor.append("hello")
cursor.go_left(5, True)
```

--------------------------------

### get_value_inch

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/unit_inch10.html

Gets instance value in inch units.

```APIDOC
## get_value_inch

### Description
Gets instance value in inch units.

### Returns
- float: Value in inch units.
```

--------------------------------

### get_value_pt

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/unit_pt.html

Gets the current value in points (pt).

```APIDOC
## get_value_pt

### Description
Gets instance value in ``pt`` (point) units.

### Returns
- float: Value in ``pt`` units.
```

--------------------------------

### Link oooenv for Environment Configuration

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_poetry_env.html

Use `oooenv cmd-link -a` to configure the virtual environment for LibreOffice API access. This command links the necessary uno modules.

```bash
oooenv cmd-link -a
```

--------------------------------

### Access LibreOffice Paths

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/version/version_hist.html

Instantiate ThePathSettingsComp to access LibreOffice paths like the temporary directory.

```python
from ooodev.adapter.util.the_path_settings_comp import ThePathSettingsComp
path_settings = ThePathSettingsComp.from_lo()
print(str(path_settings.temp))
```

--------------------------------

### theme_name (property)

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/theme/theme.html

Property to get the theme name.

```APIDOC
## theme_name

### Description
Gets the current theme name.

### Type
str
```

--------------------------------

### Full Python Script for Snap LibreOffice Integration

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_manual_venv_snap.html

A comprehensive Python script demonstrating how to load LibreOffice via socket connection, create a Calc document, write data, and handle user prompts for closing. It configures the virtual environment's site-packages path for LibreOffice.

```python
from __future__ import annotations
import uno
from pathlib import Path
from ooodev.calc import CalcDoc
from ooodev.utils.kind.zoom_kind import ZoomKind
from ooodev.loader import Lo
from ooodev.utils import paths
from ooodev.dialog.msgbox import (
    MessageBoxType,
    MessageBoxButtonsEnum,
    MessageBoxResultsEnum
)


def main() -> int:
    py_pth = paths.get_virtual_env_site_packages_path()
    # uncomment to include current working directory in PYTHONPATH
    # py_pth += f":{Path.cwd()}"
    _ = Lo.load_office(
        Lo.ConnectSocket(soffice="/snap/bin/libreoffice", env_vars={"PYTHONPATH": py_pth})
    )
    try:
        doc = CalcDoc.create_doc(visible=True)
        Lo.delay(500)
        doc.zoom(ZoomKind.ZOOM_100_PERCENT)

        sheet = doc.sheets[0]
        sheet["A1"]value = "Hello World!"

        msg_result = doc.msgbox(
            "Do you wish to close document?",
            "All done",
            boxtype=MessageBoxType.QUERYBOX,
            buttons=MessageBoxButtonsEnum.BUTTONS_YES_NO,
        )
        if msg_result == MessageBoxResultsEnum.YES:
            doc.close()
            Lo.close_office()
        else:
            print("Keeping document open")

    except Exception:
        Lo.close_office()
        raise
    return 0


if __name__ == "__main__":
    SystemExit(main())

```

--------------------------------

### Angle100.get_angle100()

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/angle100.html

Gets the Angle Value as '1/100 degree'.

```APIDOC
## get_angle100()

### Description
Gets the Angle Value as ``1/100 degree``.

### Returns
- int: The angle value in 1/100th degrees.
```

--------------------------------

### Set PYTHONPATH for Flatpak

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/guide/virtual_env/linux_flatpak_lo_pip.html

Add the site-packages directory of your virtual environment to the PYTHONPATH environment variable for FlatSeal. The `/home/guide/` part is optional and appended automatically.

```bash
PYTHONPATH=my-project/.venv/lib/python3.10/site-packages
```

--------------------------------

### Angle100.get_angle10()

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/angle100.html

Gets the Angle Value as '1/10 degree'.

```APIDOC
## get_angle10()

### Description
Gets the Angle Value as ``1/10 degree``.

### Returns
- int: The angle value in 1/10th degrees.
```

--------------------------------

### get_angle100

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/angle.html

Gets the angle value in 1/100th of a degree.

```APIDOC
## get_angle100

### Description
Gets Angle Value as ``1/100 degree``

### Returns
- **int**: Angle in 1/100th of a degree.
```

--------------------------------

### get_angle10

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/units/angle.html

Gets the angle value in 1/10th of a degree.

```APIDOC
## get_angle10

### Description
Gets Angle Value as ``1/10 degree``

### Returns
- **int**: Angle in 1/10th of a degree.
```

--------------------------------

### Configure Git Hooks Path

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/dev_docs/dev_notes.html

Run this command once after activating the OooDev virtual environment to point git to the local hooks directory.

```bash
git config --local core.hooksPath .githooks/

```

--------------------------------

### sgml_color

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/_modules/ooodev/theme/theme_html.html

Gets the SGML syntax highlighting color.

```APIDOC
@property
def sgml_color(self) -> int:
    """SGML syntax highlighting color."""
    try:
        return self._sgml_color
    except AttributeError:
        self._sgml_color = self._get_color("HTMLSGML")
    return self._sgml_color
```

--------------------------------

### get_value_mm10

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/src/units/index.html

Gets the instance value in `1/10th mm` units.

```APIDOC
## get_value_mm10()

### Description
Gets instance value in `1/10th mm` units.

### Returns
Value in `1/10th mm` units.

Return type:
    
float
```

--------------------------------

### Use Control as Context Manager

Source: https://python-ooo-dev-tools.readthedocs.io/en/latest/version/version_hist.html

Demonstrates using a control object as a context manager to automatically toggle design mode for property updates.

```python
with ctl:
    ctl.model.Width = 200
```
Tokens:
Raw