gnome-shell-common 3.18.4-0ubuntu3 / usr / share / gtk-doc / html / st / st-st-theme-context.html

This file is indexed.

/usr/share/gtk-doc/html/st/st-st-theme-context.html is in gnome-shell-common 3.18.4-0ubuntu3.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>st-theme-context: St Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="St Reference Manual">
<link rel="up" href="styling.html" title="Styling">
<link rel="prev" href="st-st-theme.html" title="st-theme">
<link rel="next" href="st-st-theme-node.html" title="st-theme-node">
<meta name="generator" content="GTK-Doc V1.24.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#st-st-theme-context.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="styling.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="st-st-theme.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="st-st-theme-node.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="st-st-theme-context"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="st-st-theme-context.top_of_page"></a>st-theme-context</span></h2>
<p>st-theme-context — holds global information about a tree of styled objects</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="st-st-theme-context.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="st-st-theme-node.html#StThemeContext"><span class="returnvalue">StThemeContext</span></a> *
</td>
<td class="function_name">
<a class="link" href="st-st-theme-context.html#st-theme-context-new" title="st_theme_context_new ()">st_theme_context_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="st-st-theme-node.html#StThemeContext"><span class="returnvalue">StThemeContext</span></a> *
</td>
<td class="function_name">
<a class="link" href="st-st-theme-context.html#st-theme-context-get-for-stage" title="st_theme_context_get_for_stage ()">st_theme_context_get_for_stage</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="st-st-theme-context.html#st-theme-context-set-theme" title="st_theme_context_set_theme ()">st_theme_context_set_theme</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="st-st-theme-node.html#StTheme"><span class="returnvalue">StTheme</span></a> *
</td>
<td class="function_name">
<a class="link" href="st-st-theme-context.html#st-theme-context-get-theme" title="st_theme_context_get_theme ()">st_theme_context_get_theme</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="st-st-theme-context.html#st-theme-context-set-font" title="st_theme_context_set_font ()">st_theme_context_set_font</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">PangoFontDescription</span> *
</td>
<td class="function_name">
<a class="link" href="st-st-theme-context.html#st-theme-context-get-font" title="st_theme_context_get_font ()">st_theme_context_get_font</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="st-st-theme-node.html#StThemeNode"><span class="returnvalue">StThemeNode</span></a> *
</td>
<td class="function_name">
<a class="link" href="st-st-theme-context.html#st-theme-context-get-root-node" title="st_theme_context_get_root_node ()">st_theme_context_get_root_node</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="st-st-theme-node.html#StThemeNode"><span class="returnvalue">StThemeNode</span></a> *
</td>
<td class="function_name">
<a class="link" href="st-st-theme-context.html#st-theme-context-intern-node" title="st_theme_context_intern_node ()">st_theme_context_intern_node</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="st-st-theme-context.description"></a><h2>Description</h2>
<p><a class="link" href="st-st-theme-node.html#StThemeContext"><span class="type">StThemeContext</span></a> is responsible for managing information global to a tree of styled objects,
such as the set of stylesheets or the default font. In normal usage, a <a class="link" href="st-st-theme-node.html#StThemeContext"><span class="type">StThemeContext</span></a>
is bound to a <span class="type">ClutterStage</span>; a singleton <a class="link" href="st-st-theme-node.html#StThemeContext"><span class="type">StThemeContext</span></a> can be obtained for a <span class="type">ClutterStage</span>
by using <a class="link" href="st-st-theme-context.html#st-theme-context-get-for-stage" title="st_theme_context_get_for_stage ()"><code class="function">st_theme_context_get_for_stage()</code></a>.</p>
</div>
<div class="refsect1">
<a name="st-st-theme-context.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="st-theme-context-new"></a><h3>st_theme_context_new ()</h3>
<pre class="programlisting"><a class="link" href="st-st-theme-node.html#StThemeContext"><span class="returnvalue">StThemeContext</span></a> *
st_theme_context_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Create a new theme context not associated with any <span class="type">ClutterStage</span>.
This can be useful in testing scenarios, or if using StThemeContext
with something other than <span class="type">ClutterActor</span> objects, but you generally
should use <a class="link" href="st-st-theme-context.html#st-theme-context-get-for-stage" title="st_theme_context_get_for_stage ()"><code class="function">st_theme_context_get_for_stage()</code></a> instead.</p>
</div>
<hr>
<div class="refsect2">
<a name="st-theme-context-get-for-stage"></a><h3>st_theme_context_get_for_stage ()</h3>
<pre class="programlisting"><a class="link" href="st-st-theme-node.html#StThemeContext"><span class="returnvalue">StThemeContext</span></a> *
st_theme_context_get_for_stage (<em class="parameter"><code><span class="type">ClutterStage</span> *stage</code></em>);</pre>
<p>Gets a singleton theme context associated with the stage.</p>
<div class="refsect3">
<a name="st-theme-context-get-for-stage.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <span class="type">ClutterStage</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="st-theme-context-get-for-stage.returns"></a><h4>Returns</h4>
<p> the singleton theme context for the stage. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="st-theme-context-set-theme"></a><h3>st_theme_context_set_theme ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
st_theme_context_set_theme (<em class="parameter"><code><a class="link" href="st-st-theme-node.html#StThemeContext"><span class="type">StThemeContext</span></a> *context</code></em>,
                            <em class="parameter"><code><a class="link" href="st-st-theme-node.html#StTheme"><span class="type">StTheme</span></a> *theme</code></em>);</pre>
