gtk3/docs/reference/gtk/html/GtkHScale.html
2021-04-15 09:52:10 +01:00

206 lines
11 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkHScale: 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="GtkStyle.html" title="GtkStyle">
<link rel="next" href="GtkVScale.html" title="GtkVScale">
<meta name="generator" content="GTK-Doc V1.33.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="#GtkHScale.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
<a href="#GtkHScale.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
<a href="#GtkHScale.implemented-interfaces" class="shortcut">Implemented Interfaces</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="GtkStyle.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkVScale.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkHScale"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkHScale.top_of_page"></a>GtkHScale</span></h2>
<p>GtkHScale — A horizontal slider widget for selecting a value from a range</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkHScale.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="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkHScale.html#gtk-hscale-new" title="gtk_hscale_new ()">gtk_hscale_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkHScale.html#gtk-hscale-new-with-range" title="gtk_hscale_new_with_range ()">gtk_hscale_new_with_range</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkHScale.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">struct</td>
<td class="function_name"><a class="link" href="GtkHScale.html#GtkHScale-struct" title="struct GtkHScale">GtkHScale</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkHScale.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
<span class="lineart">╰──</span> <a class="link" href="GtkRange.html" title="GtkRange">GtkRange</a>
<span class="lineart">╰──</span> <a class="link" href="GtkScale.html" title="GtkScale">GtkScale</a>
<span class="lineart">╰──</span> GtkHScale
</pre>
</div>
<div class="refsect1">
<a name="GtkHScale.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkHScale implements
AtkImplementorIface, <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a> and <a class="link" href="gtk3-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkHScale.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gtk/gtk.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GtkHScale.description"></a><h2>Description</h2>
<p>The <a class="link" href="GtkHScale.html" title="GtkHScale"><span class="type">GtkHScale</span></a> widget is used to allow the user to select a value using
a horizontal slider. To create one, use <a class="link" href="GtkHScale.html#gtk-hscale-new-with-range" title="gtk_hscale_new_with_range ()"><code class="function">gtk_hscale_new_with_range()</code></a>.</p>
<p>The position to show the current value, and the number of decimal places
shown can be set using the parent <a class="link" href="GtkScale.html" title="GtkScale"><span class="type">GtkScale</span></a> classs functions.</p>
<p>GtkHScale has been deprecated, use <a class="link" href="GtkScale.html" title="GtkScale"><span class="type">GtkScale</span></a> instead.</p>
</div>
<div class="refsect1">
<a name="GtkHScale.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-hscale-new"></a><h3>gtk_hscale_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
gtk_hscale_new (<em class="parameter"><code><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *adjustment</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_hscale_new</code> has been deprecated since version 3.2 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="GtkScale.html#gtk-scale-new" title="gtk_scale_new ()"><code class="function">gtk_scale_new()</code></a> with <a class="link" href="gtk3-Standard-Enumerations.html#GTK-ORIENTATION-HORIZONTAL:CAPS"><code class="literal">GTK_ORIENTATION_HORIZONTAL</code></a> instead</p>
</div>
<p>Creates a new <a class="link" href="GtkHScale.html" title="GtkHScale"><span class="type">GtkHScale</span></a>.</p>
<div class="refsect3">
<a name="gtk-hscale-new.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>adjustment</p></td>
<td class="parameter_description"><p>the <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> which sets the range of
the scale. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-hscale-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GtkHScale.html" title="GtkHScale"><span class="type">GtkHScale</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-hscale-new-with-range"></a><h3>gtk_hscale_new_with_range ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
gtk_hscale_new_with_range (<em class="parameter"><code><span class="type">gdouble</span> min</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> max</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> step</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_hscale_new_with_range</code> has been deprecated since version 3.2 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="GtkScale.html#gtk-scale-new-with-range" title="gtk_scale_new_with_range ()"><code class="function">gtk_scale_new_with_range()</code></a> with <a class="link" href="gtk3-Standard-Enumerations.html#GTK-ORIENTATION-HORIZONTAL:CAPS"><code class="literal">GTK_ORIENTATION_HORIZONTAL</code></a> instead</p>
</div>
<p>Creates a new horizontal scale widget that lets the user input a
number between <em class="parameter"><code>min</code></em>
and <em class="parameter"><code>max</code></em>
(including <em class="parameter"><code>min</code></em>
and <em class="parameter"><code>max</code></em>
) with the
increment <em class="parameter"><code>step</code></em>
. <em class="parameter"><code>step</code></em>
must be nonzero; its the distance the
slider moves when using the arrow keys to adjust the scale value.</p>
<p>Note that the way in which the precision is derived works best if <em class="parameter"><code>step</code></em>
is a power of ten. If the resulting precision is not suitable for your
needs, use <a class="link" href="GtkScale.html#gtk-scale-set-digits" title="gtk_scale_set_digits ()"><code class="function">gtk_scale_set_digits()</code></a> to correct it.</p>
<div class="refsect3">
<a name="gtk-hscale-new-with-range.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>min</p></td>
<td class="parameter_description"><p>minimum value</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>max</p></td>
<td class="parameter_description"><p>maximum value</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>step</p></td>
<td class="parameter_description"><p>step increment (tick size) used with keyboard shortcuts</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-hscale-new-with-range.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GtkHScale.html" title="GtkHScale"><span class="type">GtkHScale</span></a></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GtkHScale.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkHScale-struct"></a><h3>struct GtkHScale</h3>
<pre class="programlisting">struct GtkHScale;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>