<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2008 - INRIA - Vincent COUVERT
 *
 * 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="ged">
    <refnamediv>
        <refname>ged</refname>
        <refpurpose>Scilab Graphic Editor</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>ged(action, fignum)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>action</term>
                <listitem>
                    <para>
                        Real: action to be executed on graphic window given by <literal>fignum</literal>:
                    </para>
                    <itemizedlist>
                        <listitem>
                            <para>
                                1: Select window <literal>fignum</literal> as current figure.
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                2: Redraw window <literal>fignum</literal>.
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                3: Clear window <literal>fignum</literal>.
                            </para>
                        </listitem>
                        <listitem>
                            <para>4: Ask the user to select a graphic entity to copy.</para>
                        </listitem>
                        <listitem>
                            <para>
                                5: Paste last graphic entity copied using action <literal>4</literal>.
                            </para>
                        </listitem>
                        <listitem>
                            <para>6: Ask the user to select a graphic entity and then move it.</para>
                        </listitem>
                        <listitem>
                            <para>7: Ask the user to select the graphic entity to delete.</para>
                        </listitem>
                        <listitem>
                            <para>8: Start a GUI to edit window properties.</para>
                        </listitem>
                        <listitem>
                            <para>9: Start a GUI to edit current axes properties.</para>
                        </listitem>
                        <listitem>
                            <para>10: Start an entity picker to select a graphic object and edit it using Graphic Editor GUI.</para>
                        </listitem>
                        <listitem>
                            <para>11: Stop the entity picker.</para>
                        </listitem>
                    </itemizedlist>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>fignum</term>
                <listitem>
                    <para>Real: Graphic window number, the figure to edit.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            The Scilab Graphic Editor is the underlying Scilab function for the graphic <link linkend="object_editor">object editor</link>, the visual tool available from the graphics windows Edit menu. <code>ged()</code> is of limited use by itself (most the functionalities are available from other functions), and is only present to ensure that all Object Editor functionalities are also available in the Scilab language.
        </para>
        <para>
            <code>ged()</code> starts Scilab Graphic Editor on figure number <varname>fignum</varname> and execute action given by <varname>action</varname>.
        </para>
        <para>
            Note that, the Scilab Graphic Editor is implemented using the Tcl/Tk language; it is not available on MacOS, where Tcl/TK is not available.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
// Moving a curve
scf(0);
plot2d();
ged(6,0) // Then click on a curve and try moving it
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="object_editor">object editor</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
