gtksourceview2.StyleScheme
Prev |  | Next

## gtksourceview2.StyleScheme

gtksourceview2.StyleScheme — StyleScheme object for gtksourceview2.View

## Synopsis

    class gtksourceview2.StyleScheme(gobject.GObject):
        def get_authors()
        def get_description()
        def get_filename()
        def get_id()
        def get_name()
        def get_style()

## Ancestry

    +-- gobject.GObject
        +-- gtksourceview2.StyleScheme

## Properties

"description" | Read | Style scheme description. Default value: `None`.
"filename" | Read | Style scheme filename or `None`. Default value: `None`.
"id" | Read-Write-Construct only | Style scheme id, a unique string used to identify the style scheme in `gtksourceview2.StyleSchemeManager`. Default value: `None`.
"name" | Read-Write | Style scheme name, a translatable string to present to user. Default value: `None`.

## Description

`gtksourceview2.StyleScheme` contains all the text styles to be used in `gtksourceview2.View` and `gtksourceview2.Buffer`. For instance, it contains text styles for syntax highlighting, it may contain foreground and background color for non-highlighted text, etc.

Style schemes are stored in XML files. The format of scheme file is the following.

The toplevel tag in a style scheme file is <style-scheme>. It has the following attributes:

`id` (mandatory) | Identifier for the style scheme. This is must be unique among style schemes.
`name` (mandatory) | Name of the style scheme. This is the name of the scheme to display to user, e.g. in a preferences dialog.
`_name` | This is the same as `name` attribute, except it will be translated. `name` and `_name` may not be used simultaneously.
`parent-scheme` (optional) | Style schemes may have parent schemes: all styles but those specified in the scheme will be taken from the parent scheme. In this way a scheme may be customized without copying all its content.
`version` (mandatory) | Style scheme format identifier. At the moment it must be "1.0".

style-scheme tag may contain the following tags:

`author` | Name of the style scheme author.
`description` | Description of the style scheme.
`_description` | Same as `description` except it will be localized.
`color` tags | These define color names to be used in `style` tags. It has two attributes: `name` and `value`. `value` is the hexadecimal color specification like "#000000" or named color understood by Gdk prefixed with "#", e.g. "#beige".
`style` tags | See below for their format description.

Each `style` tag describes a single element of style scheme (it corresponds to #GtkSourceStyle object). It has the following attributes:

`name` (mandatory) | Name of the style. It can be anything, syntax highlighting uses lang-id:style-id, and there are few special styles which are used to control general appearance of the text. Style scheme may contain other names to be used in an application. For instance, it may define color to highlight compilation errors in a build log or a color for bookmarks.
`foreground` | Foreground color. It may be name defined in one of `color` tags, or value in hexadecimal format, e.g. "#000000", or symbolic name understood by Gdk, prefixed with "#", e.g. "#magenta" or "#darkred".
`background` | Background color.
`italic` | "true" or "false"
`bold` | "true" or "false"
`underline` | "true" or "false"
`strikethrough` | "true" or "false"

The following are names of styles which control #GtkSourceView appearance:

`text` | Default style of text.
`selection` | Style of selected text.
`selection-unfocused` | Style of selected text when the widget doesn't have input focus.
`cursor` | Text cursor style. Only `foreground` attribute is used for this style
`secondary-cursor` | Secondary cursor style (used in bidi text). Only `foreground` attribute is used for this style. If this is not set while "cursor" is, then a color between text background and cursor colors is chosen, so it is enough to use "cursor" style only.
`current-line` | Current line style. Only `background` attribute is used
`line-numbers` | Text and background colors for the left margin, on which line numbers are drawn
`bracket-match` | Style to use for matching brackets.
`bracket-mismatch` | Style to use for mismatching brackets.

## Methods

### gtksourceview2.StyleScheme.get_authors

        def get_authors()

Returns : | a list containing the scheme authors or `>None` if no author is specified by the style.

The `get_authors`() method returns a list of scheme authors.

### gtksourceview2.StyleScheme.get_description

        def get_description()

Returns : | the scheme description (if defined) or `None`.

The `get_description`() method gets the scheme description.

### gtksourceview2.StyleScheme.get_filename

        def get_filename()

Returns : | the scheme file name if the scheme was created parsing a style scheme file or `None`.

The `get_filename`() method gets the scheme filename.

### gtksourceview2.StyleScheme.get_id

        def get_id(style_name)

Returns : | the scheme id.

The `get_id`() method gets the scheme id.

### gtksourceview2.StyleScheme.get_name

        def get_name()

Returns : | the name of the style scheme.

The `get_name`() method gets the name of the style scheme.

### gtksourceview2.StyleScheme.get_style

        def get_style(style_id)

`style_id` : | the id of a style.
Returns : | the style which corresponds to `style_id` in the scheme, or `None` when no style with this name found.

The `get_style`() method gets the style which corresponds to style_id in the scheme.

Prev |  | Next
gtksourceview2.Style | Home | gtksourceview2.StyleSchemeManager