/usr/share/gtk-doc/html/goffice-0.10/GOStyledObject.html is in libgoffice-0.10-doc 0.10.9-1.
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 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GOStyledObject</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GOffice Reference Manual">
<link rel="up" href="ch09.html" title="Graphic object properties">
<link rel="prev" href="GOStyle.html" title="GOStyle">
<link rel="next" href="goffice-0.10-Miscellaneous.html" title="Miscellaneous">
<meta name="generator" content="GTK-Doc V1.19 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="GOStyle.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch09.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GOffice Reference Manual</th>
<td><a accesskey="n" href="goffice-0.10-Miscellaneous.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GOStyledObject.synopsis" class="shortcut">Top</a>
|
<a href="#GOStyledObject.description" class="shortcut">Description</a>
|
<a href="#GOStyledObject.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GOStyledObject.implementations" class="shortcut">Known Implementations</a>
</td></tr>
</table>
<div class="refentry">
<a name="GOStyledObject"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GOStyledObject.top_of_page"></a>GOStyledObject</span></h2>
<p>GOStyledObject — Objects with style</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GOStyledObject.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="GOStyledObject.html#GOStyledObject-struct" title="GOStyledObject">GOStyledObject</a>;
<a class="link" href="GOStyledObject.html#GOStyledObjectClass" title="GOStyledObjectClass">GOStyledObjectClass</a>;
<span class="returnvalue">void</span> <a class="link" href="GOStyledObject.html#go-styled-object-apply-theme" title="go_styled_object_apply_theme ()">go_styled_object_apply_theme</a> (<em class="parameter"><code><a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a> *gso</code></em>,
<em class="parameter"><code><a class="link" href="GOStyle.html" title="GOStyle"><span class="type">GOStyle</span></a> *style</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GOStyledObject.html#go-styled-object-fill" title="go_styled_object_fill ()">go_styled_object_fill</a> (<em class="parameter"><code><a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a> const *so</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"><span class="type">cairo_t</span></a> *cr</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> preserve</code></em>);
<a class="link" href="GOStyle.html" title="GOStyle"><span class="returnvalue">GOStyle</span></a> * <a class="link" href="GOStyledObject.html#go-styled-object-get-auto-style" title="go_styled_object_get_auto_style ()">go_styled_object_get_auto_style</a> (<em class="parameter"><code><a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a> *gso</code></em>);
<a class="link" href="GODoc.html" title="GODoc"><span class="returnvalue">GODoc</span></a> * <a class="link" href="GOStyledObject.html#go-styled-object-get-document" title="go_styled_object_get_document ()">go_styled_object_get_document</a> (<em class="parameter"><code><a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a> *gso</code></em>);
<a class="link" href="GOStyle.html" title="GOStyle"><span class="returnvalue">GOStyle</span></a> * <a class="link" href="GOStyledObject.html#go-styled-object-get-style" title="go_styled_object_get_style ()">go_styled_object_get_style</a> (<em class="parameter"><code><a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a> *gso</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GOStyledObject.html#go-styled-object-set-cairo-line" title="go_styled_object_set_cairo_line ()">go_styled_object_set_cairo_line</a> (<em class="parameter"><code><a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a> const *so</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"><span class="type">cairo_t</span></a> *cr</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GOStyledObject.html#go-styled-object-set-style" title="go_styled_object_set_style ()">go_styled_object_set_style</a> (<em class="parameter"><code><a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a> *gso</code></em>,
<em class="parameter"><code><a class="link" href="GOStyle.html" title="GOStyle"><span class="type">GOStyle</span></a> *style</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GOStyledObject.html#go-styled-object-style-changed" title="go_styled_object_style_changed ()">go_styled_object_style_changed</a> (<em class="parameter"><code><a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a> *gso</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GOStyledObject.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----GOStyledObject
</pre>
</div>
<div class="refsect1">
<a name="GOStyledObject.implementations"></a><h2>Known Implementations</h2>
<p>
GOStyledObject is implemented by
<a class="link" href="GocArc.html" title="GocArc">GocArc</a>, <a class="link" href="GocCircle.html" title="GocCircle">GocCircle</a>, <a class="link" href="GocEllipse.html" title="GocEllipse">GocEllipse</a>, <a class="link" href="GocLine.html" title="GocLine">GocLine</a>, GocPath, <a class="link" href="GocPolygon.html" title="GocPolygon">GocPolygon</a>, <a class="link" href="GocPolyline.html" title="GocPolyline">GocPolyline</a>, <a class="link" href="GocRectangle.html" title="GocRectangle">GocRectangle</a>, <a class="link" href="GocStyledItem.html" title="GocStyledItem">GocStyledItem</a>, <a class="link" href="GocText.html" title="GocText">GocText</a>, <a class="link" href="GogAxis.html" title="GogAxis">GogAxis</a>, <a class="link" href="GogAxisLine.html#GogAxisBase">GogAxisBase</a>, <a class="link" href="GogAxisLine.html" title="GogAxisLine">GogAxisLine</a>, <a class="link" href="GogChart.html" title="GogChart">GogChart</a>, <a class="link" href="GogColorScale.html" title="GogColorScale">GogColorScale</a>, <a class="link" href="GogSeriesLabels.html#GogDataLabel">GogDataLabel</a>, <a class="link" href="GogGraph.html" title="GogGraph">GogGraph</a>, <a class="link" href="GogGrid.html" title="GogGrid">GogGrid</a>, <a class="link" href="GogGridLine.html" title="GogGridLine">GogGridLine</a>, <a class="link" href="GogLabel.html" title="GogLabel">GogLabel</a>, <a class="link" href="GogLegend.html" title="GogLegend">GogLegend</a>, <a class="link" href="GogOutlinedView.html#GogOutlinedObject">GogOutlinedObject</a>, <a class="link" href="GogRegCurve.html" title="GogRegCurve">GogRegCurve</a>, <a class="link" href="GogRegEqn.html" title="GogRegEqn">GogRegEqn</a>, <a class="link" href="GogSeries.html" title="GogSeries">GogSeries</a>, <a class="link" href="GogSeries.html#GogSeriesElement">GogSeriesElement</a>, <a class="link" href="GogSeriesLabels.html" title="GogSeriesLabels">GogSeriesLabels</a>, <a class="link" href="GogSeriesLines.html" title="GogSeriesLines">GogSeriesLines</a>, <a class="link" href="GogSmoothedCurve.html" title="GogSmoothedCurve">GogSmoothedCurve</a>, <a class="link" href="GogStyledObject.html" title="GogStyledObject">GogStyledObject</a>, <a class="link" href="GogText.html" title="GogText">GogText</a> and <a class="link" href="GogTrendLine.html" title="GogTrendLine">GogTrendLine</a>.</p>
</div>
<div class="refsect1">
<a name="GOStyledObject.description"></a><h2>Description</h2>
<p>
The common GInterface for all objects owning a GOStyle.
</p>
</div>
<div class="refsect1">
<a name="GOStyledObject.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GOStyledObject-struct"></a><h3>GOStyledObject</h3>
<pre class="programlisting">typedef struct _GOStyledObject GOStyledObject;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GOStyledObjectClass"></a><h3>GOStyledObjectClass</h3>
<pre class="programlisting">typedef struct {
GTypeInterface base;
gboolean (*set_style) (GOStyledObject *gso, GOStyle *style);
GOStyle *(*get_style) (GOStyledObject *gso);
GOStyle *(*get_auto_style) (GOStyledObject *gso);
void (*style_changed) (GOStyledObject *gso);
void (*apply_theme) (GOStyledObject *gso, GOStyle *style);
GODoc *(*get_document) (GOStyledObject *gso);
} GOStyledObjectClass;
</pre>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GOStyledObjectClass.base"></a>base</code></em>;</span></p></td>
<td></td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GOStyledObjectClass.set-style"></a>set_style</code></em> ()</span></p></td>
<td>sets the object style.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GOStyledObjectClass.get-style"></a>get_style</code></em> ()</span></p></td>
<td>returns the object current style.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GOStyledObjectClass.get-auto-style"></a>get_auto_style</code></em> ()</span></p></td>
<td>returns the default style for the object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GOStyledObjectClass.style-changed"></a>style_changed</code></em> ()</span></p></td>
<td>called when the style changed.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GOStyledObjectClass.apply-theme"></a>apply_theme</code></em> ()</span></p></td>
<td>apply the current theme if any to the object style.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GOStyledObjectClass.get-document"></a>get_document</code></em> ()</span></p></td>
<td>returns the <a class="link" href="GODoc.html" title="GODoc"><span class="type">GODoc</span></a> associated to the object if any.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="go-styled-object-apply-theme"></a><h3>go_styled_object_apply_theme ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> go_styled_object_apply_theme (<em class="parameter"><code><a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a> *gso</code></em>,
<em class="parameter"><code><a class="link" href="GOStyle.html" title="GOStyle"><span class="type">GOStyle</span></a> *style</code></em>);</pre>
<p>
Apply appropriate theme <em class="parameter"><code>style</code></em> if meaningful, i.e. properties with
auto flag set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> should be changed to default theme value.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gso</code></em> :</span></p></td>
<td>a <a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>style</code></em> :</span></p></td>
<td>a <a class="link" href="GOStyle.html" title="GOStyle"><span class="type">GOStyle</span></a> that will be themed</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="go-styled-object-fill"></a><h3>go_styled_object_fill ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> go_styled_object_fill (<em class="parameter"><code><a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a> const *so</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"><span class="type">cairo_t</span></a> *cr</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> preserve</code></em>);</pre>
<p>
fills the current path according to the
item style and canvas scale.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>so</code></em> :</span></p></td>
<td><a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a></td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cr</code></em> :</span></p></td>
<td><a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"><span class="type">cairo_t</span></a></td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>preserve</code></em> :</span></p></td>
<td>whether the current path should be preserved</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="go-styled-object-get-auto-style"></a><h3>go_styled_object_get_auto_style ()</h3>
<pre class="programlisting"><a class="link" href="GOStyle.html" title="GOStyle"><span class="returnvalue">GOStyle</span></a> * go_styled_object_get_auto_style (<em class="parameter"><code><a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a> *gso</code></em>);</pre>
<p>
This function returns a new style that is initialized with the auto values for <em class="parameter"><code>gso</code></em>.
Caller is responsible for the result.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gso</code></em> :</span></p></td>
<td>a <a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GOStyle.html" title="GOStyle"><span class="type">GOStyle</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="go-styled-object-get-document"></a><h3>go_styled_object_get_document ()</h3>
<pre class="programlisting"><a class="link" href="GODoc.html" title="GODoc"><span class="returnvalue">GODoc</span></a> * go_styled_object_get_document (<em class="parameter"><code><a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a> *gso</code></em>);</pre>
<p>
A <a class="link" href="GODoc.html" title="GODoc"><span class="type">GODoc</span></a> is necessary to store images. If no GODoc is associated with the
object, image filling will not be supported.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gso</code></em> :</span></p></td>
<td>a <a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>he <a class="link" href="GODoc.html" title="GODoc"><span class="type">GODoc</span></a> associated with the object if any. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="go-styled-object-get-style"></a><h3>go_styled_object_get_style ()</h3>
<pre class="programlisting"><a class="link" href="GOStyle.html" title="GOStyle"><span class="returnvalue">GOStyle</span></a> * go_styled_object_get_style (<em class="parameter"><code><a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a> *gso</code></em>);</pre>
<p>
Simply an accessor function that returns <em class="parameter"><code>gso->style</code></em>, without referencing it.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gso</code></em> :</span></p></td>
<td>a <a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the styled object's <a class="link" href="GOStyle.html" title="GOStyle"><span class="type">GOStyle</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="go-styled-object-set-cairo-line"></a><h3>go_styled_object_set_cairo_line ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> go_styled_object_set_cairo_line (<em class="parameter"><code><a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a> const *so</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"><span class="type">cairo_t</span></a> *cr</code></em>);</pre>
<p>
Prepares the cairo context <em class="parameter"><code>cr</code></em> to draw a line according to the
item style and canvas scale.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>so</code></em> :</span></p></td>
<td><a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a></td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cr</code></em> :</span></p></td>
<td><a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"><span class="type">cairo_t</span></a></td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the line is not invisible</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="go-styled-object-set-style"></a><h3>go_styled_object_set_style ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> go_styled_object_set_style (<em class="parameter"><code><a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a> *gso</code></em>,
<em class="parameter"><code><a class="link" href="GOStyle.html" title="GOStyle"><span class="type">GOStyle</span></a> *style</code></em>);</pre>
<p>
Sets a new style for <em class="parameter"><code>gso</code></em>, and emits "style-changed" signal. This function
does not take ownership of <em class="parameter"><code>style</code></em>.
</p>
<p>
The best way to change the style is to set the "style" property.
</p>
<p>
This function will fail if the new style and the previous style are the same.
In that case, the function will always return false:
</p>
<div class="informalexample"><pre class="programlisting">
style = go_styled_object_get_style (gso);
style->line.width = 2;
size_changed = go_styled_object_set_style (gso, style);
</pre></div>
<p>
In this sample, the call to <a class="link" href="GOStyledObject.html#go-styled-object-set-style" title="go_styled_object_set_style ()"><code class="function">go_styled_object_set_style()</code></a> is just useless. You
need to check yourself if you really change the size, call
<a class="link" href="GOStyledObject.html#go-styled-object-style-changed" title="go_styled_object_style_changed ()"><code class="function">go_styled_object_style_changed()</code></a> to trigger the "style-changed" event.
So the following code is much better:
</p>
<div class="informalexample"><pre class="programlisting">
style = go_styled_object_get_style (gso);
if (style->line.width != 2.) {
style->line.width = 2;
go_styled_object_style_changed (gso);
size_changed = true;
} else
size_changed = FALSE;
</pre></div>
<p>
or even better:
</p>
<div class="informalexample"><pre class="programlisting">
style = go_style_dup (go_styled_object_get_style (gso));
style->line.width = 2;
size_changed = go_styled_object_set_style (gso, style);
g_object_unref (style);
</pre></div>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gso</code></em> :</span></p></td>
<td>a <a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>style</code></em> :</span></p></td>
<td>a <a class="link" href="GOStyle.html" title="GOStyle"><span class="type">GOStyle</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if new style may lead to change of object size, which
happens when changing font size for example.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="go-styled-object-style-changed"></a><h3>go_styled_object_style_changed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> go_styled_object_style_changed (<em class="parameter"><code><a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a> *gso</code></em>);</pre>
<p>
Called when the style changed. Might emit a signal if meaningful.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>gso</code></em> :</span></p></td>
<td>a <a class="link" href="GOStyledObject.html" title="GOStyledObject"><span class="type">GOStyledObject</span></a>
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|