/usr/share/doc/mlpost/html/Mlpost.Command.html is in libmlpost-ocaml-doc 0.8.1-8build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="Start" href="index.html">
<link rel="previous" href="Mlpost.Picture.html">
<link rel="next" href="Mlpost.Shapes.html">
<link rel="Up" href="Mlpost.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of class attributes" rel=Appendix href="index_attributes.html">
<link title="Index of class methods" rel=Appendix href="index_methods.html">
<link title="Index of classes" rel=Appendix href="index_classes.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Mlpost" rel="Chapter" href="Mlpost.html">
<link title="Mlpost_dot" rel="Chapter" href="Mlpost_dot.html">
<link title="Mlpost_lablgtk" rel="Chapter" href="Mlpost_lablgtk.html"><link title="Drawing Commands" rel="Section" href="#2_DrawingCommands">
<link title="Manipulating Commands" rel="Section" href="#2_ManipulatingCommands">
<link title="Labels" rel="Section" href="#2_Labels">
<title>Mlpost.Command</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Mlpost.Picture.html" title="Mlpost.Picture">Previous</a>
<a class="up" href="Mlpost.html" title="Mlpost">Up</a>
<a class="post" href="Mlpost.Shapes.html" title="Mlpost.Shapes">Next</a>
</div>
<h1>Module <a href="type_Mlpost.Command.html">Mlpost.Command</a></h1>
<pre><span class="keyword">module</span> Command: <code class="code">sig</code> <a href="Mlpost.Command.html">..</a> <code class="code">end</code></pre><div class="info module top">
Basic drawing commands<br>
</div>
<hr width="100%">
<pre><span id="VALset_verbosity"><span class="keyword">val</span> set_verbosity</span> : <code class="type">bool -> unit</code></pre><div class="info ">
Set the verbosity of all mlpost<br>
</div>
<br>
General Commands to build figures<br>
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
<div class="info ">
The abstract commands type<br>
</div>
<br>
<h2 id="2_DrawingCommands">Drawing Commands</h2><br>
<pre><span id="VALdraw"><span class="keyword">val</span> draw</span> : <code class="type">?brush:<a href="Mlpost.Brush.html#TYPEt">Brush.t</a> -><br> ?color:<a href="Mlpost.Color.html#TYPEt">Color.t</a> -><br> ?pen:Pen.t -><br> ?dashed:Dash.t -> <a href="Mlpost.Path.html#TYPEt">Path.t</a> -> <a href="Mlpost.Command.html#TYPEt">t</a></code></pre><div class="info ">
Draw a path<br>
</div>
<div class="param_info"><code class="code">color</code> : the color of the path; default is black</div>
<div class="param_info"><code class="code">pen</code> : the pen used to draw the path; default is
<code class="code">Brush.Pen.default</code></div>
<div class="param_info"><code class="code">dashed</code> : if given, the path is drawn using that dash_style.</div>
<pre><span id="VALfill"><span class="keyword">val</span> fill</span> : <code class="type">?color:<a href="Mlpost.Color.html#TYPEt">Color.t</a> -> <a href="Mlpost.Path.html#TYPEt">Path.t</a> -> <a href="Mlpost.Command.html#TYPEt">t</a></code></pre><div class="info ">
Fill a contour given by a closed path<br>
</div>
<div class="param_info"><code class="code">color</code> : the color used to fill the area; default is black</div>
<pre><span id="VALdraw_pic"><span class="keyword">val</span> draw_pic</span> : <code class="type"><a href="Mlpost.Picture.html#TYPEt">Picture.t</a> -> <a href="Mlpost.Command.html#TYPEt">t</a></code></pre><div class="info ">
draws a picture<br>
</div>
<pre><span id="VALexternalimage"><span class="keyword">val</span> externalimage</span> : <code class="type">string -><br> [ `Exact of <a href="Mlpost.Num.html#TYPEt">Num.t</a> * <a href="Mlpost.Num.html#TYPEt">Num.t</a><br> | `Height of <a href="Mlpost.Num.html#TYPEt">Num.t</a><br> | `Inside of <a href="Mlpost.Num.html#TYPEt">Num.t</a> * <a href="Mlpost.Num.html#TYPEt">Num.t</a><br> | `None<br> | `Width of <a href="Mlpost.Num.html#TYPEt">Num.t</a> ] -> <a href="Mlpost.Command.html#TYPEt">t</a></code></pre><div class="info ">
insert an image given its filename - *EXPERIMENTAL*<br>
</div>
<br>
<h2 id="2_ManipulatingCommands">Manipulating Commands</h2><br>
<pre><span id="VALnop"><span class="keyword">val</span> nop</span> : <code class="type"><a href="Mlpost.Command.html#TYPEt">t</a></code></pre><div class="info ">
A command that has no effect<br>
</div>
<pre><span id="VALappend"><span class="keyword">val</span> append</span> : <code class="type"><a href="Mlpost.Command.html#TYPEt">t</a> -> <a href="Mlpost.Command.html#TYPEt">t</a> -> <a href="Mlpost.Command.html#TYPEt">t</a></code></pre><div class="info ">
Append two commands to form a compound command<br>
</div>
<pre><span id="VAL(++)"><span class="keyword">val</span> (++)</span> : <code class="type"><a href="Mlpost.Command.html#TYPEt">t</a> -> <a href="Mlpost.Command.html#TYPEt">t</a> -> <a href="Mlpost.Command.html#TYPEt">t</a></code></pre><div class="info ">
Abbreviation for <code class="code">append</code><br>
</div>
<pre><span id="VALseq"><span class="keyword">val</span> seq</span> : <code class="type"><a href="Mlpost.Command.html#TYPEt">t</a> list -> <a href="Mlpost.Command.html#TYPEt">t</a></code></pre><div class="info ">
Group a list of commands to a single command<br>
</div>
<pre><span id="VALiter"><span class="keyword">val</span> iter</span> : <code class="type">int -> int -> (int -> <a href="Mlpost.Command.html#TYPEt">t</a>) -> <a href="Mlpost.Command.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">iter m n f</code> builds a command that corresponds to the sequence
of commands <code class="code">f m; f (m+1); ... ; f(n)</code><br>
</div>
<pre><span id="VALiterl"><span class="keyword">val</span> iterl</span> : <code class="type">('a -> <a href="Mlpost.Command.html#TYPEt">t</a>) -> 'a list -> <a href="Mlpost.Command.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">iterl f l</code> builds a command that corresponds to the sequence
of commands <code class="code">f x1; f x2; ... ; f xn</code> for <code class="code">l = [x1;x2;...;xn]</code><br>
</div>
<br>
<h2 id="2_Labels">Labels</h2><br>
<pre><span id="TYPEhposition"><span class="keyword">type</span> <code class="type"></code>hposition</span> = <code class="type">[ `Center | `East | `Left | `Right | `West ]</code> </pre>
<pre><span id="TYPEvposition"><span class="keyword">type</span> <code class="type"></code>vposition</span> = <code class="type">[ `Bot | `Bottom | `Center | `North | `South | `Top ]</code> </pre>
<pre><span id="TYPEposition"><span class="keyword">type</span> <code class="type"></code>position</span> = <code class="type">[ `Bot<br> | `Bottom<br> | `Bottomleft<br> | `Bottomright<br> | `Center<br> | `East<br> | `Left<br> | `Lowerleft<br> | `Lowerright<br> | `Lowleft<br> | `Lowright<br> | `North<br> | `Northeast<br> | `Northwest<br> | `Right<br> | `South<br> | `Southeast<br> | `Southwest<br> | `Top<br> | `Topleft<br> | `Topright<br> | `Upleft<br> | `Upperleft<br> | `Upperright<br> | `Upright<br> | `West ]</code> </pre>
<div class="info ">
Positions - they are used at many places in Mlpost to indicate a
direction or position.<br>
</div>
<pre><span id="VALlabel"><span class="keyword">val</span> label</span> : <code class="type">?pos:<a href="Mlpost.Command.html#TYPEposition">position</a> -><br> <a href="Mlpost.Picture.html#TYPEt">Picture.t</a> -> <a href="Mlpost.Point.html#TYPEt">Point.t</a> -> <a href="Mlpost.Command.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">label ~pos:`West pic p</code> puts picture <code class="code">pic</code> at the left of the
point <code class="code">p</code><br>
</div>
<pre><span id="VALdotlabel"><span class="keyword">val</span> dotlabel</span> : <code class="type">?pos:<a href="Mlpost.Command.html#TYPEposition">position</a> -><br> <a href="Mlpost.Picture.html#TYPEt">Picture.t</a> -> <a href="Mlpost.Point.html#TYPEt">Point.t</a> -> <a href="Mlpost.Command.html#TYPEt">t</a></code></pre><div class="info ">
Works like <code class="code">label</code>, but puts a dot at point <code class="code">p</code> as well<br>
</div>
</body></html>
|