File: stylescheme.sgml

package info (click to toggle)
gtksourceview2 2.2.2-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 8,856 kB
  • ctags: 1,896
  • sloc: ansic: 18,630; sh: 9,199; xml: 4,509; python: 424; makefile: 272
file content (284 lines) | stat: -rw-r--r-- 7,512 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
<!-- ##### SECTION Title ##### -->
GtkSourceStyleScheme

<!-- ##### SECTION Short_Description ##### -->

Object controlling apperance of #GtkSourceView

<!-- ##### SECTION Long_Description ##### -->
<para>
#GtkSourceStyleScheme contains all the text styles to be used
in #GtkSourceView and #GtkSourceBuffer. For instance, it contains
text styles for syntax highlighting, it may contain foreground
and background color for non-highlighted text, etc.
</para>

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

<para>
The toplevel tag in a style scheme file is <code>&lt;style-scheme&gt;</code>.
It has the following attributes:
<variablelist>
<varlistentry>
<term><code>id</code> (mandatory)</term>
<listitem><para>
Identifier for the style scheme. This is must be unique among style schemes.
</para></listitem>
</varlistentry>
<varlistentry>
<term><code>name</code> (mandatory)</term>
<listitem><para>
Name of the style scheme. This is the name of the scheme to display to user, e.g.
in a preferences dialog.
</para></listitem>
</varlistentry>
<varlistentry>
<term><code>_name</code></term>
<listitem><para>
This is the same as <code>name</code> attribute, except it will be translated.
<code>name</code> and <code>_name</code> may not be used simultaneously.
</para></listitem>
</varlistentry>
<varlistentry>
<term><code>parent-scheme</code> (optional)</term>
<listitem><para>
Style schemes may have <em>parent</em> 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.
</para></listitem>
</varlistentry>
<varlistentry>
<term><code>version</code> (mandatory)</term>
<listitem><para>
Style scheme format identifier. At the moment it must be "1.0".
</para></listitem>
</varlistentry>
</variablelist>
</para>

<para>
<code>style-scheme</code> tag may contain the following tags:
<variablelist>
<varlistentry>
<term><code>author</code></term>
<listitem><para>
Name of the style scheme author.
</para></listitem>
</varlistentry>
<varlistentry>
<term><code>description</code></term>
<listitem><para>
Description of the style scheme.
</para></listitem>
</varlistentry>
<varlistentry>
<term><code>_description</code></term>
<listitem><para>
Same as <code>description</code> except it will be localized.
</para></listitem>
</varlistentry>
<varlistentry>
<term><code>color</code> tags</term>
<listitem><para>
These define color names to be used in <code>style</code> tags.
It has two attributes: <code>name</code> and <code>value</code>.
<code>value</code> is the hexadecimal color specification like
"&num;000000" or named color understood by Gdk prefixed with "&num;",
e.g. "&num;beige".
</para></listitem>
</varlistentry>
<varlistentry>
<term><code>style</code> tags</term>
<listitem><para>
See below for their format description.
</para></listitem>
</varlistentry>
</variablelist>
</para>

<para>
Each <code>style</code> tag describes a single element of style scheme (it corresponds
to #GtkSourceStyle object). It has the following attributes:
<variablelist>
<varlistentry>
<term><code>name</code> (mandatory)</term>
<listitem><para>
Name of the style. It can be anything, syntax highlighting uses <em>lang-id:style-id</em>, 
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.
</para></listitem>
</varlistentry>
<varlistentry>
<term><code>foreground</code></term>
<listitem><para>
Foreground color. It may be name defined in one of <code>color</code> tags, or value in 
hexadecimal format, e.g. "&num;000000", or symbolic name understood
by Gdk, prefixed with "&num;", e.g. "&num;magenta" or "&num;darkred".
</para></listitem>
</varlistentry>
<varlistentry>
<term><code>background</code></term>
<listitem><para>
Background color.
</para></listitem>
</varlistentry>
<varlistentry>
<term><code>italic</code></term>
<listitem><para>"true" or "false"</para></listitem>
</varlistentry>
<varlistentry>
<term><code>bold</code></term>
<listitem><para>"true" or "false"</para></listitem>
</varlistentry>
<varlistentry>
<term><code>underline</code></term>
<listitem><para>"true" or "false"</para></listitem>
</varlistentry>
<varlistentry>
<term><code>strikethrough</code></term>
<listitem><para>"true" or "false"</para></listitem>
</varlistentry>
</variablelist>
</para>

<para>
The following are names of styles which control #GtkSourceView appearance:
<variablelist>
<varlistentry>
<term><code>text</code></term>
<listitem><para>Default style of text.</para></listitem>
</varlistentry>
<varlistentry>
<term><code>selection</code></term>
<listitem><para>Style of selected text.</para></listitem>
</varlistentry>
<varlistentry>
<term><code>selection-unfocused</code></term>
<listitem><para>Style of selected text when the widget doesn't have input focus.</para></listitem>
</varlistentry>
<varlistentry>
<term><code>cursor</code></term>
<listitem><para>Text cursor style. Only <code>foreground</code> attribute is used
for this style</para></listitem>
</varlistentry>
<varlistentry>
<term><code>secondary-cursor</code></term>
<listitem><para>Secondary cursor style (used in bidi text). Only <code>foreground</code> 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.</para></listitem>
</varlistentry>
<varlistentry>
<term><code>current-line</code></term>
<listitem><para>Current line style. Only <code>background</code> attribute is used</para></listitem>
</varlistentry>
<varlistentry>
<term><code>line-numbers</code></term>
<listitem><para>Text and background colors for the left margin, on which line numbers are 
drawn</para></listitem>
</varlistentry>
<varlistentry>
<term><code>bracket-match</code></term>
<listitem><para>Style to use for matching brackets.</para></listitem>
</varlistentry>
<varlistentry>
<term><code>bracket-mismatch</code></term>
<listitem><para>Style to use for mismatching brackets.</para></listitem>
</varlistentry>
</variablelist>
</para>

<!-- ##### SECTION See_Also ##### -->
<para>
#GtkSourceStyle, #GtkSourceStyleManager
</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### STRUCT GtkSourceStyleScheme ##### -->
<para>
<structname>GtkSourceStyleScheme</structname> structure contains only
private members and should not be accessed directly.
</para>


<!-- ##### ARG GtkSourceStyleScheme:description ##### -->
<para>

</para>

<!-- ##### ARG GtkSourceStyleScheme:filename ##### -->
<para>

</para>

<!-- ##### ARG GtkSourceStyleScheme:id ##### -->
<para>

</para>

<!-- ##### ARG GtkSourceStyleScheme:name ##### -->
<para>

</para>

<!-- ##### FUNCTION gtk_source_style_scheme_get_id ##### -->
<para>

</para>

@scheme: 
@Returns: 


<!-- ##### FUNCTION gtk_source_style_scheme_get_name ##### -->
<para>

</para>

@scheme: 
@Returns: 


<!-- ##### FUNCTION gtk_source_style_scheme_get_description ##### -->
<para>

</para>

@scheme: 
@Returns: 


<!-- ##### FUNCTION gtk_source_style_scheme_get_authors ##### -->
<para>

</para>

@scheme: 
@Returns: 


<!-- ##### FUNCTION gtk_source_style_scheme_get_filename ##### -->
<para>

</para>

@scheme: 
@Returns: 


<!-- ##### FUNCTION gtk_source_style_scheme_get_style ##### -->
<para>

</para>

@scheme: 
@style_id: 
@Returns: