472 lines
24 KiB
HTML
472 lines
24 KiB
HTML
<!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: GTK+ 3 Reference Manual</title>
|
||
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
|
||
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
|
||
<link rel="up" href="DeprecatedObjects.html" title="Deprecated">
|
||
<link rel="prev" href="gtk3-GtkSymbolicColor.html" title="GtkSymbolicColor">
|
||
<link rel="next" href="gtk3-Resource-Files.html" title="Resource Files">
|
||
<meta name="generator" content="GTK-Doc V1.32.1 (XML mode)">
|
||
<link rel="stylesheet" href="style.css" type="text/css">
|
||
</head>
|
||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
|
||
<td width="100%" align="left" class="shortcuts">
|
||
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
|
||
<a href="#gtk3-GtkGradient.description" class="shortcut">Description</a></span>
|
||
</td>
|
||
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
|
||
<td><a accesskey="u" href="DeprecatedObjects.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
|
||
<td><a accesskey="p" href="gtk3-GtkSymbolicColor.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||
<td><a accesskey="n" href="gtk3-Resource-Files.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></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 class="gallery_image" valign="top" align="right"></td>
|
||
</tr></table></div>
|
||
<div class="refsect1">
|
||
<a name="gtk3-GtkGradient.functions"></a><h2>Functions</h2>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="functions_proto_type">
|
||
<col class="functions_proto_name">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="returnvalue">GtkGradient</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="gtk3-GtkGradient.html#gtk-gradient-new-linear" title="gtk_gradient_new_linear ()">gtk_gradient_new_linear</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="returnvalue">GtkGradient</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="gtk3-GtkGradient.html#gtk-gradient-new-radial" title="gtk_gradient_new_radial ()">gtk_gradient_new_radial</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="gtk3-GtkGradient.html#gtk-gradient-add-color-stop" title="gtk_gradient_add_color_stop ()">gtk_gradient_add_color_stop</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="returnvalue">GtkGradient</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="gtk3-GtkGradient.html#gtk-gradient-ref" title="gtk_gradient_ref ()">gtk_gradient_ref</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="gtk3-GtkGradient.html#gtk-gradient-unref" title="gtk_gradient_unref ()">gtk_gradient_unref</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="gtk3-GtkGradient.html#gtk-gradient-resolve" title="gtk_gradient_resolve ()">gtk_gradient_resolve</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-pattern-t.html#cairo-pattern-t"><span class="returnvalue">cairo_pattern_t</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="gtk3-GtkGradient.html#gtk-gradient-resolve-for-context" title="gtk_gradient_resolve_for_context ()">gtk_gradient_resolve_for_context</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">char</span> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="gtk3-GtkGradient.html#gtk-gradient-to-string" title="gtk_gradient_to_string ()">gtk_gradient_to_string</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="gtk3-GtkGradient.other"></a><h2>Types and Values</h2>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="other_proto_type">
|
||
<col class="other_proto_name">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="datatype_keyword"> </td>
|
||
<td class="function_name"><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient">GtkGradient</a></td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="gtk3-GtkGradient.includes"></a><h2>Includes</h2>
|
||
<pre class="synopsis">#include <gtk/gtk.h>
|
||
</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
|
||
gradient expression.
|
||
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>
|
||
<p><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a> is deprecated. It was used internally by GTK’s CSS engine
|
||
to represent gradients. As its handling is not conforming to modern
|
||
web standards, it is not used anymore. If you want to use gradients in
|
||
your own code, please use Cairo directly.</p>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="gtk3-GtkGradient.functions_details"></a><h2>Functions</h2>
|
||
<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><span class="type">gdouble</span> x0</code></em>,
|
||
<em class="parameter"><code><span class="type">gdouble</span> y0</code></em>,
|
||
<em class="parameter"><code><span class="type">gdouble</span> x1</code></em>,
|
||
<em class="parameter"><code><span class="type">gdouble</span> y1</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_gradient_new_linear</code> has been deprecated since version 3.8 and should not be used in newly-written code.</p>
|
||
<p><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a> is deprecated.</p>
|
||
</div>
|
||
<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="refsect3">
|
||
<a name="gtk-gradient-new-linear.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>x0</p></td>
|
||
<td class="parameter_description"><p>X coordinate of the starting point</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>y0</p></td>
|
||
<td class="parameter_description"><p>Y coordinate of the starting point</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>x1</p></td>
|
||
<td class="parameter_description"><p>X coordinate of the end point</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>y1</p></td>
|
||
<td class="parameter_description"><p>Y coordinate of the end point</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-gradient-new-linear.returns"></a><h4>Returns</h4>
|
||
<p> A newly created <a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a></p>
|
||
</div>
|
||
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></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><span class="type">gdouble</span> x0</code></em>,
|
||
<em class="parameter"><code><span class="type">gdouble</span> y0</code></em>,
|
||
<em class="parameter"><code><span class="type">gdouble</span> radius0</code></em>,
|
||
<em class="parameter"><code><span class="type">gdouble</span> x1</code></em>,
|
||
<em class="parameter"><code><span class="type">gdouble</span> y1</code></em>,
|
||
<em class="parameter"><code><span class="type">gdouble</span> radius1</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_gradient_new_radial</code> has been deprecated since version 3.8 and should not be used in newly-written code.</p>
|
||
<p><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a> is deprecated.</p>
|
||
</div>
|
||
<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="refsect3">
|
||
<a name="gtk-gradient-new-radial.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>x0</p></td>
|
||
<td class="parameter_description"><p>X coordinate of the start circle</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>y0</p></td>
|
||
<td class="parameter_description"><p>Y coordinate of the start circle</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>radius0</p></td>
|
||
<td class="parameter_description"><p>radius of the start circle</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>x1</p></td>
|
||
<td class="parameter_description"><p>X coordinate of the end circle</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>y1</p></td>
|
||
<td class="parameter_description"><p>Y coordinate of the end circle</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>radius1</p></td>
|
||
<td class="parameter_description"><p>radius of the end circle</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-gradient-new-radial.returns"></a><h4>Returns</h4>
|
||
<p> A newly created <a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a></p>
|
||
</div>
|
||
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></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><span class="type">gdouble</span> 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>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_gradient_add_color_stop</code> has been deprecated since version 3.8 and should not be used in newly-written code.</p>
|
||
<p><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a> is deprecated.</p>
|
||
</div>
|
||
<p>Adds a stop color to <em class="parameter"><code>gradient</code></em>
|
||
.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-gradient-add-color-stop.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>gradient</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>offset</p></td>
|
||
<td class="parameter_description"><p>offset for the color stop</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>color</p></td>
|
||
<td class="parameter_description"><p>color to use</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></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>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_gradient_ref</code> has been deprecated since version 3.8 and should not be used in newly-written code.</p>
|
||
<p><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a> is deprecated.</p>
|
||
</div>
|
||
<p>Increases the reference count of <em class="parameter"><code>gradient</code></em>
|
||
.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-gradient-ref.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>gradient</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-gradient-ref.returns"></a><h4>Returns</h4>
|
||
<p> The same <em class="parameter"><code>gradient</code></em>
|
||
</p>
|
||
</div>
|
||
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></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>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_gradient_unref</code> has been deprecated since version 3.8 and should not be used in newly-written code.</p>
|
||
<p><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a> is deprecated.</p>
|
||
</div>
|
||
<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="refsect3">
|
||
<a name="gtk-gradient-unref.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>gradient</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-gradient-resolve"></a><h3>gtk_gradient_resolve ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
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>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_gradient_resolve</code> has been deprecated since version 3.8 and should not be used in newly-written code.</p>
|
||
<p><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a> is deprecated.</p>
|
||
</div>
|
||
<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 <code class="literal">TRUE</code> 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="refsect3">
|
||
<a name="gtk-gradient-resolve.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>gradient</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>props</p></td>
|
||
<td class="parameter_description"><p><a class="link" href="gtk3-GtkStyleProperties.html#GtkStyleProperties" title="struct GtkStyleProperties"><span class="type">GtkStyleProperties</span></a> to use when resolving named colors</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>resolved_gradient</p></td>
|
||
<td class="parameter_description"><p>return location for the resolved pattern. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-gradient-resolve.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code> if the gradient has been resolved</p>
|
||
</div>
|
||
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-gradient-resolve-for-context"></a><h3>gtk_gradient_resolve_for_context ()</h3>
|
||
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-pattern-t.html#cairo-pattern-t"><span class="returnvalue">cairo_pattern_t</span></a> *
|
||
gtk_gradient_resolve_for_context (<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="GtkStyleContext.html" title="GtkStyleContext"><span class="type">GtkStyleContext</span></a> *context</code></em>);</pre>
|
||
<div class="warning"><p><code class="literal">gtk_gradient_resolve_for_context</code> is deprecated and should not be used in newly-written code.</p></div>
|
||
</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>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_gradient_to_string</code> has been deprecated since version 3.8 and should not be used in newly-written code.</p>
|
||
<p><a class="link" href="gtk3-GtkGradient.html#GtkGradient" title="GtkGradient"><span class="type">GtkGradient</span></a> is deprecated.</p>
|
||
</div>
|
||
<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="refsect3">
|
||
<a name="gtk-gradient-to-string.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>gradient</p></td>
|
||
<td class="parameter_description"><p>the gradient to print</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-gradient-to-string.returns"></a><h4>Returns</h4>
|
||
<p> A string representation for <em class="parameter"><code>gradient</code></em>
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="gtk3-GtkGradient.other_details"></a><h2>Types and Values</h2>
|
||
<div class="refsect2">
|
||
<a name="GtkGradient"></a><h3>GtkGradient</h3>
|
||
<pre class="programlisting">typedef struct _GtkGradient GtkGradient;</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="footer">
|
||
<hr>Generated by GTK-Doc V1.32.1</div>
|
||
</body>
|
||
</html> |