<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
  <!ENTITY % gtkdocentities SYSTEM "../xml/gtkdocentities.ent">
  %gtkdocentities;
]>
<refentry id="atk-AtkRange">
<refmeta>
<refentrytitle role="top_of_page" id="atk-AtkRange.top_of_page">AtkRange</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>ATK Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>AtkRange</refname>
<refpurpose>A given range or subrange, to be used with <link linkend="AtkValue"><type>AtkValue</type></link></refpurpose>
</refnamediv>

<refsect1 id="atk-AtkRange.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_proto_type" colwidth="150px"/>
<colspec colname="functions_proto_name"/>
<tbody>
<row><entry role="function_type"><link linkend="AtkRange"><returnvalue>AtkRange</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="atk-range-copy">atk_range_copy</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="atk-range-free">atk_range_free</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gdouble"><returnvalue>gdouble</returnvalue></link>
</entry><entry role="function_name"><link linkend="atk-range-get-lower-limit">atk_range_get_lower_limit</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gdouble"><returnvalue>gdouble</returnvalue></link>
</entry><entry role="function_name"><link linkend="atk-range-get-upper-limit">atk_range_get_upper_limit</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="atk-range-get-description">atk_range_get_description</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="AtkRange"><returnvalue>AtkRange</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="atk-range-new">atk_range_new</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GType"><returnvalue>GType</returnvalue></link>
</entry><entry role="function_name"><link linkend="atk-range-get-type">atk_range_get_type</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="atk-AtkRange.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="other_proto_type" colwidth="150px"/>
<colspec colname="other_proto_name"/>
<tbody>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="ATK-TYPE-RANGE:CAPS">ATK_TYPE_RANGE</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>


<refsect1 id="atk-AtkRange.description" role="desc">
<title role="desc.title">Description</title>
<para><link linkend="AtkRange"><type>AtkRange</type></link> are used on <link linkend="AtkValue"><type>AtkValue</type></link>, in order to represent the full
range of a given component (for example an slider or a range
control), or to define each individual subrange this full range is
splitted if available. See <link linkend="AtkValue"><type>AtkValue</type></link> documentation for further
details.</para>

