scilab/modules/graphics/help/en_US/style/getmark.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="getmark" xml:lang="en">
  14     <refnamediv>
  15         <refname>getmark</refname>
  16         <refpurpose>
  17             dialog to select mark (symbol). <emphasis role="bold">Obsolete
  18                 function
  19             </emphasis>
  20         </refpurpose>
  21     </refnamediv>
  22     <refsynopsisdiv>
  23         <title>Calling Sequence</title>
  24         <synopsis>[mark,mrkSize]=getmark()</synopsis>
  25     </refsynopsisdiv>
  26     <refsection>
  27         <title>Arguments</title>
  28         <variablelist>
  29             <varlistentry>
  30                 <term>mark</term>
  31                 <listitem>
  32                     <para>integer, the number of the selected mark</para>
  33                 </listitem>
  34             </varlistentry>
  35             <varlistentry>
  36                 <term>mrkSize</term>
  37                 <listitem>
  38                     <para>integer, the size of the selected mark</para>
  39                 </listitem>
  40             </varlistentry>
  41         </variablelist>
  42     </refsection>
  43     <refsection>
  44         <title>Description</title>
  45         <para>
  46             This function designed to work with the <link linkend="xset">xset</link> function <emphasis role="bold">is also obsolete </emphasis>.
  47             Use the property editor <link linkend="ged">ged</link> instead.
  48         </para>
  49         <para>
  50             <literal>getmark</literal> opens a graphic window to select a mark
  51             (symbol).
  52         </para>
  53     </refsection>
  54     <refsection>
  55         <title>Examples</title>
  56         <programlisting role="example"><![CDATA[
  57 x=0:0.1:10;
  58 [mark,mrkSize]=getmark();
  59 plot2d(x,sin(x),style=-mark);
  60 clf();
  61 plot2d(x,sin(x))
  62 e=gce(); // store the Compound containing the plot
  63 [mark,mrkSize]=getmark();
  64 e.children(1).mark_style = mark;
  65  ]]></programlisting>
  66     </refsection>
  67     <refsection>
  68         <title>History</title>
  69         <revhistory>
  70             <revision>
  71                 <revnumber>5.4.1</revnumber>
  72                 <revdescription>
  73                     Function tagged obsolete. Will be removed in 5.5.0. Please use <link linkend="ged">ged</link> instead.
  74                 </revdescription>
  75             </revision>
  76         </revhistory>
  77     </refsection>
  78     <refsection role="see also">
  79         <title>See Also</title>
  80         <simplelist type="inline">
  81             <member>
  82                 <link linkend="ged">ged</link>
  83             </member>
  84             <member>
  85                 <link linkend="set">set</link>
  86             </member>
  87             <member>
  88                 <link linkend="polyline_properties">segs_properties</link>
  89             </member>
  90             <member>
  91                 <link linkend="segs_properties">segs_properties</link>
  92             </member>
  93         </simplelist>
  94     </refsection>
  95 </refentry>