gtksourceview2.StyleScheme — StyleScheme object for gtksourceview2.View
class gtksourceview2.StyleScheme(gobject.GObject): |
|
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:
| Identifier for the style scheme. This is must be unique among style schemes. |
| Name of the style scheme. This is the name of the scheme to display to user, e.g. in a preferences dialog. |
|
This is the same as |
| 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. |
| Style scheme format identifier. At the moment it must be "1.0". |
style-scheme tag may contain the following tags:
| Name of the style scheme author. |
| Description of the style scheme. |
|
Same as |
|
These define color names to be used in |
| 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 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 color. It may be name defined in one of |
| Background color. |
| "true" or "false" |
| "true" or "false" |
| "true" or "false" |
| "true" or "false" |
The following are names of styles which control #GtkSourceView appearance:
| Default style of text. |
| Style of selected text. |
| Style of selected text when the widget doesn't have input focus. |
| Text cursor style. Only |
| Secondary cursor style (used in bidi text). Only |
| Current line style. Only |
| Text and background colors for the left margin, on which line numbers are drawn |
| Style to use for matching brackets. |
| Style to use for mismatching brackets. |
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.
def get_description()
Returns : | the scheme description (if defined) or None . |
The get_description
() method gets the scheme description.
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.
def get_id(style_name
)
Returns : | the scheme id. |
The get_id
() method gets the scheme id.