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

  <refnamediv>
    <refname>FLscroll</refname>
    <refpurpose>
      A FLTK opcode that adds scroll bars to an area.
      <indexterm id="IndexFlscroll"><primary>FLscroll</primary></indexterm>
    </refpurpose>
  </refnamediv>
  
  <refsect1>
    <title>Description</title>
    <para>
      <emphasis>FLscroll</emphasis> adds scroll bars to an area.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>FLscroll</command> iwidth, iheight [, ix] [, iy]</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>iwidth</emphasis> -- width of widget.
    </para>

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

    <para>
      <emphasis>ix</emphasis> (optional) -- 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> (optional) -- 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>
      Containers are useful to format the graphic appearance of the widgets. The most important container is <link linkend="flpanel"><citetitle>FLpanel</citetitle></link>, that actually creates a window. It can be filled with other containers and/or valuators or other kinds of widgets.
    </para>

    <para>
      There are no k-rate arguments in containers.
    </para>

    <para>
      <emphasis>FLscroll</emphasis> adds scroll bars to an area. Normally you must set arguments <emphasis>iwidth</emphasis> and <emphasis>iheight</emphasis> equal to that of the parent window or other parent container. <emphasis>ix</emphasis> and <emphasis>iy</emphasis> are optional since they normally are set to zero. For example the following code:

      <informalexample>
        <programlisting>
        FLpanel   "PanelPluto",400,300,100,100
        FLscroll  400,300
gk1,ih1 FLslider  "FLslider 1", 500, 1000, 2 ,1, -1, 300,15, 20,50
gk2,ih2 FLslider  "FLslider 2", 300, 5000, 2 ,3, -1, 300,15, 20,100
gk3,ih3 FLslider  "FLslider 3", 350, 1000, 2 ,5, -1, 300,15, 20,150
gk4,ih4 FLslider  "FLslider 4", 250, 5000, 1 ,11,-1, 300,30, 20,200
        FLscrollEnd
        FLpanelEnd
        </programlisting>
      </informalexample>

      will show scroll bars, when the main window size is reduced:

      <mediaobject>
        <imageobject>
          <imagedata fileref="images/flscroll.png" format="PNG">
        </imageobject>

        <textobject>
          <phrase>FLscroll.</phrase>
        </textobject>

        <caption>
          <para>FLscroll.</para>
        </caption>
      </mediaobject>
    </para>
  </refsect1>

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

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

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

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

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="flgroup"><citetitle>FLgroup</citetitle></link>, 
      <link linkend="flgroupend"><citetitle>FLgroupEnd</citetitle></link>, 
      <link linkend="flpack"><citetitle>FLpack</citetitle></link>, 
      <link linkend="flpackend"><citetitle>FLpackEnd</citetitle></link>, 
      <link linkend="flpanel"><citetitle>FLpanel</citetitle></link>, 
      <link linkend="flpanelend"><citetitle>FLpanelEnd</citetitle></link>, 
      <link linkend="flscrollend"><citetitle>FLscrollEnd</citetitle></link>, 
      <link linkend="fltabs"><citetitle>FLtabs</citetitle></link>, 
      <link linkend="fltabsend"><citetitle>FLtabsEnd</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>
