<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) INRIA
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 * Copyright (C) 2021 - Samuel GOUGEON
 *
 * 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="ru" xml:id="getcolor">
    <refnamediv>
        <refname>getcolor</refname>
        <refpurpose>
            открывает диалог для показа цветов текущей цветовой карты или цветовой
            карты по умолчанию
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Синтаксис</title>
        <synopsis>
            c = getcolor()
            c = getcolor(title)
            c = getcolor(title, cini)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Аргументы</title>
        <variablelist>
            <varlistentry>
                <term>title</term>
                <listitem>
                    <para>строка, название диалога.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>cini</term>
                <listitem>
                    <para>
                        индекс исходного выбранного цвета. Значению по умолчанию 1.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>c</term>
                <listitem>
                    <para>
                        индекс выбранного цвета или <literal>[]</literal>, если
                        выбор отменён.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Описание</title>
        <para>
            <literal>getcolor</literal> открывает окно, отображающее палитру текущей
            цветовой карты, либо цветовой карты по умолчанию, если не существует
            графического окна. Пользователь может щёлкнуть по цвету чтобы показать
            его индекс и его RGB-значения на панели снизу.
            <literal>getcolor</literal> возвращает индекс выбранного цвета, либо
            <literal>[]</literal>, если выбор нажата кнопка "Отмена", либо окно
            было закрыто.
        </para>
    </refsection>
    <refsection>
        <title>Примеры</title>
        <programlisting role="example"><![CDATA[
c = getcolor();

c = getcolor("Title foo", color("red")); // предварительно выбран красный

c = getcolor("Пожалуйста, выберите цвет");
     ]]></programlisting>
        <para/>
        <inlinemediaobject>
            <imageobject>
                <imagedata fileref="../../images/getcolor.png"/>
            </imageobject>
        </inlinemediaobject>
        <para/>
        <screen><![CDATA[
--> c = getcolor("Please choose a color")
 c  =
   28.
]]></screen>
    </refsection>

    <refsection role="see also">
        <title>Смотрите также</title>
        <simplelist type="inline">
            <member>
                <link linkend="uigetcolor">uigetcolor</link>
            </member>
            <member>
                <link linkend="color_list">color_list</link>
            </member>
            <member>
                <link linkend="color">color</link>
            </member>
            <member>
                <link linkend="colormap">colormap</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