</refsect1>
<refsect1 id="atk-AtkRange.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="atk-range-copy" role="function" condition="since:2.12">
<title>atk_range_copy&#160;()</title>
<indexterm zone="atk-range-copy" role="2.12"><primary>atk_range_copy</primary></indexterm>
<programlisting language="C"><link linkend="AtkRange"><returnvalue>AtkRange</returnvalue></link>&#160;*
atk_range_copy (<parameter><link linkend="AtkRange"><type>AtkRange</type></link> *src</parameter>);</programlisting>
<para>Returns a new <link linkend="AtkRange"><type>AtkRange</type></link> that is a exact copy of <parameter>src</parameter>
</para>
<refsect3 id="atk-range-copy.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>src</para></entry>
<entry role="parameter_description"><para><link linkend="AtkRange"><type>AtkRange</type></link> to copy</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-range-copy.returns" role="returns">
<title>Returns</title>
<para>a new <link linkend="AtkRange"><type>AtkRange</type></link> copy of <parameter>src</parameter>
. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3><para role="since">Since: <link linkend="api-index-2.12">2.12</link></para></refsect2>
<refsect2 id="atk-range-free" role="function" condition="since:2.12">
<title>atk_range_free&#160;()</title>
<indexterm zone="atk-range-free" role="2.12"><primary>atk_range_free</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
atk_range_free (<parameter><link linkend="AtkRange"><type>AtkRange</type></link> *range</parameter>);</programlisting>
<para>Free <parameter>range</parameter>
</para>
<refsect3 id="atk-range-free.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>range</para></entry>
<entry role="parameter_description"><para><link linkend="AtkRange"><type>AtkRange</type></link> to free</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para role="since">Since: <link linkend="api-index-2.12">2.12</link></para></refsect2>
<refsect2 id="atk-range-get-lower-limit" role="function" condition="since:2.12">
<title>atk_range_get_lower_limit&#160;()</title>
<indexterm zone="atk-range-get-lower-limit" role="2.12"><primary>atk_range_get_lower_limit</primary></indexterm>
<programlisting language="C"><link linkend="gdouble"><returnvalue>gdouble</returnvalue></link>
atk_range_get_lower_limit (<parameter><link linkend="AtkRange"><type>AtkRange</type></link> *range</parameter>);</programlisting>
<para>Returns the lower limit of <parameter>range</parameter>
</para>
<refsect3 id="atk-range-get-lower-limit.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>range</para></entry>
<entry role="parameter_description"><para>an <link linkend="AtkRange"><type>AtkRange</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-range-get-lower-limit.returns" role="returns">
<title>Returns</title>
<para> the lower limit of <parameter>range</parameter>
</para>
</refsect3><para role="since">Since: <link linkend="api-index-2.12">2.12</link></para></refsect2>
<refsect2 id="atk-range-get-upper-limit" role="function" condition="since:2.12">
<title>atk_range_get_upper_limit&#160;()</title>
<indexterm zone="atk-range-get-upper-limit" role="2.12"><primary>atk_range_get_upper_limit</primary></indexterm>
<programlisting language="C"><link linkend="gdouble"><returnvalue>gdouble</returnvalue></link>
atk_range_get_upper_limit (<parameter><link linkend="AtkRange"><type>AtkRange</type></link> *range</parameter>);</programlisting>
<para>Returns the upper limit of <parameter>range</parameter>
</para>
<refsect3 id="atk-range-get-upper-limit.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>range</para></entry>
<entry role="parameter_description"><para>an <link linkend="AtkRange"><type>AtkRange</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-range-get-upper-limit.returns" role="returns">
<title>Returns</title>
<para> the upper limit of <parameter>range</parameter>
</para>
</refsect3><para role="since">Since: <link linkend="api-index-2.12">2.12</link></para></refsect2>
<refsect2 id="atk-range-get-description" role="function" condition="since:2.12">
<title>atk_range_get_description&#160;()</title>
<indexterm zone="atk-range-get-description" role="2.12"><primary>atk_range_get_description</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
atk_range_get_description (<parameter><link linkend="AtkRange"><type>AtkRange</type></link> *range</parameter>);</programlisting>
<para>Returns the human readable description of <parameter>range</parameter>
</para>
<refsect3 id="atk-range-get-description.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>range</para></entry>
<entry role="parameter_description"><para>an <link linkend="AtkRange"><type>AtkRange</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-range-get-description.returns" role="returns">
<title>Returns</title>
<para> the human-readable description of <parameter>range</parameter>
</para>
</refsect3><para role="since">Since: <link linkend="api-index-2.12">2.12</link></para></refsect2>
<refsect2 id="atk-range-new" role="function" condition="since:2.12">
<title>atk_range_new&#160;()</title>
<indexterm zone="atk-range-new" role="2.12"><primary>atk_range_new</primary></indexterm>
<programlisting language="C"><link linkend="AtkRange"><returnvalue>AtkRange</returnvalue></link>&#160;*
atk_range_new (<parameter><link linkend="gdouble"><type>gdouble</type></link> lower_limit</parameter>,
               <parameter><link linkend="gdouble"><type>gdouble</type></link> upper_limit</parameter>,
               <parameter>const <link linkend="gchar"><type>gchar</type></link> *description</parameter>);</programlisting>
<para>Creates a new <link linkend="AtkRange"><type>AtkRange</type></link>.</para>
<refsect3 id="atk-range-new.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>lower_limit</para></entry>
<entry role="parameter_description"><para>inferior limit for this range</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>upper_limit</para></entry>
<entry role="parameter_description"><para>superior limit for this range</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>description</para></entry>
<entry role="parameter_description"><para>human readable description of this range.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-range-new.returns" role="returns">
<title>Returns</title>
<para>a new <link linkend="AtkRange"><type>AtkRange</type></link>. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3><para role="since">Since: <link linkend="api-index-2.12">2.12</link></para></refsect2>
<refsect2 id="atk-range-get-type" role="function">
<title>atk_range_get_type&#160;()</title>
<indexterm zone="atk-range-get-type"><primary>atk_range_get_type</primary></indexterm>
<programlisting language="C"><link linkend="GType"><returnvalue>GType</returnvalue></link>
atk_range_get_type (<parameter><type>void</type></parameter>);</programlisting>
</refsect2>

</refsect1>
<refsect1 id="atk-AtkRange.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="ATK-TYPE-RANGE:CAPS" role="macro">
<title>ATK_TYPE_RANGE</title>
<indexterm zone="ATK-TYPE-RANGE:CAPS"><primary>ATK_TYPE_RANGE</primary></indexterm>
<programlisting language="C">#define ATK_TYPE_RANGE         (atk_range_get_type ())
</programlisting>
</refsect2>

</refsect1>

</refentry>
