doc/parts/bindings/simple.sxml

   1 <!-- This file is part of Shapes.                                           -->
   2 <!--                                                                        -->
   3 <!-- Shapes is free software: you can redistribute it and/or modify         -->
   4 <!-- it under the terms of the GNU General Public License as published by   -->
   5 <!-- the Free Software Foundation, either version 3 of the License, or      -->
   6 <!-- any later version.                                                     -->
   7 <!--                                                                        -->
   8 <!-- Shapes is distributed in the hope that it will be useful,              -->
   9 <!-- but WITHOUT ANY WARRANTY; without even the implied warranty of         -->
  10 <!-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          -->
  11 <!-- GNU General Public License for more details.                           -->
  12 <!--                                                                        -->
  13 <!-- You should have received a copy of the GNU General Public License      -->
  14 <!-- along with Shapes.  If not, see <http://www.gnu.org/licenses/>.        -->
  15 <!--                                                                        -->
  16 <!-- Copyright 2008 Henrik Tidefelt                                         -->
  17
  18 <section id="bindings/simple">
  19 <title>Simple values</title>
  20 <top>
  21 <p>These bindings give access to many named constants that either serve as special tokens in certain situations, or simply deserve a binding due to their common use or special meaning.</p>
  22 </top>
  23
  24 <system-binding identifier="void">
  25         <simple-value>
  26                 <type><named-type name="Void" /></type>
  27                 <description>
  28                         <p>A value used to symbolize the absence of a value.</p>
  29                 </description>
  30         </simple-value>
  31 </system-binding>
  32
  33 <system-binding identifier="null">
  34         <simple-value>
  35                 <type><named-type name="Drawable" /></type>
  36                 <description>
  37                         <p>An empty <str-2D /> graphics value.  Useful in folds, for instance.</p>
  38                 </description>
  39                 <see-also>
  40                         <value name="null3D" />
  41                 </see-also>
  42         </simple-value>
  43 </system-binding>
  44
  45 <system-binding identifier="null3D">
  46         <simple-value>
  47                 <type><named-type name="Drawable3D" /></type>
  48                 <description>
  49                         <p>The analogue of <value name="null" />, but in <str-3D /> instead of <str-2D />.</p>
  50                 </description>
  51         </simple-value>
  52 </system-binding>
  53
  54 <system-binding identifier="emptypath">
  55         <simple-value>
  56                 <type><named-type name="Path" /></type>
  57                 <description>
  58                         <p>An empty <str-2D /> path.  Useful in folds, for instance.</p>
  59                 </description>
  60                 <see-also>
  61                         <value name="emptypath3D" />
  62                 </see-also>
  63         </simple-value>
  64 </system-binding>
  65
  66 <system-binding identifier="emptypath3D">
  67         <simple-value>
  68                 <type><named-type name="Path3D" /></type>
  69                 <description>
  70                         <p>The analogue of <value name="emptypath" />, but in <str-3D /> instead of <str-2D />.</p>
  71                 </description>
  72         </simple-value>
  73 </system-binding>
  74
  75 <system-binding identifier="pointpicture">
  76         <simple-value>
  77                 <type><named-type name="Drawable" /></type>
  78                 <description>
  79                         <p>An invisible <str-2D /> graphics value with a point-like bounding box as the origin.</p>
  80                 </description>
  81         </simple-value>
  82 </system-binding>
  83
  84 <system-binding identifier="arcdelta">
  85         <simple-value>
  86                 <type><named-type name="Length" /></type>
  87                 <description>
  88                         <p>The value controlled by <tol-param name="arcdelta" />.</p>
  89                 </description>
  90         </simple-value>
  91 </system-binding>
  92
  93 <system-binding identifier="nullbind">
  94         <simple-value>
  95                 <type><named-type name="DynamicBindings" /></type>
  96                 <description>
  97                         <p>May be used when combinding several dynamic bindings, and one would like — for clarity of notation — to use exactly one operator <operator name="&amp;" /> for each dynamic binding; not having the operator for the first (or last, depending on how you see things) will break symmetry and make it difficult to indent source code nicely.</p>
  98                 </description>
  99         </simple-value>
 100 </system-binding>
 101
 102 <system-binding identifier="NO_MASK">
 103         <simple-value>
 104                 <type><named-type name="SoftMask" /></type>
 105                 <description>
 106                         <p>Value for <dynamic name="alpha" /> and <dynamic name="luminosity" /> that indicates that the transparent imaging shall not be used.</p>
 107                 </description>
 108         </simple-value>
 109 </system-binding>
 110
 111 <system-binding identifier="NO_ARROW">
 112         <simple-value>
 113                 <type><named-type name="ArrowHead" /></type>
 114                 <description>
 115                         <p>Value that can be passed to <value name="stroke" /> to indicate that no arrowhead shall be drawn.  This special value will be recognized, and handled efficiently.</p>
 116                 </description>
 117         </simple-value>
 118 </system-binding>
 119
 120 <system-binding identifier="identity">
 121         <simple-value>
 122                 <type><named-type name="Function" /></type>
 123                 <description>
 124                         <p>A convenient function of one argument, that simply returns the argument.</p>
 125                 </description>
 126         </simple-value>
 127 </system-binding>
 128
 129 <system-binding identifier="CAP_BUTT">
 130         <simple-value>
 131                 <type><named-type name="Cap" /></type>
 132                 <description>
 133                         <p>Value for <dynamic name="cap" />.</p>
 134                 </description>
 135         </simple-value>
 136 </system-binding>
 137 <system-binding identifier="CAP_ROUND">
 138         <simple-value>
 139                 <type><named-type name="Cap" /></type>
 140                 <description>
 141                         <p>Value for <dynamic name="cap" />.</p>
 142                 </description>
 143         </simple-value>
 144 </system-binding>
 145 <system-binding identifier="CAP_SQUARE">
 146         <simple-value>
 147                 <type><named-type name="Cap" /></type>
 148                 <description>
 149                         <p>Value for <dynamic name="cap" />.</p>
 150                 </description>
 151         </simple-value>
 152 </system-binding>
 153
 154 <system-binding identifier="JOIN_MITER">
 155         <simple-value>
 156                 <type><named-type name="Join" /></type>
 157                 <description>
 158                         <p>Value for <dynamic name="join" />.</p>
 159                 </description>
 160         </simple-value>
 161 </system-binding>
 162 <system-binding identifier="JOIN_ROUND">
 163         <simple-value>
 164                 <type><named-type name="Join" /></type>
 165                 <description>
 166                         <p>Value for <dynamic name="join" />.</p>
 167                 </description>
 168         </simple-value>
 169 </system-binding>
 170 <system-binding identifier="JOIN_BEVEL">
 171         <simple-value>
 172                 <type><named-type name="Join" /></type>
 173                 <description>
 174                         <p>Value for <dynamic name="join" />.</p>
 175                 </description>
 176         </simple-value>
 177 </system-binding>
 178
 179 <system-binding identifier="GRAY_BLACK">
 180         <simple-value>
 181                 <type><named-type name="Gray" /></type>
 182                 <description>
 183                         <p>Predefined color value.</p>
 184                 </description>
 185         </simple-value>
 186 </system-binding>
 187 <system-binding identifier="GRAY_WHITE">
 188         <simple-value>
 189                 <type><named-type name="Gray" /></type>
 190                 <description>
 191                         <p>Predefined color value.</p>
 192                 </description>
 193         </simple-value>
 194 </system-binding>
 195 <system-binding identifier="OCCLUDING">
 196         <simple-value>
 197                 <type><named-type name="Gray" /></type>
 198                 <description>
 199                         <p>Color value with special interpretation.  If used as a color, it is the same as <value name="GRAY_WHITE" />.  In a z-sorter (see <value name="newZSorter" />), however, this color causes the surface not to be drawn at all.</p>
 200                         <p>This is useful when one wants to draw a picture where lines are drawn on a surface, and one is not interested in filling the surface with any color, but the surface is needed never the less to occlude lines.  Not filling the surface with any color allows the lines to be drawn on any background, and will also generate an output with much smaller memory footprint.</p>
 201                         <p>Note that a z-buffer always draws <em>all</em> visible line segments on top of the filled areas.</p>
 202                 </description>
 203         </simple-value>
 204 </system-binding>
 205
 206 <system-binding identifier="RGB_BLACK">
 207         <simple-value>
 208                 <type><named-type name="RGB" /></type>
 209                 <description>
 210                         <p>Predefined color value.</p>
 211                 </description>
 212         </simple-value>
 213 </system-binding>
 214 <system-binding identifier="RGB_WHITE">
 215         <simple-value>
 216                 <type><named-type name="RGB" /></type>
 217                 <description>
 218                         <p>Predefined color value.</p>
 219                 </description>
 220         </simple-value>
 221 </system-binding>
 222 <system-binding identifier="RGB_RED">
 223         <simple-value>
 224                 <type><named-type name="RGB" /></type>
 225                 <description>
 226                         <p>Predefined color value.</p>
 227                 </description>
 228         </simple-value>
 229 </system-binding>
 230 <system-binding identifier="RGB_GREEN">
 231         <simple-value>
 232                 <type><named-type name="RGB" /></type>
 233                 <description>
 234                         <p>Predefined color value.</p>
 235                 </description>
 236         </simple-value>
 237 </system-binding>
 238 <system-binding identifier="RGB_BLUE">
 239         <simple-value>
 240                 <type><named-type name="RGB" /></type>
 241                 <description>
 242                         <p>Predefined color value.</p>
 243                 </description>
 244         </simple-value>
 245 </system-binding>
 246 <system-binding identifier="RGB_YELLOW">
 247         <simple-value>
 248                 <type><named-type name="RGB" /></type>
 249                 <description>
 250                         <p>Predefined color value.</p>
 251                 </description>
 252         </simple-value>
 253 </system-binding>
 254 <system-binding identifier="RGB_CYAN">
 255         <simple-value>
 256                 <type><named-type name="RGB" /></type>
 257                 <description>
 258                         <p>Predefined color value.</p>
 259                 </description>
 260         </simple-value>
 261 </system-binding>
 262 <system-binding identifier="RGB_MAGENTA">
 263         <simple-value>
 264                 <type><named-type name="RGB" /></type>
 265                 <description>
 266                         <p>Predefined color value.</p>
 267                 </description>
 268         </simple-value>
 269 </system-binding>
 270
 271 <system-binding identifier="DEVICE_GRAY">
 272         <simple-value>
 273                 <type><named-type name="ColorSpace" /></type>
 274                 <description>
 275                         <p>Access to non-calibrated color space.</p>
 276                 </description>
 277         </simple-value>
 278 </system-binding>
 279 <system-binding identifier="DEVICE_RGB">
 280         <simple-value>
 281                 <type><named-type name="ColorSpace" /></type>
 282                 <description>
 283                         <p>Access to non-calibrated color space.</p>
 284                 </description>
 285         </simple-value>
 286 </system-binding>
 287 <system-binding identifier="DEVICE_CMYK">
 288         <simple-value>
 289                 <type><named-type name="ColorSpace" /></type>
 290                 <description>
 291                         <p>Access to non-calibrated color space.</p>
 292                 </description>
 293         </simple-value>
 294 </system-binding>
 295
 296 <system-binding identifier="BLEND_NORMAL">
 297         <simple-value>
 298                 <type><named-type name="BlendMode" /></type>
 299                 <description>
 300                         <p>Access to blend mode constant.</p>
 301                 </description>
 302         </simple-value>
 303 </system-binding>
 304 <system-binding identifier="BLEND_MULTIPLY">
 305         <simple-value>
 306                 <type><named-type name="BlendMode" /></type>
 307                 <description>
 308                         <p>Access to blend mode constant.</p>
 309                 </description>
 310         </simple-value>
 311 </system-binding>
 312 <system-binding identifier="BLEND_SCREEN">
 313         <simple-value>
 314                 <type><named-type name="BlendMode" /></type>
 315                 <description>
 316                         <p>Access to blend mode constant.</p>
 317                 </description>
 318         </simple-value>
 319 </system-binding>
 320 <system-binding identifier="BLEND_OVERLAY">
 321         <simple-value>
 322                 <type><named-type name="BlendMode" /></type>
 323                 <description>
 324                         <p>Access to blend mode constant.</p>
 325                 </description>
 326         </simple-value>
 327 </system-binding>
 328 <system-binding identifier="BLEND_DARKEN">
 329         <simple-value>
 330                 <type><named-type name="BlendMode" /></type>
 331                 <description>
 332                         <p>Access to blend mode constant.</p>
 333                 </description>
 334         </simple-value>
 335 </system-binding>
 336 <system-binding identifier="BLEND_LIGHTEN">
 337         <simple-value>
 338                 <type><named-type name="BlendMode" /></type>
 339                 <description>
 340                         <p>Access to blend mode constant.</p>
 341                 </description>
 342         </simple-value>
 343 </system-binding>
 344 <system-binding identifier="BLEND_COLOR_DODGE">
 345         <simple-value>
 346                 <type><named-type name="BlendMode" /></type>
 347                 <description>
 348                         <p>Access to blend mode constant.</p>
 349                 </description>
 350         </simple-value>
 351 </system-binding>
 352 <system-binding identifier="BLEND_COLOR_BURN">
 353         <simple-value>
 354                 <type><named-type name="BlendMode" /></type>
 355                 <description>
 356                         <p>Access to blend mode constant.</p>
 357                 </description>
 358         </simple-value>
 359 </system-binding>
 360 <system-binding identifier="BLEND_HARD_LIGHT">
 361         <simple-value>
 362                 <type><named-type name="BlendMode" /></type>
 363                 <description>
 364                         <p>Access to blend mode constant.</p>
 365                 </description>
 366         </simple-value>
 367 </system-binding>
 368 <system-binding identifier="BLEND_SOFT_LIGHT">
 369         <simple-value>
 370                 <type><named-type name="BlendMode" /></type>
 371                 <description>
 372                         <p>Access to blend mode constant.</p>
 373                 </description>
 374         </simple-value>
 375 </system-binding>
 376 <system-binding identifier="BLEND_DIFFERENCE">
 377         <simple-value>
 378                 <type><named-type name="BlendMode" /></type>
 379                 <description>
 380                         <p>Access to blend mode constant.</p>
 381                 </description>
 382         </simple-value>
 383 </system-binding>
 384 <system-binding identifier="BLEND_EXCLUSION">
 385         <simple-value>
 386                 <type><named-type name="BlendMode" /></type>
 387                 <description>
 388                         <p>Access to blend mode constant.</p>
 389                 </description>
 390         </simple-value>
 391 </system-binding>
 392 <system-binding identifier="BLEND_HUE">
 393         <simple-value>
 394                 <type><named-type name="BlendMode" /></type>
 395                 <description>
 396                         <p>Access to blend mode constant.</p>
 397                 </description>
 398         </simple-value>
 399 </system-binding>
 400 <system-binding identifier="BLEND_SATURATION">
 401         <simple-value>
 402                 <type><named-type name="BlendMode" /></type>
 403                 <description>
 404                         <p>Access to blend mode constant.</p>
 405                 </description>
 406         </simple-value>
 407 </system-binding>
 408 <system-binding identifier="BLEND_COLOR">
 409         <simple-value>
 410                 <type><named-type name="BlendMode" /></type>
 411                 <description>
 412                         <p>Access to blend mode constant.</p>
 413                 </description>
 414         </simple-value>
 415 </system-binding>
 416
 417 <system-binding identifier="DEVICE_GRAY">
 418         <simple-value>
 419                 <type><named-type name="ColorSpace" /></type>
 420                 <description>
 421                         <p>An uncalibrated color space.</p>
 422                 </description>
 423         </simple-value>
 424 </system-binding>
 425 <system-binding identifier="DEVICE_RGB">
 426         <simple-value>
 427                 <type><named-type name="ColorSpace" /></type>
 428                 <description>
 429                         <p>An uncalibrated color space.</p>
 430                 </description>
 431         </simple-value>
 432 </system-binding>
 433 <system-binding identifier="DEVICE_CMYK">
 434         <simple-value>
 435                 <type><named-type name="ColorSpace" /></type>
 436                 <description>
 437                         <p>An uncalibrated color space.</p>
 438                 </description>
 439         </simple-value>
 440 </system-binding>
 441
 442 <system-binding identifier="FONT_TIMES_ROMAN">
 443         <simple-value>
 444                 <type><named-type name="Font" /></type>
 445                 <description>
 446                         <p>Access to built-in <str-PDF /> font.</p>
 447                 </description>
 448         </simple-value>
 449 </system-binding>
 450 <system-binding identifier="FONT_TIMES_BOLD">
 451         <simple-value>
 452                 <type><named-type name="Font" /></type>
 453                 <description>
 454                         <p>Access to built-in <str-PDF /> font.</p>
 455                 </description>
 456         </simple-value>
 457 </system-binding>
 458 <system-binding identifier="FONT_TIMES_ITALIC">
 459         <simple-value>
 460                 <type><named-type name="Font" /></type>
 461                 <description>
 462                         <p>Access to built-in <str-PDF /> font.</p>
 463                 </description>
 464         </simple-value>
 465 </system-binding>
 466 <system-binding identifier="FONT_TIMES_BOLDITALIC">
 467         <simple-value>
 468                 <type><named-type name="Font" /></type>
 469                 <description>
 470                         <p>Access to built-in <str-PDF /> font.</p>
 471                 </description>
 472         </simple-value>
 473 </system-binding>
 474 <system-binding identifier="FONT_HELVETICA">
 475         <simple-value>
 476                 <type><named-type name="Font" /></type>
 477                 <description>
 478                         <p>Access to built-in <str-PDF /> font.</p>
 479                 </description>
 480         </simple-value>
 481 </system-binding>
 482 <system-binding identifier="FONT_HELVETICA_BOLD">
 483         <simple-value>
 484                 <type><named-type name="Font" /></type>
 485                 <description>
 486                         <p>Access to built-in <str-PDF /> font.</p>
 487                 </description>
 488         </simple-value>
 489 </system-binding>
 490 <system-binding identifier="FONT_HELVETICA_OBLIQUE">
 491         <simple-value>
 492                 <type><named-type name="Font" /></type>
 493                 <description>
 494                         <p>Access to built-in <str-PDF /> font.</p>
 495                 </description>
 496         </simple-value>
 497 </system-binding>
 498 <system-binding identifier="FONT_HELVETICA_BOLDOBLIQUE">
 499         <simple-value>
 500                 <type><named-type name="Font" /></type>
 501                 <description>
 502                         <p>Access to built-in <str-PDF /> font.</p>
 503                 </description>
 504         </simple-value>
 505 </system-binding>
 506 <system-binding identifier="FONT_COURIER">
 507         <simple-value>
 508                 <type><named-type name="Font" /></type>
 509                 <description>
 510                         <p>Access to built-in <str-PDF /> font.</p>
 511                 </description>
 512         </simple-value>
 513 </system-binding>
 514 <system-binding identifier="FONT_COURIER_BOLD">
 515         <simple-value>
 516                 <type><named-type name="Font" /></type>
 517                 <description>
 518                         <p>Access to built-in <str-PDF /> font.</p>
 519                 </description>
 520         </simple-value>
 521 </system-binding>
 522 <system-binding identifier="FONT_COURIER_OBLIQUE">
 523         <simple-value>
 524                 <type><named-type name="Font" /></type>
 525                 <description>
 526                         <p>Access to built-in <str-PDF /> font.</p>
 527                 </description>
 528         </simple-value>
 529 </system-binding>
 530 <system-binding identifier="FONT_COURIER_BOLDOBLIQUE">
 531         <simple-value>
 532                 <type><named-type name="Font" /></type>
 533                 <description>
 534                         <p>Access to built-in <str-PDF /> font.</p>
 535                 </description>
 536         </simple-value>
 537 </system-binding>
 538 <system-binding identifier="FONT_SYMBOL">
 539         <simple-value>
 540                 <type><named-type name="Font" /></type>
 541                 <description>
 542                         <p>Access to built-in <str-PDF /> font.</p>
 543                 </description>
 544         </simple-value>
 545 </system-binding>
 546 <system-binding identifier="FONT_ZAPFDINGBATS">
 547         <simple-value>
 548                 <type><named-type name="Font" /></type>
 549                 <description>
 550                         <p>Access to built-in <str-PDF /> font.</p>
 551                 </description>
 552         </simple-value>
 553 </system-binding>
 554
 555 </section>
 556