<!-- Converted to DocBook/SGML by Kevin Conder -->
<refentry id="flvalue">
  <refmeta>
    <refentrytitle>FLvalue</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>FLvalue</refname>
    <refpurpose>
      Shows the current value of a FLTK valuator.
      <indexterm id="IndexFlvalue"><primary>FLvalue</primary></indexterm>
    </refpurpose>
  </refnamediv>
  
  <refsect1>
    <title>Description</title>
    <para>
      <emphasis>FLvalue</emphasis> shows current the value of a valuator in a text field.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis>ihandle <command>FLvalue</command> &quot;label&quot;, iwidth, iheight, ix, iy</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>ihandle</emphasis> -- handle value (an integer number) that unequivocally references the corresponding valuator. It can be used for the <emphasis>idisp</emphasis> argument of a valuator.
    </para>

    <para>
      <emphasis><quote>label</quote></emphasis> -- a double-quoted string containing some user-provided text, placed near the corresponding widget.
    </para>

    <para>
      <emphasis>iwidth</emphasis> -- width of widget.
    </para>

    <para>
      <emphasis>iheight</emphasis> -- height of widget.
    </para>

    <para>
      <emphasis>ix</emphasis> -- horizontal position of upper left corner of the valuator, relative to the upper left corner of corresponding window (expressed in pixels).
    </para>

    <para>
      <emphasis>iy</emphasis> -- vertical position of upper left corner of the valuator, relative to the upper
left corner of corresponding window (expressed in pixels).
    </para>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      Note that <emphasis>FLvalue</emphasis> is not a valuator and its value is fixed. Its value cannot be modified.
    </para>

    <para>
      <emphasis>FLvalue</emphasis> shows the current values of a valuator in a text field. It outputs <emphasis>ihandle</emphasis> that can then be used for the <emphasis>idisp</emphasis> argument of a valuator (see the <link linkend="ControlFltkValuators"><citetitle>FLTK Valuators section</citetitle></link>). In this way, the values of that valuator will be dynamically be shown in a text field.
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the flvalue opcode. It uses the files <ulink url="examples/flvalue.orc"><citetitle>flvalue.orc</citetitle></ulink> and <ulink url="examples/flvalue.sco"><citetitle>flvalue.sco</citetitle></ulink>.

      <example>
        <title>Example of the flvalue opcode.</title>

        <programlisting>
<inlinemediaobject>
            <imageobject>
              <imagedata fileref="examples/flvalue.orc" format="linespecific">
            </imageobject>
          </inlinemediaobject>
        </programlisting>

        <programlisting>
<inlinemediaobject>
            <imageobject>
              <imagedata fileref="examples/flvalue.sco" format="linespecific">
            </imageobject>
          </inlinemediaobject>
        </programlisting>
      </example>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="flbox"><citetitle>FLbox</citetitle></link>,
      <link linkend="flbutbank"><citetitle>FLbutBank</citetitle></link>,
      <link linkend="flbutton"><citetitle>FLbutton</citetitle></link>,
      <link linkend="flprintk"><citetitle>FLprintk</citetitle></link>,
      <link linkend="flprintk2"><citetitle>FLprintk2</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>Author: &namegabriel;</para>
    <para>New in version 4.22</para>
    <para>Example written by Iain McCurdy, edited by &namekevin;.</para>
  </refsect1>
</refentry>
