/usr/share/doc/libgtk-3-doc/gtk3/gtk3-GtkGradient.html is in libgtk-3-doc 3.4.2-0ubuntu0.9.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkGradient</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
<link rel="up" href="theming.html" title="Part III. Theming in GTK+">
<link rel="prev" href="gtk3-GtkSymbolicColor.html" title="GtkSymbolicColor">
<link rel="next" href="GtkIconTheme.html" title="GtkIconTheme">
<meta name="generator" content="GTK-Doc V1.18 (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="gtk3-GtkSymbolicColor.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="theming.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">GTK+ 3 Reference Manual</th>
<td><a accesskey="n" href="GtkIconTheme.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gtk3-GtkGradient.synopsis" class="shortcut">Top</a>
|
<a href="#gtk3-GtkGradient.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="gtk3-GtkGradient"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gtk3-GtkGradient.top_of_page"></a>GtkGradient</span></h2>
<p>GtkGradient — Gradients</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gtk3-GtkGradient.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <gtk/gtk.h>
<a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient">GtkGradient</a>;
<a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="returnvalue">GtkGradient</span></a> * <a class="link" href="gtk3-GtkGradient.html#gtk-gradient-new-linear" title="gtk_gradient_new_linear ()">gtk_gradient_new_linear</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x0</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> y0</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x1</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> y1</code></em>);
<a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="returnvalue">GtkGradient</span></a> * <a class="link" href="gtk3-GtkGradient.html#gtk-gradient-new-radial" title="gtk_gradient_new_radial ()">gtk_gradient_new_radial</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x0</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> y0</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> radius0</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x1</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> y1</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> radius1</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gtk3-GtkGradient.html#gtk-gradient-add-color-stop" title="gtk_gradient_add_color_stop ()">gtk_gradient_add_color_stop</a> (<em class="parameter"><code><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a> *gradient</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> offset</code></em>,
<em class="parameter"><code><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a> *color</code></em>);
<a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="returnvalue">GtkGradient</span></a> * <a class="link" href="gtk3-GtkGradient.html#gtk-gradient-ref" title="gtk_gradient_ref ()">gtk_gradient_ref</a> (<em class="parameter"><code><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a> *gradient</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gtk3-GtkGradient.html#gtk-gradient-unref" title="gtk_gradient_unref ()">gtk_gradient_unref</a> (<em class="parameter"><code><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a> *gradient</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="gtk3-GtkGradient.html#gtk-gradient-resolve" title="gtk_gradient_resolve ()">gtk_gradient_resolve</a> (<em class="parameter"><code><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a> *gradient</code></em>,
<em class="parameter"><code><a class="link" href="gtk3-GtkStyleProperties.html#GtkStyleProperties" title="struct GtkStyleProperties"><span class="type">GtkStyleProperties</span></a> *props</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-pattern-t.html#cairo-pattern-t"><span class="type">cairo_pattern_t</span></a> **resolved_gradient</code></em>);
<span class="returnvalue">char</span> * <a class="link" href="gtk3-GtkGradient.html#gtk-gradient-to-string" title="gtk_gradient_to_string ()">gtk_gradient_to_string</a> (<em class="parameter"><code><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a> *gradient</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="gtk3-GtkGradient.description"></a><h2>Description</h2>
<p>
GtkGradient is a boxed type that represents a gradient.
It is the result of parsing a
<a class="link" href="GtkCssProvider.html#gtkcssprovider-gradients" title="Gradients">gradient expression</a>.
To obtain the gradient represented by a GtkGradient, it has to
be resolved with <a class="link" href="gtk3-GtkGradient.html#gtk-gradient-resolve" title="gtk_gradient_resolve ()"><code class="function">gtk_gradient_resolve()</code></a>, which replaces all
symbolic color references by the colors they refer to (in a given
context) and constructs a <a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-pattern-t.html#cairo-pattern-t"><span class="type">cairo_pattern_t</span></a> value.
</p>
<p>
It is not normally necessary to deal directly with <a href="gtk3-GtkGradient.html#GtkGradient"><span class="type">GtkGradients</span></a>,
since they are mostly used behind the scenes by <a class="link" href="GtkStyleContext.html" title="GtkStyleContext"><span class="type">GtkStyleContext</span></a> and
<a class="link" href="GtkCssProvider.html" title="GtkCssProvider"><span class="type">GtkCssProvider</span></a>.
</p>
</div>
<div class="refsect1">
<a name="gtk3-GtkGradient.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GtkGradient"></a><h3>GtkGradient</h3>
<pre class="programlisting">typedef struct _GtkGradient GtkGradient;</pre>
</div>
<hr>
<div class="refsect2">
<a name="gtk-gradient-new-linear"></a><h3>gtk_gradient_new_linear ()</h3>
<pre class="programlisting"><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="returnvalue">GtkGradient</span></a> * gtk_gradient_new_linear (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x0</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> y0</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x1</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> y1</code></em>);</pre>
<p>
Creates a new linear gradient along the line defined by (x0, y0) and (x1, y1). Before using the gradient
a number of stop colors must be added through <a class="link" href="gtk3-GtkGradient.html#gtk-gradient-add-color-stop" title="gtk_gradient_add_color_stop ()"><code class="function">gtk_gradient_add_color_stop()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x0</code></em> :</span></p></td>
<td>X coordinate of the starting point</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y0</code></em> :</span></p></td>
<td>Y coordinate of the starting point</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x1</code></em> :</span></p></td>
<td>X coordinate of the end point</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y1</code></em> :</span></p></td>
<td>Y coordinate of the end point</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly created <a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-gradient-new-radial"></a><h3>gtk_gradient_new_radial ()</h3>
<pre class="programlisting"><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="returnvalue">GtkGradient</span></a> * gtk_gradient_new_radial (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x0</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> y0</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> radius0</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x1</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> y1</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> radius1</code></em>);</pre>
<p>
Creates a new radial gradient along the two circles defined by (x0, y0, radius0) and
(x1, y1, radius1). Before using the gradient a number of stop colors must be added
through <a class="link" href="gtk3-GtkGradient.html#gtk-gradient-add-color-stop" title="gtk_gradient_add_color_stop ()"><code class="function">gtk_gradient_add_color_stop()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x0</code></em> :</span></p></td>
<td>X coordinate of the start circle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y0</code></em> :</span></p></td>
<td>Y coordinate of the start circle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>radius0</code></em> :</span></p></td>
<td>radius of the start circle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x1</code></em> :</span></p></td>
<td>X coordinate of the end circle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y1</code></em> :</span></p></td>
<td>Y coordinate of the end circle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>radius1</code></em> :</span></p></td>
<td>radius of the end circle</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly created <a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-gradient-add-color-stop"></a><h3>gtk_gradient_add_color_stop ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gtk_gradient_add_color_stop (<em class="parameter"><code><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a> *gradient</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> offset</code></em>,
<em class="parameter"><code><a class="link" href="gtk3-GtkSymbolicColor.html#GtkSymbolicColor" title="GtkSymbolicColor"><span class="type">GtkSymbolicColor</span></a> *color</code></em>);</pre>
<p>
Adds a stop color to <em class="parameter"><code>gradient</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gradient</code></em> :</span></p></td>
<td>a <a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td>offset for the color stop</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
<td>color to use</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-gradient-ref"></a><h3>gtk_gradient_ref ()</h3>
<pre class="programlisting"><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="returnvalue">GtkGradient</span></a> * gtk_gradient_ref (<em class="parameter"><code><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a> *gradient</code></em>);</pre>
<p>
Increases the reference count of <em class="parameter"><code>gradient</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gradient</code></em> :</span></p></td>
<td>a <a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The same <em class="parameter"><code>gradient</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-gradient-unref"></a><h3>gtk_gradient_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gtk_gradient_unref (<em class="parameter"><code><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a> *gradient</code></em>);</pre>
<p>
Decreases the reference count of <em class="parameter"><code>gradient</code></em>, freeing its memory
if the reference count reaches 0.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>gradient</code></em> :</span></p></td>
<td>a <a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-gradient-resolve"></a><h3>gtk_gradient_resolve ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_gradient_resolve (<em class="parameter"><code><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a> *gradient</code></em>,
<em class="parameter"><code><a class="link" href="gtk3-GtkStyleProperties.html#GtkStyleProperties" title="struct GtkStyleProperties"><span class="type">GtkStyleProperties</span></a> *props</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-pattern-t.html#cairo-pattern-t"><span class="type">cairo_pattern_t</span></a> **resolved_gradient</code></em>);</pre>
<p>
If <em class="parameter"><code>gradient</code></em> is resolvable, <em class="parameter"><code>resolved_gradient</code></em> will be filled in
with the resolved gradient as a cairo_pattern_t, and <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> will
be returned. Generally, if <em class="parameter"><code>gradient</code></em> can't be resolved, it is
due to it being defined on top of a named color that doesn't
exist in <em class="parameter"><code>props</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gradient</code></em> :</span></p></td>
<td>a <a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>props</code></em> :</span></p></td>
<td>
<a class="link" href="gtk3-GtkStyleProperties.html#GtkStyleProperties" title="struct GtkStyleProperties"><span class="type">GtkStyleProperties</span></a> to use when resolving named colors</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>resolved_gradient</code></em> :</span></p></td>
<td>return location for the resolved pattern. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</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 gradient has been resolved</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-gradient-to-string"></a><h3>gtk_gradient_to_string ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * gtk_gradient_to_string (<em class="parameter"><code><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a> *gradient</code></em>);</pre>
<p>
Creates a string representation for <em class="parameter"><code>gradient</code></em> that is suitable
for using in GTK CSS files.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gradient</code></em> :</span></p></td>
<td>the gradient to print</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A string representation for <em class="parameter"><code>gradient</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|