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

  <refnamediv>
    <refname>FLgroup</refname>
    <refpurpose>
      A FLTK container opcode that groups child widgets.
      <indexterm id="IndexFlgroup"><primary>FLgroup</primary></indexterm>
    </refpurpose>
  </refnamediv>
  
  <refsect1>
    <title>Description</title>
    <para>
      A FLTK container opcode that groups child widgets.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>FLgroup</command> &quot;label&quot;, iwidth, iheight, ix, iy [, iborder] [, image]</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <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>

    <para>
      <emphasis>iborder</emphasis> (optional, default=0) -- border type of the container. It is expressed by means of an integer number chosen from the following:

      <itemizedlist>
        <listitem><para>0 - no border</para></listitem>
        <listitem><para>1 - down box border</para></listitem>
        <listitem><para>2 - up box border</para></listitem>
        <listitem><para>3 - engraved border</para></listitem>
        <listitem><para>4 - embossed border</para></listitem>
        <listitem><para>5 - black line border</para></listitem>
        <listitem><para>6 - thin down border</para></listitem>
        <listitem><para>7 - thin up border</para></listitem>
      </itemizedlist>

      If the integer number doesn't match any of the previous values, no border is provided as the default.
    </para>

    <para>
      <emphasis>image</emphasis> (optional) -- a handle referring to an eventual image opened with the <emphasis>bmopen</emphasis> opcode. If it is set, it allows a skin for that widget.
    </para>

    <note>
      <title>Note about the bmopen opcode</title>
      <para>
        Although the documentation mentions the <emphasis>bmopen</emphasis> opcode, it has not been implemented in Csound 4.22.
      </para>
    </note>
  </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>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <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="flscroll"><citetitle>FLscroll</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>
  </refsect1>
</refentry>
