<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) ENPC - Jean-Philippe Chancelier
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"  xml:lang="en" xml:id="xstringb">
    <refnamediv>
        <refname>xstringb</refname>
        <refpurpose>draw strings into a box</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>xstringb(x,y,str,w,h,[option])</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>x,y,w,h</term>
                <listitem>
                    <para>vector of 4 real scalars defining the box.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>str</term>
                <listitem>
                    <para>matrix of strings.</para>
                    <para>
                        Starting from Scilab 5.2, it is possible to write <link linkend="math_rendering_features_in_graphic">LaTeX or MathML expression</link>.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>option</term>
                <listitem>
                    <para>string.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            <literal>xstringb</literal> draws the matrix of strings <literal>str</literal> centered inside
            the rectangle <literal>rect=[x,y,w,h]</literal>
            (lower-left point, width, height) in user coordinates.
        </para>
        <para>
            If <literal>option</literal> is given with the value <literal>"fill"</literal>, the character size is
            computed so as to fill as much as possible in the rectangle.
        </para>
        <para>
            Enter the command <literal>xstringb()</literal> to see a demo.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
str=["Scilab" "is";"$\sqrt{not}$" "elisaB"];
plot2d(0,0,[-1,1],"010"," ",[0,0,1,1]);

r=[0,0,1,0.5];
xstringb(r(1),r(2),str,r(3),r(4),"fill");
xrect(r(1),r(2)+r(4),r(3),r(4));

r=[r(1),r(2)+r(4)+0.01,r(3),r(4)/2];
xrect(r(1),r(2)+r(4),r(3),r(4))
xstringb(r(1),r(2),str,r(3),r(4),"fill");
 ]]></programlisting>
        <scilab:image>
            str=["Scilab" "is";"$\sqrt{not}$" "elisaB"];
            plot2d(0,0,[-1,1],"010"," ",[0,0,1,1]);

            r=[0,0,1,0.5];
            xstringb(r(1),r(2),str,r(3),r(4),"fill");
            xrect(r(1),r(2)+r(4),r(3),r(4));

            r=[r(1),r(2)+r(4)+0.01,r(3),r(4)/2];
            xrect(r(1),r(2)+r(4),r(3),r(4))
            xstringb(r(1),r(2),str,r(3),r(4),"fill");
        </scilab:image>
    </refsection>
    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="titlepage">titlepage</link>
            </member>
            <member>
                <link linkend="xstring">xstring</link>
            </member>
            <member>
                <link linkend="xstringl">xstringl</link>
            </member>
            <member>
                <link linkend="xtitle">xtitle</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
