1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>StWidget</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7
<link rel="home" href="index.html" title="St Reference Manual">
8
<link rel="up" href="base.html" title="Abstract classes and Interfaces">
9
<link rel="prev" href="base.html" title="Abstract classes and Interfaces">
10
<link rel="next" href="StWidgetAccessible.html" title="StWidgetAccessible">
11
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
<td><a accesskey="p" href="base.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="base.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
<th width="100%" align="center">St Reference Manual</th>
21
<td><a accesskey="n" href="StWidgetAccessible.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#StWidget.synopsis" class="shortcut">Top</a>
26
<a href="#StWidget.description" class="shortcut">Description</a>
28
<a href="#StWidget.object-hierarchy" class="shortcut">Object Hierarchy</a>
30
<a href="#StWidget.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32
<a href="#StWidget.properties" class="shortcut">Properties</a>
34
<a href="#StWidget.signals" class="shortcut">Signals</a>
37
<div class="refentry">
38
<a name="StWidget"></a><div class="titlepage"></div>
39
<div class="refnamediv"><table width="100%"><tr>
41
<h2><span class="refentrytitle"><a name="StWidget.top_of_page"></a>StWidget</span></h2>
42
<p>StWidget — Base class for stylable actors</p>
44
<td valign="top" align="right"></td>
46
<div class="refsynopsisdiv">
47
<a name="StWidget.synopsis"></a><h2>Synopsis</h2>
48
<pre class="synopsis">enum <a class="link" href="StWidget.html#StTextDirection" title="enum StTextDirection">StTextDirection</a>;
49
struct <a class="link" href="StWidget.html#StWidget-struct" title="struct StWidget">StWidget</a>;
50
struct <a class="link" href="StWidget.html#StWidgetClass" title="struct StWidgetClass">StWidgetClass</a>;
51
<span class="returnvalue">char</span> * <a class="link" href="StWidget.html#st-describe-actor" title="st_describe_actor ()">st_describe_actor</a> (<em class="parameter"><code><span class="type">ClutterActor</span> *actor</code></em>);
52
<span class="returnvalue">gfloat</span> <a class="link" href="StWidget.html#st-get-slow-down-factor" title="st_get_slow_down_factor ()">st_get_slow_down_factor</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
53
<span class="returnvalue">void</span> <a class="link" href="StWidget.html#st-set-slow-down-factor" title="st_set_slow_down_factor ()">st_set_slow_down_factor</a> (<em class="parameter"><code><span class="type">gfloat</span> factor</code></em>);
54
<span class="returnvalue">void</span> <a class="link" href="StWidget.html#st-widget-add-style-class-name" title="st_widget_add_style_class_name ()">st_widget_add_style_class_name</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>,
55
<em class="parameter"><code>const <span class="type">gchar</span> *style_class</code></em>);
56
<span class="returnvalue">void</span> <a class="link" href="StWidget.html#st-widget-add-style-pseudo-class" title="st_widget_add_style_pseudo_class ()">st_widget_add_style_pseudo_class</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>,
57
<em class="parameter"><code>const <span class="type">gchar</span> *pseudo_class</code></em>);
58
<span class="returnvalue">void</span> <a class="link" href="StWidget.html#st-widget-ensure-style" title="st_widget_ensure_style ()">st_widget_ensure_style</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);
59
<span class="returnvalue">gboolean</span> <a class="link" href="StWidget.html#st-widget-get-can-focus" title="st_widget_get_can_focus ()">st_widget_get_can_focus</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);
60
<a class="link" href="StWidget.html#StTextDirection" title="enum StTextDirection"><span class="returnvalue">StTextDirection</span></a> <a class="link" href="StWidget.html#st-widget-get-default-direction" title="st_widget_get_default_direction ()">st_widget_get_default_direction</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
61
<a class="link" href="StWidget.html#StTextDirection" title="enum StTextDirection"><span class="returnvalue">StTextDirection</span></a> <a class="link" href="StWidget.html#st-widget-get-direction" title="st_widget_get_direction ()">st_widget_get_direction</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *self</code></em>);
62
<span class="returnvalue">GList</span> * <a class="link" href="StWidget.html#st-widget-get-focus-chain" title="st_widget_get_focus_chain ()">st_widget_get_focus_chain</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);
63
<span class="returnvalue">gboolean</span> <a class="link" href="StWidget.html#st-widget-get-hover" title="st_widget_get_hover ()">st_widget_get_hover</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);
64
<span class="returnvalue">ClutterActor</span> * <a class="link" href="StWidget.html#st-widget-get-label-actor" title="st_widget_get_label_actor ()">st_widget_get_label_actor</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);
65
const <span class="returnvalue">gchar</span> * <a class="link" href="StWidget.html#st-widget-get-style" title="st_widget_get_style ()">st_widget_get_style</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>);
66
const <span class="returnvalue">gchar</span> * <a class="link" href="StWidget.html#st-widget-get-style-class-name" title="st_widget_get_style_class_name ()">st_widget_get_style_class_name</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>);
67
const <span class="returnvalue">gchar</span> * <a class="link" href="StWidget.html#st-widget-get-style-pseudo-class" title="st_widget_get_style_pseudo_class ()">st_widget_get_style_pseudo_class</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>);
68
<a class="link" href="st-st-theme-node.html#StTheme"><span class="returnvalue">StTheme</span></a> * <a class="link" href="StWidget.html#st-widget-get-theme" title="st_widget_get_theme ()">st_widget_get_theme</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>);
69
<a class="link" href="st-st-theme-node.html#StThemeNode"><span class="returnvalue">StThemeNode</span></a> * <a class="link" href="StWidget.html#st-widget-get-theme-node" title="st_widget_get_theme_node ()">st_widget_get_theme_node</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);
70
<span class="returnvalue">gboolean</span> <a class="link" href="StWidget.html#st-widget-get-track-hover" title="st_widget_get_track_hover ()">st_widget_get_track_hover</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);
71
<span class="returnvalue">gboolean</span> <a class="link" href="StWidget.html#st-widget-has-style-class-name" title="st_widget_has_style_class_name ()">st_widget_has_style_class_name</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>,
72
<em class="parameter"><code>const <span class="type">gchar</span> *style_class</code></em>);
73
<span class="returnvalue">gboolean</span> <a class="link" href="StWidget.html#st-widget-has-style-pseudo-class" title="st_widget_has_style_pseudo_class ()">st_widget_has_style_pseudo_class</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>,
74
<em class="parameter"><code>const <span class="type">gchar</span> *pseudo_class</code></em>);
75
<span class="returnvalue">gboolean</span> <a class="link" href="StWidget.html#st-widget-navigate-focus" title="st_widget_navigate_focus ()">st_widget_navigate_focus</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>,
76
<em class="parameter"><code><span class="type">ClutterActor</span> *from</code></em>,
77
<em class="parameter"><code><span class="type">GtkDirectionType</span> direction</code></em>,
78
<em class="parameter"><code><span class="type">gboolean</span> wrap_around</code></em>);
79
<span class="returnvalue">void</span> <a class="link" href="StWidget.html#st-widget-paint-background" title="st_widget_paint_background ()">st_widget_paint_background</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);
80
<a class="link" href="st-st-theme-node.html#StThemeNode"><span class="returnvalue">StThemeNode</span></a> * <a class="link" href="StWidget.html#st-widget-peek-theme-node" title="st_widget_peek_theme_node ()">st_widget_peek_theme_node</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);
81
<span class="returnvalue">void</span> <a class="link" href="StWidget.html#st-widget-remove-style-class-name" title="st_widget_remove_style_class_name ()">st_widget_remove_style_class_name</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>,
82
<em class="parameter"><code>const <span class="type">gchar</span> *style_class</code></em>);
83
<span class="returnvalue">void</span> <a class="link" href="StWidget.html#st-widget-remove-style-pseudo-class" title="st_widget_remove_style_pseudo_class ()">st_widget_remove_style_pseudo_class</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>,
84
<em class="parameter"><code>const <span class="type">gchar</span> *pseudo_class</code></em>);
85
<span class="returnvalue">void</span> <a class="link" href="StWidget.html#st-widget-set-can-focus" title="st_widget_set_can_focus ()">st_widget_set_can_focus</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>,
86
<em class="parameter"><code><span class="type">gboolean</span> can_focus</code></em>);
87
<span class="returnvalue">void</span> <a class="link" href="StWidget.html#st-widget-set-default-direction" title="st_widget_set_default_direction ()">st_widget_set_default_direction</a> (<em class="parameter"><code><a class="link" href="StWidget.html#StTextDirection" title="enum StTextDirection"><span class="type">StTextDirection</span></a> dir</code></em>);
88
<span class="returnvalue">void</span> <a class="link" href="StWidget.html#st-widget-set-direction" title="st_widget_set_direction ()">st_widget_set_direction</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *self</code></em>,
89
<em class="parameter"><code><a class="link" href="StWidget.html#StTextDirection" title="enum StTextDirection"><span class="type">StTextDirection</span></a> dir</code></em>);
90
<span class="returnvalue">void</span> <a class="link" href="StWidget.html#st-widget-set-hover" title="st_widget_set_hover ()">st_widget_set_hover</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>,
91
<em class="parameter"><code><span class="type">gboolean</span> hover</code></em>);
92
<span class="returnvalue">void</span> <a class="link" href="StWidget.html#st-widget-set-label-actor" title="st_widget_set_label_actor ()">st_widget_set_label_actor</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>,
93
<em class="parameter"><code><span class="type">ClutterActor</span> *label</code></em>);
94
<span class="returnvalue">void</span> <a class="link" href="StWidget.html#st-widget-set-style" title="st_widget_set_style ()">st_widget_set_style</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>,
95
<em class="parameter"><code>const <span class="type">gchar</span> *style</code></em>);
96
<span class="returnvalue">void</span> <a class="link" href="StWidget.html#st-widget-set-style-class-name" title="st_widget_set_style_class_name ()">st_widget_set_style_class_name</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>,
97
<em class="parameter"><code>const <span class="type">gchar</span> *style_class_list</code></em>);
98
<span class="returnvalue">void</span> <a class="link" href="StWidget.html#st-widget-set-style-pseudo-class" title="st_widget_set_style_pseudo_class ()">st_widget_set_style_pseudo_class</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>,
99
<em class="parameter"><code>const <span class="type">gchar</span> *pseudo_class_list</code></em>);
100
<span class="returnvalue">void</span> <a class="link" href="StWidget.html#st-widget-set-theme" title="st_widget_set_theme ()">st_widget_set_theme</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>,
101
<em class="parameter"><code><a class="link" href="st-st-theme-node.html#StTheme"><span class="type">StTheme</span></a> *theme</code></em>);
102
<span class="returnvalue">void</span> <a class="link" href="StWidget.html#st-widget-set-track-hover" title="st_widget_set_track_hover ()">st_widget_set_track_hover</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>,
103
<em class="parameter"><code><span class="type">gboolean</span> track_hover</code></em>);
104
<span class="returnvalue">void</span> <a class="link" href="StWidget.html#st-widget-style-changed" title="st_widget_style_changed ()">st_widget_style_changed</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);
105
<span class="returnvalue">void</span> <a class="link" href="StWidget.html#st-widget-sync-hover" title="st_widget_sync_hover ()">st_widget_sync_hover</a> (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);
108
<div class="refsect1">
109
<a name="StWidget.object-hierarchy"></a><h2>Object Hierarchy</h2>
110
<pre class="synopsis">
112
+----GInitiallyUnowned
115
+----<a class="link" href="StBin.html" title="StBin">StBin</a>
116
+----<a class="link" href="StContainer.html" title="StContainer">StContainer</a>
117
+----<a class="link" href="StDrawingArea.html" title="StDrawingArea">StDrawingArea</a>
118
+----<a class="link" href="StEntry.html" title="StEntry">StEntry</a>
119
+----<a class="link" href="StIcon.html" title="StIcon">StIcon</a>
120
+----<a class="link" href="StLabel.html" title="StLabel">StLabel</a>
124
<div class="refsect1">
125
<a name="StWidget.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
128
ClutterContainer, ClutterScriptable, ClutterAnimatable and AtkImplementorIface.</p>
130
<div class="refsect1">
131
<a name="StWidget.properties"></a><h2>Properties</h2>
132
<pre class="synopsis">
133
"<a class="link" href="StWidget.html#StWidget--can-focus" title='The "can-focus" property'>can-focus</a>" <span class="type">gboolean</span> : Read / Write
134
"<a class="link" href="StWidget.html#StWidget--hover" title='The "hover" property'>hover</a>" <span class="type">gboolean</span> : Read / Write
135
"<a class="link" href="StWidget.html#StWidget--label-actor" title='The "label-actor" property'>label-actor</a>" <span class="type">ClutterActor</span>* : Read / Write
136
"<a class="link" href="StWidget.html#StWidget--pseudo-class" title='The "pseudo-class" property'>pseudo-class</a>" <span class="type">gchar</span>* : Read / Write
137
"<a class="link" href="StWidget.html#StWidget--stylable" title='The "stylable" property'>stylable</a>" <span class="type">gboolean</span> : Read / Write
138
"<a class="link" href="StWidget.html#StWidget--style" title='The "style" property'>style</a>" <span class="type">gchar</span>* : Read / Write
139
"<a class="link" href="StWidget.html#StWidget--style-class" title='The "style-class" property'>style-class</a>" <span class="type">gchar</span>* : Read / Write
140
"<a class="link" href="StWidget.html#StWidget--theme" title='The "theme" property'>theme</a>" <a class="link" href="st-st-theme-node.html#StTheme"><span class="type">StTheme</span></a>* : Read / Write
141
"<a class="link" href="StWidget.html#StWidget--track-hover" title='The "track-hover" property'>track-hover</a>" <span class="type">gboolean</span> : Read / Write
144
<div class="refsect1">
145
<a name="StWidget.signals"></a><h2>Signals</h2>
146
<pre class="synopsis">
147
"<a class="link" href="StWidget.html#StWidget-popup-menu" title='The "popup-menu" signal'>popup-menu</a>" : <code class="literal">Run Last</code>
148
"<a class="link" href="StWidget.html#StWidget-style-changed" title='The "style-changed" signal'>style-changed</a>" : <code class="literal">Run Last</code>
151
<div class="refsect1">
152
<a name="StWidget.description"></a><h2>Description</h2>
154
<a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> is a simple abstract class on top of <span class="type">ClutterActor</span>. It
155
provides basic themeing properties.
158
Actors in the St library should subclass <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> if they plan
159
to obey to a certain <span class="type">StStyle</span>.
162
<div class="refsect1">
163
<a name="StWidget.details"></a><h2>Details</h2>
164
<div class="refsect2">
165
<a name="StTextDirection"></a><h3>enum StTextDirection</h3>
166
<pre class="programlisting">typedef enum {
167
ST_TEXT_DIRECTION_NONE,
168
ST_TEXT_DIRECTION_LTR,
169
ST_TEXT_DIRECTION_RTL
174
<div class="refsect2">
175
<a name="StWidget-struct"></a><h3>struct StWidget</h3>
176
<pre class="programlisting">struct StWidget;</pre>
178
Base class for stylable actors. The contents of the <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
179
structure are private and should only be accessed through the
184
<div class="refsect2">
185
<a name="StWidgetClass"></a><h3>struct StWidgetClass</h3>
186
<pre class="programlisting">struct StWidgetClass {
190
Base class for stylable actors.
194
<div class="refsect2">
195
<a name="st-describe-actor"></a><h3>st_describe_actor ()</h3>
196
<pre class="programlisting"><span class="returnvalue">char</span> * st_describe_actor (<em class="parameter"><code><span class="type">ClutterActor</span> *actor</code></em>);</pre>
198
Creates a string describing <em class="parameter"><code>actor</code></em>, for use in debugging. This
199
includes the class name and actor name (if any), plus if <em class="parameter"><code>actor</code></em>
200
is an <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>, its style class and pseudo class names.
202
<div class="variablelist"><table border="0">
203
<col align="left" valign="top">
206
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
207
<td>a <span class="type">ClutterActor</span>
211
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
212
<td>the debug name.</td>
218
<div class="refsect2">
219
<a name="st-get-slow-down-factor"></a><h3>st_get_slow_down_factor ()</h3>
220
<pre class="programlisting"><span class="returnvalue">gfloat</span> st_get_slow_down_factor (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
221
<div class="variablelist"><table border="0">
222
<col align="left" valign="top">
224
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
225
<td>the global factor applied to all animation durations</td>
230
<div class="refsect2">
231
<a name="st-set-slow-down-factor"></a><h3>st_set_slow_down_factor ()</h3>
232
<pre class="programlisting"><span class="returnvalue">void</span> st_set_slow_down_factor (<em class="parameter"><code><span class="type">gfloat</span> factor</code></em>);</pre>
234
<em class="parameter"><code>factor</code></em>: new slow-down factor
237
Set a global factor applied to all animation durations
241
<div class="refsect2">
242
<a name="st-widget-add-style-class-name"></a><h3>st_widget_add_style_class_name ()</h3>
243
<pre class="programlisting"><span class="returnvalue">void</span> st_widget_add_style_class_name (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>,
244
<em class="parameter"><code>const <span class="type">gchar</span> *style_class</code></em>);</pre>
246
Adds <em class="parameter"><code>style_class</code></em> to <em class="parameter"><code>actor</code></em>'s style class name list, if it is not
249
<div class="variablelist"><table border="0">
250
<col align="left" valign="top">
253
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
254
<td>a <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
258
<td><p><span class="term"><em class="parameter"><code>style_class</code></em> :</span></p></td>
259
<td>a style class name string</td>
265
<div class="refsect2">
266
<a name="st-widget-add-style-pseudo-class"></a><h3>st_widget_add_style_pseudo_class ()</h3>
267
<pre class="programlisting"><span class="returnvalue">void</span> st_widget_add_style_pseudo_class (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>,
268
<em class="parameter"><code>const <span class="type">gchar</span> *pseudo_class</code></em>);</pre>
270
Adds <em class="parameter"><code>pseudo_class</code></em> to <em class="parameter"><code>actor</code></em>'s pseudo class list, if it is not
273
<div class="variablelist"><table border="0">
274
<col align="left" valign="top">
277
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
278
<td>a <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
282
<td><p><span class="term"><em class="parameter"><code>pseudo_class</code></em> :</span></p></td>
283
<td>a pseudo class string</td>
289
<div class="refsect2">
290
<a name="st-widget-ensure-style"></a><h3>st_widget_ensure_style ()</h3>
291
<pre class="programlisting"><span class="returnvalue">void</span> st_widget_ensure_style (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);</pre>
293
Ensures that <em class="parameter"><code>widget</code></em> has read its style information.
295
<div class="variablelist"><table border="0">
296
<col align="left" valign="top">
298
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
299
<td>A <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
305
<div class="refsect2">
306
<a name="st-widget-get-can-focus"></a><h3>st_widget_get_can_focus ()</h3>
307
<pre class="programlisting"><span class="returnvalue">gboolean</span> st_widget_get_can_focus (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);</pre>
309
Returns the current value of the can-focus property. See
310
<a class="link" href="StWidget.html#st-widget-set-can-focus" title="st_widget_set_can_focus ()"><code class="function">st_widget_set_can_focus()</code></a> for more information.
312
<div class="variablelist"><table border="0">
313
<col align="left" valign="top">
316
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
317
<td>A <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
321
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
322
<td>current value of can-focus on <em class="parameter"><code>widget</code></em>
329
<div class="refsect2">
330
<a name="st-widget-get-default-direction"></a><h3>st_widget_get_default_direction ()</h3>
331
<pre class="programlisting"><a class="link" href="StWidget.html#StTextDirection" title="enum StTextDirection"><span class="returnvalue">StTextDirection</span></a> st_widget_get_default_direction (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
334
<div class="refsect2">
335
<a name="st-widget-get-direction"></a><h3>st_widget_get_direction ()</h3>
336
<pre class="programlisting"><a class="link" href="StWidget.html#StTextDirection" title="enum StTextDirection"><span class="returnvalue">StTextDirection</span></a> st_widget_get_direction (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *self</code></em>);</pre>
339
<div class="refsect2">
340
<a name="st-widget-get-focus-chain"></a><h3>st_widget_get_focus_chain ()</h3>
341
<pre class="programlisting"><span class="returnvalue">GList</span> * st_widget_get_focus_chain (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);</pre>
343
Gets a list of the focusable children of <em class="parameter"><code>widget</code></em>, in "Tab"
344
order. By default, this returns all visible
345
(as in <code class="function">CLUTTER_ACTOR_IS_VISIBLE()</code>) children of <em class="parameter"><code>widget</code></em>.
347
<div class="variablelist"><table border="0">
348
<col align="left" valign="top">
351
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
352
<td>An <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
356
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
358
<em class="parameter"><code>widget</code></em>'s focusable children. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Clutter.Actor][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span>
365
<div class="refsect2">
366
<a name="st-widget-get-hover"></a><h3>st_widget_get_hover ()</h3>
367
<pre class="programlisting"><span class="returnvalue">gboolean</span> st_widget_get_hover (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);</pre>
369
If <a class="link" href="StWidget.html#StWidget--track-hover" title='The "track-hover" property'><span class="type">"track-hover"</span></a> is set, this returns whether the pointer
370
is currently over the widget.
372
<div class="variablelist"><table border="0">
373
<col align="left" valign="top">
376
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
377
<td>A <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
381
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
382
<td>current value of hover on <em class="parameter"><code>widget</code></em>
389
<div class="refsect2">
390
<a name="st-widget-get-label-actor"></a><h3>st_widget_get_label_actor ()</h3>
391
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> * st_widget_get_label_actor (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);</pre>
393
Gets the label that identifies <em class="parameter"><code>widget</code></em> if it is defined
395
<div class="variablelist"><table border="0">
396
<col align="left" valign="top">
399
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
400
<td>a <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
404
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
405
<td>the label that identifies the widget. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
412
<div class="refsect2">
413
<a name="st-widget-get-style"></a><h3>st_widget_get_style ()</h3>
414
<pre class="programlisting">const <span class="returnvalue">gchar</span> * st_widget_get_style (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>);</pre>
416
Get the current inline style string. See <a class="link" href="StWidget.html#st-widget-set-style" title="st_widget_set_style ()"><code class="function">st_widget_set_style()</code></a>.
418
<div class="variablelist"><table border="0">
419
<col align="left" valign="top">
422
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
423
<td>a <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
427
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
428
<td>The inline style string, or <a href="/home/otaylor/gnome/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. The string is owned by the
429
<a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> and should not be modified or freed.</td>
435
<div class="refsect2">
436
<a name="st-widget-get-style-class-name"></a><h3>st_widget_get_style_class_name ()</h3>
437
<pre class="programlisting">const <span class="returnvalue">gchar</span> * st_widget_get_style_class_name (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>);</pre>
439
Get the current style class name
441
<div class="variablelist"><table border="0">
442
<col align="left" valign="top">
445
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
446
<td>a <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
450
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
451
<td>the class name string. The string is owned by the <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> and
452
should not be modified or freed.</td>
458
<div class="refsect2">
459
<a name="st-widget-get-style-pseudo-class"></a><h3>st_widget_get_style_pseudo_class ()</h3>
460
<pre class="programlisting">const <span class="returnvalue">gchar</span> * st_widget_get_style_pseudo_class (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>);</pre>
462
Get the current style pseudo class list.
465
Note that an actor can have multiple pseudo classes; if you just
466
want to test for the presence of a specific pseudo class, use
467
<a class="link" href="StWidget.html#st-widget-has-style-pseudo-class" title="st_widget_has_style_pseudo_class ()"><code class="function">st_widget_has_style_pseudo_class()</code></a>.
469
<div class="variablelist"><table border="0">
470
<col align="left" valign="top">
473
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
474
<td>a <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
478
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
479
<td>the pseudo class list string. The string is owned by the
480
<a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> and should not be modified or freed.</td>
486
<div class="refsect2">
487
<a name="st-widget-get-theme"></a><h3>st_widget_get_theme ()</h3>
488
<pre class="programlisting"><a class="link" href="st-st-theme-node.html#StTheme"><span class="returnvalue">StTheme</span></a> * st_widget_get_theme (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>);</pre>
490
Gets the overriding theme set on the actor. See <a class="link" href="StWidget.html#st-widget-set-theme" title="st_widget_set_theme ()"><code class="function">st_widget_set_theme()</code></a>
492
<div class="variablelist"><table border="0">
493
<col align="left" valign="top">
496
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
497
<td>a <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
501
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
502
<td>the overriding theme, or <a href="/home/otaylor/gnome/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
509
<div class="refsect2">
510
<a name="st-widget-get-theme-node"></a><h3>st_widget_get_theme_node ()</h3>
511
<pre class="programlisting"><a class="link" href="st-st-theme-node.html#StThemeNode"><span class="returnvalue">StThemeNode</span></a> * st_widget_get_theme_node (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);</pre>
513
Gets the theme node holding style information for the widget.
514
The theme node is used to access standard and custom CSS
515
properties of the widget.
518
Note: it is a fatal error to call this on a widget that is
519
not been added to a stage.
521
<div class="variablelist"><table border="0">
522
<col align="left" valign="top">
525
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
526
<td>a <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
530
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
531
<td>the theme node for the widget.
532
This is owned by the widget. When attributes of the widget
533
or the environment that affect the styling change (for example
534
the style_class property of the widget), it will be recreated,
535
and the ::style-changed signal will be emitted on the widget. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
542
<div class="refsect2">
543
<a name="st-widget-get-track-hover"></a><h3>st_widget_get_track_hover ()</h3>
544
<pre class="programlisting"><span class="returnvalue">gboolean</span> st_widget_get_track_hover (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);</pre>
546
Returns the current value of the track-hover property. See
547
<a class="link" href="StWidget.html#st-widget-set-track-hover" title="st_widget_set_track_hover ()"><code class="function">st_widget_set_track_hover()</code></a> for more information.
549
<div class="variablelist"><table border="0">
550
<col align="left" valign="top">
553
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
554
<td>A <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
558
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
559
<td>current value of track-hover on <em class="parameter"><code>widget</code></em>
566
<div class="refsect2">
567
<a name="st-widget-has-style-class-name"></a><h3>st_widget_has_style_class_name ()</h3>
568
<pre class="programlisting"><span class="returnvalue">gboolean</span> st_widget_has_style_class_name (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>,
569
<em class="parameter"><code>const <span class="type">gchar</span> *style_class</code></em>);</pre>
571
Tests if <em class="parameter"><code>actor</code></em>'s style class list includes <em class="parameter"><code>style_class</code></em>.
573
<div class="variablelist"><table border="0">
574
<col align="left" valign="top">
577
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
578
<td>a <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
582
<td><p><span class="term"><em class="parameter"><code>style_class</code></em> :</span></p></td>
583
<td>a style class string</td>
586
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
587
<td>whether or not <em class="parameter"><code>actor</code></em>'s style class list includes
588
<em class="parameter"><code>style_class</code></em>.</td>
594
<div class="refsect2">
595
<a name="st-widget-has-style-pseudo-class"></a><h3>st_widget_has_style_pseudo_class ()</h3>
596
<pre class="programlisting"><span class="returnvalue">gboolean</span> st_widget_has_style_pseudo_class (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>,
597
<em class="parameter"><code>const <span class="type">gchar</span> *pseudo_class</code></em>);</pre>
599
Tests if <em class="parameter"><code>actor</code></em>'s pseudo class list includes <em class="parameter"><code>pseudo_class</code></em>.
601
<div class="variablelist"><table border="0">
602
<col align="left" valign="top">
605
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
606
<td>a <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
610
<td><p><span class="term"><em class="parameter"><code>pseudo_class</code></em> :</span></p></td>
611
<td>a pseudo class string</td>
614
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
615
<td>whether or not <em class="parameter"><code>actor</code></em>'s pseudo class list includes
616
<em class="parameter"><code>pseudo_class</code></em>.</td>
622
<div class="refsect2">
623
<a name="st-widget-navigate-focus"></a><h3>st_widget_navigate_focus ()</h3>
624
<pre class="programlisting"><span class="returnvalue">gboolean</span> st_widget_navigate_focus (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>,
625
<em class="parameter"><code><span class="type">ClutterActor</span> *from</code></em>,
626
<em class="parameter"><code><span class="type">GtkDirectionType</span> direction</code></em>,
627
<em class="parameter"><code><span class="type">gboolean</span> wrap_around</code></em>);</pre>
629
Tries to update the keyboard focus within <em class="parameter"><code>widget</code></em> in response to a
633
If <em class="parameter"><code>from</code></em> is a descendant of <em class="parameter"><code>widget</code></em>, this attempts to move the
634
keyboard focus to the next descendant of <em class="parameter"><code>widget</code></em> (in the order
635
implied by <em class="parameter"><code>direction</code></em>) that has the <a class="link" href="StWidget.html#StWidget--can-focus" title='The "can-focus" property'><span class="type">"can-focus"</span></a> property
636
set. If <em class="parameter"><code>from</code></em> is <a href="/home/otaylor/gnome/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>, or outside of <em class="parameter"><code>widget</code></em>, this attempts to
637
focus either <em class="parameter"><code>widget</code></em> itself, or its first descendant in the order
638
implied by <em class="parameter"><code>direction</code></em>.
641
If a container type is marked <a class="link" href="StWidget.html#StWidget--can-focus" title='The "can-focus" property'><span class="type">"can-focus"</span></a>, the expected
642
behavior is that it will only take up a single slot on the focus
643
chain as a whole, rather than allowing navigation between its child
644
actors (or having a distinction between itself being focused and
645
one of its children being focused).
648
Some widget classes might have slightly different behavior from the
649
above, where that would make more sense.
652
If <em class="parameter"><code>wrap_around</code></em> is <code class="literal">TRUE</code> and <em class="parameter"><code>from</code></em> is a child of <em class="parameter"><code>widget</code></em>, but the
653
widget has no further children that can accept the focus in the
654
given direction, then <a class="link" href="StWidget.html#st-widget-navigate-focus" title="st_widget_navigate_focus ()"><code class="function">st_widget_navigate_focus()</code></a> will try a second
655
time, using a <a href="/home/otaylor/gnome/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> <em class="parameter"><code>from</code></em>, which should cause it to reset the focus
656
to the first available widget in the given direction.
658
<div class="variablelist"><table border="0">
659
<col align="left" valign="top">
662
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
663
<td>the "top level" container</td>
666
<td><p><span class="term"><em class="parameter"><code>from</code></em> :</span></p></td>
667
<td>the actor that the focus is coming from. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
671
<td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
672
<td>the direction focus is moving in</td>
675
<td><p><span class="term"><em class="parameter"><code>wrap_around</code></em> :</span></p></td>
676
<td>whether focus should wrap around</td>
679
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
681
<code class="literal">TRUE</code> if <code class="function">clutter_actor_grab_key_focus()</code> has been
682
called on an actor. <code class="literal">FALSE</code> if not.</td>
688
<div class="refsect2">
689
<a name="st-widget-paint-background"></a><h3>st_widget_paint_background ()</h3>
690
<pre class="programlisting"><span class="returnvalue">void</span> st_widget_paint_background (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);</pre>
692
Paint the background of the widget. This is meant to be called by
693
subclasses of StWiget that need to paint the background without
696
<div class="variablelist"><table border="0">
697
<col align="left" valign="top">
699
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
700
<td>The <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
706
<div class="refsect2">
707
<a name="st-widget-peek-theme-node"></a><h3>st_widget_peek_theme_node ()</h3>
708
<pre class="programlisting"><a class="link" href="st-st-theme-node.html#StThemeNode"><span class="returnvalue">StThemeNode</span></a> * st_widget_peek_theme_node (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);</pre>
710
Returns the theme node for the widget if it has already been
711
computed, <a href="/home/otaylor/gnome/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if the widget hasn't been added to a stage or the theme
712
node hasn't been computed. If <a href="/home/otaylor/gnome/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> is returned, then ::style-changed
713
will be reliably emitted before the widget is allocated or painted.
715
<div class="variablelist"><table border="0">
716
<col align="left" valign="top">
719
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
720
<td>a <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
724
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
725
<td>the theme node for the widget.
726
This is owned by the widget. When attributes of the widget
727
or the environment that affect the styling change (for example
728
the style_class property of the widget), it will be recreated,
729
and the ::style-changed signal will be emitted on the widget. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
736
<div class="refsect2">
737
<a name="st-widget-remove-style-class-name"></a><h3>st_widget_remove_style_class_name ()</h3>
738
<pre class="programlisting"><span class="returnvalue">void</span> st_widget_remove_style_class_name (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>,
739
<em class="parameter"><code>const <span class="type">gchar</span> *style_class</code></em>);</pre>
741
Removes <em class="parameter"><code>style_class</code></em> from <em class="parameter"><code>actor</code></em>'s style class name, if it is
744
<div class="variablelist"><table border="0">
745
<col align="left" valign="top">
748
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
749
<td>a <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
753
<td><p><span class="term"><em class="parameter"><code>style_class</code></em> :</span></p></td>
754
<td>a style class name string</td>
760
<div class="refsect2">
761
<a name="st-widget-remove-style-pseudo-class"></a><h3>st_widget_remove_style_pseudo_class ()</h3>
762
<pre class="programlisting"><span class="returnvalue">void</span> st_widget_remove_style_pseudo_class (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>,
763
<em class="parameter"><code>const <span class="type">gchar</span> *pseudo_class</code></em>);</pre>
765
Removes <em class="parameter"><code>pseudo_class</code></em> from <em class="parameter"><code>actor</code></em>'s pseudo class, if it is present.
767
<div class="variablelist"><table border="0">
768
<col align="left" valign="top">
771
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
772
<td>a <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
776
<td><p><span class="term"><em class="parameter"><code>pseudo_class</code></em> :</span></p></td>
777
<td>a pseudo class string</td>
783
<div class="refsect2">
784
<a name="st-widget-set-can-focus"></a><h3>st_widget_set_can_focus ()</h3>
785
<pre class="programlisting"><span class="returnvalue">void</span> st_widget_set_can_focus (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>,
786
<em class="parameter"><code><span class="type">gboolean</span> can_focus</code></em>);</pre>
788
Marks <em class="parameter"><code>widget</code></em> as being able to receive keyboard focus via
791
<div class="variablelist"><table border="0">
792
<col align="left" valign="top">
795
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
796
<td>A <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
800
<td><p><span class="term"><em class="parameter"><code>can_focus</code></em> :</span></p></td>
802
<code class="literal">TRUE</code> if the widget can receive keyboard focus
803
via keyboard navigation</td>
809
<div class="refsect2">
810
<a name="st-widget-set-default-direction"></a><h3>st_widget_set_default_direction ()</h3>
811
<pre class="programlisting"><span class="returnvalue">void</span> st_widget_set_default_direction (<em class="parameter"><code><a class="link" href="StWidget.html#StTextDirection" title="enum StTextDirection"><span class="type">StTextDirection</span></a> dir</code></em>);</pre>
814
<div class="refsect2">
815
<a name="st-widget-set-direction"></a><h3>st_widget_set_direction ()</h3>
816
<pre class="programlisting"><span class="returnvalue">void</span> st_widget_set_direction (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *self</code></em>,
817
<em class="parameter"><code><a class="link" href="StWidget.html#StTextDirection" title="enum StTextDirection"><span class="type">StTextDirection</span></a> dir</code></em>);</pre>
820
<div class="refsect2">
821
<a name="st-widget-set-hover"></a><h3>st_widget_set_hover ()</h3>
822
<pre class="programlisting"><span class="returnvalue">void</span> st_widget_set_hover (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>,
823
<em class="parameter"><code><span class="type">gboolean</span> hover</code></em>);</pre>
825
Sets <em class="parameter"><code>widget</code></em>'s hover property and adds or removes "hover" from its
826
pseudo class accordingly.
829
If you have set <a class="link" href="StWidget.html#StWidget--track-hover" title='The "track-hover" property'><span class="type">"track-hover"</span></a>, you should not need to call
830
this directly. You can call <a class="link" href="StWidget.html#st-widget-sync-hover" title="st_widget_sync_hover ()"><code class="function">st_widget_sync_hover()</code></a> if the hover
831
state might be out of sync due to another actor's pointer grab.
833
<div class="variablelist"><table border="0">
834
<col align="left" valign="top">
837
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
838
<td>A <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
842
<td><p><span class="term"><em class="parameter"><code>hover</code></em> :</span></p></td>
843
<td>whether the pointer is hovering over the widget</td>
849
<div class="refsect2">
850
<a name="st-widget-set-label-actor"></a><h3>st_widget_set_label_actor ()</h3>
851
<pre class="programlisting"><span class="returnvalue">void</span> st_widget_set_label_actor (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>,
852
<em class="parameter"><code><span class="type">ClutterActor</span> *label</code></em>);</pre>
854
Sets <em class="parameter"><code>label</code></em> as the <span class="type">ClutterActor</span> that identifies (labels)
855
<em class="parameter"><code>widget</code></em>. <em class="parameter"><code>label</code></em> can be <a href="/home/otaylor/gnome/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> to indicate that <em class="parameter"><code>widget</code></em> is not
858
<div class="variablelist"><table border="0">
859
<col align="left" valign="top">
862
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
863
<td>a <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
867
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
868
<td>a <span class="type">ClutterActor</span>
875
<div class="refsect2">
876
<a name="st-widget-set-style"></a><h3>st_widget_set_style ()</h3>
877
<pre class="programlisting"><span class="returnvalue">void</span> st_widget_set_style (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>,
878
<em class="parameter"><code>const <span class="type">gchar</span> *style</code></em>);</pre>
880
Set the inline style string for this widget. The inline style string is an
881
optional ';'-separated list of CSS properties that override the style as
882
determined from the stylesheets of the current theme.
884
<div class="variablelist"><table border="0">
885
<col align="left" valign="top">
888
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
889
<td>a <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
893
<td><p><span class="term"><em class="parameter"><code>style</code></em> :</span></p></td>
894
<td>a inline style string, or <a href="/home/otaylor/gnome/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
901
<div class="refsect2">
902
<a name="st-widget-set-style-class-name"></a><h3>st_widget_set_style_class_name ()</h3>
903
<pre class="programlisting"><span class="returnvalue">void</span> st_widget_set_style_class_name (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>,
904
<em class="parameter"><code>const <span class="type">gchar</span> *style_class_list</code></em>);</pre>
906
Set the style class name list. <em class="parameter"><code>style_class_list</code></em> can either be
907
<a href="/home/otaylor/gnome/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>, for no classes, or a space-separated list of style class
908
names. See also <a class="link" href="StWidget.html#st-widget-add-style-class-name" title="st_widget_add_style_class_name ()"><code class="function">st_widget_add_style_class_name()</code></a> and
909
<a class="link" href="StWidget.html#st-widget-remove-style-class-name" title="st_widget_remove_style_class_name ()"><code class="function">st_widget_remove_style_class_name()</code></a>.
911
<div class="variablelist"><table border="0">
912
<col align="left" valign="top">
915
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
916
<td>a <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
920
<td><p><span class="term"><em class="parameter"><code>style_class_list</code></em> :</span></p></td>
921
<td>a new style class list string. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
928
<div class="refsect2">
929
<a name="st-widget-set-style-pseudo-class"></a><h3>st_widget_set_style_pseudo_class ()</h3>
930
<pre class="programlisting"><span class="returnvalue">void</span> st_widget_set_style_pseudo_class (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>,
931
<em class="parameter"><code>const <span class="type">gchar</span> *pseudo_class_list</code></em>);</pre>
933
Set the style pseudo class list. <em class="parameter"><code>pseudo_class_list</code></em> can either be
934
<a href="/home/otaylor/gnome/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>, for no classes, or a space-separated list of pseudo class
935
names. See also <a class="link" href="StWidget.html#st-widget-add-style-pseudo-class" title="st_widget_add_style_pseudo_class ()"><code class="function">st_widget_add_style_pseudo_class()</code></a> and
936
<a class="link" href="StWidget.html#st-widget-remove-style-pseudo-class" title="st_widget_remove_style_pseudo_class ()"><code class="function">st_widget_remove_style_pseudo_class()</code></a>.
938
<div class="variablelist"><table border="0">
939
<col align="left" valign="top">
942
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
943
<td>a <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
947
<td><p><span class="term"><em class="parameter"><code>pseudo_class_list</code></em> :</span></p></td>
948
<td>a new pseudo class list string. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
955
<div class="refsect2">
956
<a name="st-widget-set-theme"></a><h3>st_widget_set_theme ()</h3>
957
<pre class="programlisting"><span class="returnvalue">void</span> st_widget_set_theme (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *actor</code></em>,
958
<em class="parameter"><code><a class="link" href="st-st-theme-node.html#StTheme"><span class="type">StTheme</span></a> *theme</code></em>);</pre>
960
Overrides the theme that would be inherited from the actor's parent
961
or the stage with an entirely new theme (set of stylesheets).
963
<div class="variablelist"><table border="0">
964
<col align="left" valign="top">
967
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
968
<td>a <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
972
<td><p><span class="term"><em class="parameter"><code>theme</code></em> :</span></p></td>
973
<td>a new style class string</td>
979
<div class="refsect2">
980
<a name="st-widget-set-track-hover"></a><h3>st_widget_set_track_hover ()</h3>
981
<pre class="programlisting"><span class="returnvalue">void</span> st_widget_set_track_hover (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>,
982
<em class="parameter"><code><span class="type">gboolean</span> track_hover</code></em>);</pre>
984
Enables hover tracking on the <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>.
987
If hover tracking is enabled, and the widget is visible and
988
reactive, then <em class="parameter"><code>widget</code></em>'s <a class="link" href="StWidget.html#StWidget--hover" title='The "hover" property'><span class="type">"hover"</span></a> property will be updated
989
automatically to reflect whether the pointer is in <em class="parameter"><code>widget</code></em> (or one
990
of its children), and <em class="parameter"><code>widget</code></em>'s <a class="link" href="StWidget.html#StWidget--pseudo-class" title='The "pseudo-class" property'><span class="type">"pseudo-class"</span></a> will have
991
the "hover" class added and removed from it accordingly.
994
Note that currently it is not possible to correctly track the hover
995
state when another actor has a pointer grab. You can use
996
<a class="link" href="StWidget.html#st-widget-sync-hover" title="st_widget_sync_hover ()"><code class="function">st_widget_sync_hover()</code></a> to update the property manually in this
999
<div class="variablelist"><table border="0">
1000
<col align="left" valign="top">
1003
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
1004
<td>A <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
1008
<td><p><span class="term"><em class="parameter"><code>track_hover</code></em> :</span></p></td>
1010
<code class="literal">TRUE</code> if the widget should track the pointer hover state</td>
1016
<div class="refsect2">
1017
<a name="st-widget-style-changed"></a><h3>st_widget_style_changed ()</h3>
1018
<pre class="programlisting"><span class="returnvalue">void</span> st_widget_style_changed (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);</pre>
1021
<div class="refsect2">
1022
<a name="st-widget-sync-hover"></a><h3>st_widget_sync_hover ()</h3>
1023
<pre class="programlisting"><span class="returnvalue">void</span> st_widget_sync_hover (<em class="parameter"><code><a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget</code></em>);</pre>
1025
Sets <em class="parameter"><code>widget</code></em>'s hover state according to the current pointer
1026
position. This can be used to ensure that it is correct after
1027
(or during) a pointer grab.
1029
<div class="variablelist"><table border="0">
1030
<col align="left" valign="top">
1032
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
1033
<td>A <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
1039
<div class="refsect1">
1040
<a name="StWidget.property-details"></a><h2>Property Details</h2>
1041
<div class="refsect2">
1042
<a name="StWidget--can-focus"></a><h3>The <code class="literal">"can-focus"</code> property</h3>
1043
<pre class="programlisting"> "can-focus" <span class="type">gboolean</span> : Read / Write</pre>
1045
Whether or not the widget can be focused via keyboard navigation.
1047
<p>Default value: FALSE</p>
1050
<div class="refsect2">
1051
<a name="StWidget--hover"></a><h3>The <code class="literal">"hover"</code> property</h3>
1052
<pre class="programlisting"> "hover" <span class="type">gboolean</span> : Read / Write</pre>
1054
Whether or not the pointer is currently hovering over the widget. This is
1055
only tracked automatically if <a class="link" href="StWidget.html#StWidget--track-hover" title='The "track-hover" property'><span class="type">"track-hover"</span></a> is <code class="literal">TRUE</code>, but you can
1056
adjust it manually in any case.
1058
<p>Default value: FALSE</p>
1061
<div class="refsect2">
1062
<a name="StWidget--label-actor"></a><h3>The <code class="literal">"label-actor"</code> property</h3>
1063
<pre class="programlisting"> "label-actor" <span class="type">ClutterActor</span>* : Read / Write</pre>
1064
<p>Label that identifies this widget.</p>
1067
<div class="refsect2">
1068
<a name="StWidget--pseudo-class"></a><h3>The <code class="literal">"pseudo-class"</code> property</h3>
1069
<pre class="programlisting"> "pseudo-class" <span class="type">gchar</span>* : Read / Write</pre>
1071
The pseudo-class of the actor. Typical values include "hover", "active",
1074
<p>Default value: ""</p>
1077
<div class="refsect2">
1078
<a name="StWidget--stylable"></a><h3>The <code class="literal">"stylable"</code> property</h3>
1079
<pre class="programlisting"> "stylable" <span class="type">gboolean</span> : Read / Write</pre>
1081
Enable or disable styling of the widget
1083
<p>Default value: TRUE</p>
1086
<div class="refsect2">
1087
<a name="StWidget--style"></a><h3>The <code class="literal">"style"</code> property</h3>
1088
<pre class="programlisting"> "style" <span class="type">gchar</span>* : Read / Write</pre>
1090
Inline style information for the actor as a ';'-separated list of
1093
<p>Default value: ""</p>
1096
<div class="refsect2">
1097
<a name="StWidget--style-class"></a><h3>The <code class="literal">"style-class"</code> property</h3>
1098
<pre class="programlisting"> "style-class" <span class="type">gchar</span>* : Read / Write</pre>
1100
The style-class of the actor for use in styling.
1102
<p>Default value: ""</p>
1105
<div class="refsect2">
1106
<a name="StWidget--theme"></a><h3>The <code class="literal">"theme"</code> property</h3>
1107
<pre class="programlisting"> "theme" <a class="link" href="st-st-theme-node.html#StTheme"><span class="type">StTheme</span></a>* : Read / Write</pre>
1109
A theme set on this actor overriding the global theming for this actor
1114
<div class="refsect2">
1115
<a name="StWidget--track-hover"></a><h3>The <code class="literal">"track-hover"</code> property</h3>
1116
<pre class="programlisting"> "track-hover" <span class="type">gboolean</span> : Read / Write</pre>
1118
Determines whether the widget tracks pointer hover state. If
1119
<code class="literal">TRUE</code> (and the widget is visible and reactive), the
1120
<a class="link" href="StWidget.html#StWidget--hover" title='The "hover" property'><span class="type">"hover"</span></a> property and "hover" style pseudo class will be
1121
adjusted automatically as the pointer moves in and out of the
1124
<p>Default value: FALSE</p>
1127
<div class="refsect1">
1128
<a name="StWidget.signal-details"></a><h2>Signal Details</h2>
1129
<div class="refsect2">
1130
<a name="StWidget-popup-menu"></a><h3>The <code class="literal">"popup-menu"</code> signal</h3>
1131
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget,
1132
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
1134
Emitted when the user has requested a context menu (eg, via a
1137
<div class="variablelist"><table border="0">
1138
<col align="left" valign="top">
1141
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
1142
<td>the <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
1146
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1147
<td>user data set when the signal handler was connected.</td>
1153
<div class="refsect2">
1154
<a name="StWidget-style-changed"></a><h3>The <code class="literal">"style-changed"</code> signal</h3>
1155
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> *widget,
1156
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
1158
Emitted when the style information that the widget derives from the
1161
<div class="variablelist"><table border="0">
1162
<col align="left" valign="top">
1165
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
1166
<td>the <a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a>
1170
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1171
<td>user data set when the signal handler was connected.</td>
1178
<div class="footer">
1180
Generated by GTK-Doc V1.18.1</div>
b'\\ No newline at end of file'
added
removed
docs/reference/st/html/StWidget.html
