* Bug 16638 fixed: getcolor() rendering debugged
[scilab.git] / scilab / modules / graphics / help / en_US / color_management / getcolor.xml
index baf60ca..023ab48 100644 (file)
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) INRIA
- * 
- * This file must be used under the terms of the CeCILL.
- * This source file is licensed as described in the file COPYING, which
- * you should have received as part of this distribution.  The terms
- * are also available at    
- * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+ * 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" version="5.0-subset Scilab" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="getcolor">
-  <info>
-    <pubdate>$LastChangedDate$</pubdate>
-  </info>
-  <refnamediv>
-    <refname>getcolor</refname>
-    <refpurpose> opens a dialog to show colors in the current colormap</refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <title>Calling Sequence</title>
-    <synopsis>c=getcolor(title,[cini])
-      c=getcolor()
-    </synopsis>
-  </refsynopsisdiv>
-  <refsection>
-    <title>Arguments</title>
-    <variablelist>
-      <varlistentry>
-        <term>title</term>
-        <listitem>
-          <para>string, dialog title.</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>cini</term>
-        <listitem>
-          <para>initial selected color id. Default value is 1.</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>c</term>
-        <listitem>
-          <para>selected color id or [] if the selection is cancelled.</para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
-  </refsection>
-  <refsection>
-    <title>Description</title>
-    <para>
-      <literal>getcolor</literal> opens a window displaying the palette of the current colormap. 
-      The user can click on a color to show its id and RGB values.
-      <literal>getcolor</literal> returns the id of the selected color or [] if the "Cancel" button has been clicked or the window closed.
-    </para>
-  </refsection>
-  <refsection role="see also">
-    <title>See Also</title>
-    <simplelist type="inline">
-      <member>
-        <link linkend="color">color</link>
-      </member>
-      <member>
-        <link linkend="colormap">colormap</link>
-      </member>
-      <member>
-        <link linkend="getmark">getmark</link>
-      </member>
-      <member>
-        <link linkend="getfont">getfont</link>
-      </member>
-    </simplelist>
-  </refsection>
+<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="getcolor">
+    <refnamediv>
+        <refname>getcolor</refname>
+        <refpurpose>opens a dialog to show colors of the current or default colormap</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Syntax</title>
+        <synopsis>
+            c = getcolor()
+            c = getcolor(title)
+            c = getcolor(title, cini)
+        </synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Arguments</title>
+        <variablelist>
+            <varlistentry>
+                <term>title</term>
+                <listitem>
+                    <para>string, dialog title.</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>cini</term>
+                <listitem>
+                    <para>initial selected color index. Default value is 1.</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>c</term>
+                <listitem>
+                    <para>index of the selected color, or [] if the selection is canceled.</para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
+        <title>Description</title>
+        <para>
+            <literal>getcolor</literal> opens a window displaying the palette of the current
+            colormap, or of the default one if no graphical figure exists.
+            The user can click on a color to show its index and its RGB values
+            in the bottom bar.
+            <literal>getcolor</literal> returns the index of the selected color, or [] if the "Cancel"
+            button has been clicked or the window has been closed.
+        </para>
+    </refsection>
+    <refsection>
+        <title>Examples</title>
+        <programlisting role="example"><![CDATA[
+c = getcolor();
+
+c = getcolor("Title foo", color("red")); // preselects the red
+
+c = getcolor("Please choose a color");
+     ]]></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>See also</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>