<p>Sets the default set of theme stylesheets for the context. This theme will
be used for the root node and for nodes descending from it, unless some other
style is explicitely specified.</p>
<div class="refsect3">
<a name="st-theme-context-set-theme.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>a <a class="link" href="st-st-theme-node.html#StThemeContext"><span class="type">StThemeContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="st-theme-context-get-theme"></a><h3>st_theme_context_get_theme ()</h3>
<pre class="programlisting"><a class="link" href="st-st-theme-node.html#StTheme"><span class="returnvalue">StTheme</span></a> *
st_theme_context_get_theme (<em class="parameter"><code><a class="link" href="st-st-theme-node.html#StThemeContext"><span class="type">StThemeContext</span></a> *context</code></em>);</pre>
<p>Gets the default theme for the context. See <a class="link" href="st-st-theme-context.html#st-theme-context-set-theme" title="st_theme_context_set_theme ()"><code class="function">st_theme_context_set_theme()</code></a></p>
<div class="refsect3">
<a name="st-theme-context-get-theme.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>a <a class="link" href="st-st-theme-node.html#StThemeContext"><span class="type">StThemeContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="st-theme-context-get-theme.returns"></a><h4>Returns</h4>
<p> the default theme for the context. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="st-theme-context-set-font"></a><h3>st_theme_context_set_font ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
st_theme_context_set_font (<em class="parameter"><code><a class="link" href="st-st-theme-node.html#StThemeContext"><span class="type">StThemeContext</span></a> *context</code></em>,
                           <em class="parameter"><code>const <span class="type">PangoFontDescription</span> *font</code></em>);</pre>
<p>Sets the default font for the theme context. This is the font that
is inherited by the root node of the tree of theme nodes. If the
font is not overriden, then this font will be used. If the font is
partially modified (for example, with 'font-size: 110%', then that
modification is based on this font.</p>
<div class="refsect3">
<a name="st-theme-context-set-font.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>a <a class="link" href="st-st-theme-node.html#StThemeContext"><span class="type">StThemeContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>font</p></td>
<td class="parameter_description"><p>the default font for theme context</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="st-theme-context-get-font"></a><h3>st_theme_context_get_font ()</h3>
<pre class="programlisting">const <span class="returnvalue">PangoFontDescription</span> *
st_theme_context_get_font (<em class="parameter"><code><a class="link" href="st-st-theme-node.html#StThemeContext"><span class="type">StThemeContext</span></a> *context</code></em>);</pre>
<p>Gets the default font for the theme context. See <a class="link" href="st-st-theme-context.html#st-theme-context-set-font" title="st_theme_context_set_font ()"><code class="function">st_theme_context_set_font()</code></a>.</p>
<div class="refsect3">
<a name="st-theme-context-get-font.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>a <a class="link" href="st-st-theme-node.html#StThemeContext"><span class="type">StThemeContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="st-theme-context-get-font.returns"></a><h4>Returns</h4>
<p> the default font for the theme context.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="st-theme-context-get-root-node"></a><h3>st_theme_context_get_root_node ()</h3>
<pre class="programlisting"><a class="link" href="st-st-theme-node.html#StThemeNode"><span class="returnvalue">StThemeNode</span></a> *
st_theme_context_get_root_node (<em class="parameter"><code><a class="link" href="st-st-theme-node.html#StThemeContext"><span class="type">StThemeContext</span></a> *context</code></em>);</pre>
<p>Gets the root node of the tree of theme style nodes that associated with this
context. For the node tree associated with a stage, this node represents
styles applied to the stage itself.</p>
<div class="refsect3">
<a name="st-theme-context-get-root-node.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>a <a class="link" href="st-st-theme-node.html#StThemeContext"><span class="type">StThemeContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="st-theme-context-get-root-node.returns"></a><h4>Returns</h4>
<p> the root node of the context's style tree. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="st-theme-context-intern-node"></a><h3>st_theme_context_intern_node ()</h3>
<pre class="programlisting"><a class="link" href="st-st-theme-node.html#StThemeNode"><span class="returnvalue">StThemeNode</span></a> *
st_theme_context_intern_node (<em class="parameter"><code><a class="link" href="st-st-theme-node.html#StThemeContext"><span class="type">StThemeContext</span></a> *context</code></em>,
                              <em class="parameter"><code><a class="link" href="st-st-theme-node.html#StThemeNode"><span class="type">StThemeNode</span></a> *node</code></em>);</pre>
<p>Return an existing node matching <em class="parameter"><code>node</code></em>
, or if that isn't possible,
<em class="parameter"><code>node</code></em>
 itself.</p>
<div class="refsect3">
<a name="st-theme-context-intern-node.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>a <a class="link" href="st-st-theme-node.html#StThemeContext"><span class="type">StThemeContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>node</p></td>
<td class="parameter_description"><p>a <a class="link" href="st-st-theme-node.html#StThemeNode"><span class="type">StThemeNode</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="st-theme-context-intern-node.returns"></a><h4>Returns</h4>
<p> a node with the same properties as <em class="parameter"><code>node</code></em>
. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="st-st-theme-context.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24.1</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.