:right-sidebar: True

StyleScheme
===================================================================

.. currentmodule:: gi.repository.GtkSource





.. class:: StyleScheme(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.GObject.Object`





Controls the appearance of :obj:`~gi.repository.GtkSource.View`\.

:obj:`~gi.repository.GtkSource.StyleScheme` contains all the text styles to be used in
:obj:`~gi.repository.GtkSource.View` and :obj:`~gi.repository.GtkSource.Buffer`\. For instance, it contains text styles
for syntax highlighting, it may contain foreground and background color for
non-highlighted text, color for the line numbers, current line highlighting,
bracket matching, etc.

Style schemes are stored in XML files. The format of a scheme file is
documented in the `style scheme reference <./style-reference.html>`__\.

The two style schemes with IDs "classic" and "tango" follow more closely the
GTK theme (for example for the background color).




Methods
-------

.. rst-class:: interim-class

.. class:: StyleScheme
   :no-index:


   .. method:: get_authors() -> list[str] | None

      









   .. method:: get_description() -> str | None

      









   .. method:: get_filename() -> str | None

      









   .. method:: get_id() -> str

      









   .. method:: get_metadata(name: str) -> str | None

      Gets a metadata property from the style scheme.


      .. versionadded:: 5.4





      :param name: metadata property name.




   .. method:: get_name() -> str

      









   .. method:: get_style(style_id: str) -> ~gi.repository.GtkSource.Style | None

      






      :param style_id: id of the style to retrieve.








Properties
----------

.. rst-class:: interim-class

.. class:: StyleScheme
   :no-index:
   

   .. attribute:: props.description
      :type: str

      The type of the None singleton.







   .. attribute:: props.filename
      :type: str

      The type of the None singleton.







   .. attribute:: props.id
      :type: str

      The type of the None singleton.







   .. attribute:: props.name
      :type: str

      The type of the None singleton.