scilab/modules/graphics/help/en_US/style/getlinestyle.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
   4  * Copyright (C) INRIA
   5  *
   6  * This file must be used under the terms of the CeCILL.
   7  * This source file is licensed as described in the file COPYING, which
   8  * you should have received as part of this distribution.  The terms
   9  * are also available at
  10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  11  *
  12  -->
  13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"  xml:id="getlinestyle" xml:lang="en">
  14     <refnamediv>
  15         <refname>getlinestyle</refname>
  16         <refpurpose>
  17             dialog to select linestyle. <emphasis role="bold">Obsolete
  18                 function.
  19             </emphasis>
  20         </refpurpose>
  21     </refnamediv>
  22     <refsynopsisdiv>
  23         <title>Calling Sequence</title>
  24         <synopsis>k=getlinestyle()</synopsis>
  25     </refsynopsisdiv>
  26     <refsection>
  27         <title>Arguments</title>
  28         <variablelist>
  29             <varlistentry>
  30                 <term>k</term>
  31                 <listitem>
  32                     <para>integer, selected linestyle or [] if the "Cancel" button has
  33                         been clicked.
  34                     </para>
  35                 </listitem>
  36             </varlistentry>
  37         </variablelist>
  38     </refsection>
  39     <refsection>
  40         <title>Description</title>
  41         <para>
  42             This function designed to work with the <link linkend="xset">xset</link> function <emphasis role="bold">is also
  43                 obsolete
  44             </emphasis>
  45             .Use the property editor <link linkend="ged">ged</link> instead.
  46         </para>
  47         <para>
  48             <literal>getlinestyle</literal> opens a graphic window to select a
  49             line style.
  50         </para>
  51     </refsection>
  52     <refsection>
  53         <title>Examples</title>
  54         <programlisting role="example"><![CDATA[
  55 x=0:0.1:10;
  56 plot2d(x,sin(x))
  57 e=gce(); // store the Compound containing the plot
  58 e.children(1).line_style = getlinestyle();
  59  ]]></programlisting>
  60     </refsection>
  61     <refsection>
  62         <title>History</title>
  63         <revhistory>
  64             <revision>
  65                 <revnumber>5.4.1</revnumber>
  66                 <revdescription>Function tagged obsolete. Will be removed in 5.5
  67                     Please use <link linkend="ged">ged</link>.
  68                 </revdescription>
  69             </revision>
  70         </revhistory>
  71     </refsection>
  72     <refsection role="see also">
  73         <title>See Also</title>
  74         <simplelist type="inline">
  75             <member>
  76                 <link linkend="ged">ged</link>
  77             </member>
  78             <member>
  79                 <link linkend="set">set</link>
  80             </member>
  81             <member>
  82                 <link linkend="polyline_properties">segs_properties</link>
  83             </member>
  84             <member>
  85                 <link linkend="segs_properties">segs_properties</link>
  86             </member>
  87         </simplelist>
  88     </refsection>
  89 </refentry>