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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
(* Js_of_ocaml library
* http://www.ocsigen.org/js_of_ocaml/
* Copyright (C) 2010 Raphaël Proust
* Laboratoire PPS - CNRS Université Paris Diderot
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, with linking exception;
* either version 2.1 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*)
(**This module contains a few types and values to ease the use of CSS properties
and such. If you think a feature is missing, consider sending a patch or an
RFE to the mailing list.
This module contain submodules each with a signature similar to:
type t (*type the module is focused on*)
type js_t (*valid js representation of values of type t*)
val js: t -> js_t (*conversion*)
val ml: js_t -> t (*conversion*)
Additional functions (string conversion, standard operation, etc.) are
sometime available. Some module have several different types instead of just
one.
*)
module Color : sig
(**All about CSS colors. MDC documentation here:
https://developer.mozilla.org/en/CSS/color_value . Specifications here:
http://www.w3.org/TR/css3-color/#svg-color .*)
(**The colors by name.*)
type name =
| Aliceblue | Antiquewhite | Aqua | Aquamarine | Azure
| Beige | Bisque | Black | Blanchedalmond | Blue | Blueviolet | Brown
| Burlywood
| Cadetblue | Chartreuse | Chocolate | Coral | Cornflowerblue | Cornsilk
| Crimson | Cyan
| Darkblue | Darkcyan | Darkgoldenrod | Darkgray | Darkgreen | Darkgrey
| Darkkhaki | Darkmagenta | Darkolivegreen | Darkorange | Darkorchid | Darkred
| Darksalmon | Darkseagreen | Darkslateblue | Darkslategray | Darkslategrey
| Darkturquoise | Darkviolet | Deeppink | Deepskyblue | Dimgray | Dimgrey
| Dodgerblue
| Firebrick | Floralwhite | Forestgreen | Fuchsia
| Gainsboro | Ghostwhite | Gold | Goldenrod | Gray | Grey | Green
| Greenyellow
| Honeydew | Hotpink
| Indianred | Indigo | Ivory
| Khaki
| Lavender | Lavenderblush | Lawngreen | Lemonchiffon | Lightblue | Lightcoral
| Lightcyan | Lightgoldenrodyellow | Lightgray | Lightgreen | Lightgrey
| Lightpink | Lightsalmon | Lightseagreen | Lightskyblue | Lightslategray
| Lightslategrey | Lightsteelblue | Lightyellow | Lime | Limegreen | Linen
| Magenta | Maroon | Mediumaquamarine | Mediumblue | Mediumorchid
| Mediumpurple | Mediumseagreen | Mediumslateblue | Mediumspringgreen
| Mediumturquoise | Mediumvioletred | Midnightblue | Mintcream | Mistyrose
| Moccasin
| Navajowhite | Navy
| Oldlace | Olive | Olivedrab | Orange | Orangered | Orchid
| Palegoldenrod | Palegreen | Paleturquoise | Palevioletred | Papayawhip
| Peachpuff | Peru | Pink | Plum | Powderblue | Purple
| Red | Rosybrown | Royalblue
| Saddlebrown | Salmon | Sandybrown | Seagreen | Seashell | Sienna | Silver
| Skyblue | Slateblue | Slategray | Slategrey | Snow | Springgreen | Steelblue
| Tan | Teal | Thistle | Tomato | Turquoise
| Violet
| Wheat | White | Whitesmoke
| Yellow | Yellowgreen
(**Gives the string equivalent of the argument.*)
val string_of_name : name -> string
(**Converts a color name into three integers representing the Red, Green and
Blue channels. Channel values are in between [0] and [255].*)
val rgb_of_name : name -> (int * int * int)
(**The type of colors, either by name, by Red-Green-Blue constructor or by
Hue-Saturation-Lightness constructors.*)
type t =
| Name of name
(**A color by name*)
| RGB of (int * int * int)
(**Red, Green and Blue values. Clipped to [0..255] by most (All?)
browsers.*)
| RGB_percent of (int * int * int)
(**RBG channels are specified as a percentage of their maximal value.*)
| RGBA of (int * int * int * float)
(**Same as RGB with additionnal transparency argument. Opacity should be
between [0.] (completely transparent) and [1.] (completely opaque).*)
| RGBA_percent of (int * int * int * float)
(**RGB channels specified as percentage of their maximal value. Alpha
channel (opacity) is still a [0.] to [1.] float.*)
| HSL of (int * int * int)
(**Hue, Saturation and Lightness values. Hue is an angle in degree (in
interval [0..360]). Saturation is a percentage ([0..100]) with [0]
being colorless. Lightness is also a percentage ([0..100]) with [0]
being black.*)
| HSLA of (int * int * int * float)
(**Same as HSL with an opacity argument between [0.] and [1.].*)
(**build a color from the values of red, green, and blue channels. optional [a]
argument can be used to specify alpha channel (aka opacity).*)
val rgb : ?a:float -> int -> int -> int -> t
(**build a color from the values of hue, saturation, and lightness channels.
optional [a] argument can be used to specify alpha channel (aka opacity).*)
val hsl : ?a:float -> int -> int -> int -> t
(**A [js_t] is a valid string representation of a CSS color*)
type js_t = private Js.js_string Js.t
(**A few conversion functions*)
(**Convert to a string representation (for debugging purpose mainly).*)
val string_of_t: t -> string
(**Projection from OCaml to Js. [js c] is equivalent
to [Js.string (string_of_t c)] but with a [js_t] return type.*)
val js : t -> js_t
(**Projection from Js to OCaml. The function is the dual of [js].*)
val ml: js_t -> t
(**Checks the well-formedness of a string or fails with [Invalid_argument]*)
val js_t_of_js_string : Js.js_string Js.t -> js_t
end
module Length : sig
(**The type of length attributes. Mdc documentation:
https://developer.mozilla.org/en/CSS/length and specification:
http://www.w3.org/TR/css3-values/#lengths
*)
type t =
| Zero (**For 0, unit is optional*)
| Em of float (**Relative to the font size *)
| Ex of float (**Relative to the x-height *)
| Px of float (**Relative to the viewing device *)
| Gd of float (**Relative to the grid *)
| Rem of float (**Relative to the font size of the root *)
| Vw of float (**Relative to the viewport's width *)
| Vh of float (**Relative to the viewport's height *)
| Vm of float (**Relative to the smallest of the viewport's width or height *)
| Ch of float (**Relative to the width of a char '0' *)
| Mm of float (** in Milimeter *)
| Cm of float (** in Centimeter *)
| In of float (** in Inch *)
| Pt of float (** in Points (72pt = 1in)*)
| Pc of float (** in Picas (1pc = 12pt)*)
(** Js representation of lengths. *)
type js_t = private Js.js_string Js.t
(**Conversion functions*)
val string_of_t: t -> string
val js: t -> js_t
val ml: js_t -> t
end
module Angle : sig
type t =
| Deg of float
| Grad of float
| Rad of float
| Turns of float
type js_t = private Js.js_string Js.t
val string_of_t: t -> string
val js: t -> js_t
val ml: js_t -> t
end
|
