The ``ansys.scade.guitools`` library
====================================
.. py:module:: ansys.scade.guitools
Summary
-------
.. py:currentmodule:: guitools
.. tab-set::
.. tab-item:: Submodules
.. list-table::
:header-rows: 0
:widths: auto
* - :py:obj:`~ansys.scade.guitools.command`
- Provides a SCADE IDE Command base class.
* - :py:obj:`~ansys.scade.guitools.control`
- Provides extensions for new or existing controls.
* - :py:obj:`~ansys.scade.guitools.csts`
- Provides default metrics for designing dialog boxes and controls.
* - :py:obj:`~ansys.scade.guitools.data`
- Provides extensions for the persistence of settings and properties.
* - :py:obj:`~ansys.scade.guitools.dialog`
- Provides an extension for the Dialog class.
* - :py:obj:`~ansys.scade.guitools.enable_debugpy`
- Enables remote debugging with ``debugpy``.
* - :py:obj:`~ansys.scade.guitools.guihost`
- Provides access to GUI server for property pages.
* - :py:obj:`~ansys.scade.guitools.ide`
- SCADE IDE abstraction.
* - :py:obj:`~ansys.scade.guitools.interfaces`
- Interfaces for GUI Host pages and data persistence.
* - :py:obj:`~ansys.scade.guitools.page`
- Provides an extension for the Page classes.
* - :py:obj:`~ansys.scade.guitools.register`
- Registers the Ansys SCADE GUI Tools extension registry files (SRG).
* - :py:obj:`~ansys.scade.guitools.stubs`
- Stubs for unit tests.
* - :py:obj:`~ansys.scade.guitools.studio`
- ``Ide`` interface implementation.
* - :py:obj:`~ansys.scade.guitools.studio_ext`
- ``Ide`` interface implementation for custom extensions.
* - :py:obj:`~ansys.scade.guitools.unregister`
- Unregisters the Ansys SCADE GUI Tools extension registry files (SRG).
.. tab-item:: Functions
.. list-table::
:header-rows: 0
:widths: auto
* - :py:obj:`~ansys.scade.guitools.get_srg_name`
- Return the name of the registration file for Ansys SCADE IDE.
* - :py:obj:`~ansys.scade.guitools.srg`
- Return the path of the SCADE Studio registry file.
.. tab-item:: Attributes
.. list-table::
:header-rows: 0
:widths: auto
* - :py:obj:`~__version__`
-
.. toctree::
:titlesonly:
:maxdepth: 1
:hidden:
command
control
csts
data
dialog
enable_debugpy
guihost
ide
interfaces
page
register
stubs
studio
studio_ext
unregister
.. toctree::
:titlesonly:
:maxdepth: 1
:hidden:
get_srg_name
srg
Description
-----------
Provides a Python library to extend the Ansys SCADE IDE GUI.
Module detail
-------------
.. py:data:: __version__