<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="class-atkvalue">

  <refnamediv>
    <refname>atk.Value</refname>
      <refpurpose>the ATK interface implemented by valuators and components
      which display or select a value from a bounded range of values.
      </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>atk.Value</classname></ooclass>
      <ooclass><classname>gobject.GInterface</classname></ooclass>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkvalue--get-current-value">get_current_value</link></methodname>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkvalue--get-maximum-value">get_maximum_value</link></methodname>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkvalue--get-minimum-value">get_minimum_value</link></methodname>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkvalue--set-current-value">set_current_value</link></methodname>
        <methodparam><parameter role="keyword">value</parameter></methodparam>
      </methodsynopsis>
</classsynopsis>

  </refsect1>

  <refsect1>
    <title>Description</title>

    <para><link
    linkend="class-atkvalue"><classname>atk.Value</classname></link> should
    be implemented for components which either display a value from a
    bounded range, or which allow the user to specify a value from a bounded
    range, or both.  For instance, most sliders and range controls, as well
    as dials, should have <link
    linkend="class-atkobject"><classname>atk.Object</classname></link>
    representations which implement <link
    linkend="class-atkvalue"><classname>atk.Value</classname></link> on the
    component's behalf.  <link
    linkend="class-atkvalue"><classname>atk.Value</classname></link> objects
    may be read-only, in which case attempts to alter the value return
    <literal>False</literal> to indicate failure.</para>

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-atkvalue--get-current-value">
      <title>atk.Value.get_current_value</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_current_value</methodname>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the current accessible
          value</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the value of this object.</para>

    </refsect2>

    <refsect2 id="method-atkvalue--get-maximum-value">
      <title>atk.Value.get_maximum_value</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_maximum_value</methodname>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the maximum accessible
          value</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the maximum value of this object.</para>

    </refsect2>

    <refsect2 id="method-atkvalue--get-minimum-value">
      <title>atk.Value.get_minimum_value</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_minimum_value</methodname>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara> the minimum accessible
          value</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the minimum value of this object.</para>

    </refsect2>

    <refsect2 id="method-atkvalue--set-current-value">
      <title>atk.Value.set_current_value</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_current_value</methodname>
        <methodparam><parameter role="keyword">value</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">value</parameter>&nbsp;:</term>
          <listitem><simpara>the desired new accessible
          value.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if new value is
          successfully set, <literal>False</literal>
          otherwise.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Sets the value of this object.</para>

    </refsect2>

  </refsect1>

</refentry>
