basis/fonts/fonts-docs.factor

   1 ! Copyright (C) 2009 Slava Pestov
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax kernel colors ;
   4 IN: fonts
   5
   6 HELP: <font>
   7 { $values { "font" font } }
   8 { $description "Creates a new font." } ;
   9
  10 HELP: font
  11 { $class-description "The class of fonts." } ;
  12
  13 HELP: font-with-background
  14 { $values
  15      { "font" font } { "color" color }
  16      { "font'" font }
  17 }
  18 { $description "Creates a new font equal to the given font, except with a different " { $slot "background" } " slot." } ;
  19
  20 HELP: font-with-foreground
  21 { $values
  22      { "font" font } { "color" color }
  23      { "font'" font }
  24 }
  25 { $description "Creates a new font equal to the given font, except with a different " { $slot "foreground" } " slot." } ;
  26
  27 ARTICLE: "fonts" "Fonts"
  28 "The " { $vocab-link "fonts" } " vocabulary implements a data type for fonts that other vocabularies, for example " { $link "ui" } ", can use. A font combines a font name, size, style, and color information into a single object."
  29 { $subsections
  30     font
  31     <font>
  32 }
  33 "Modifying fonts:"
  34 { $subsections
  35     font-with-foreground
  36     font-with-background
  37 }
  38 "Useful constants:"
  39 { $subsections
  40     monospace-font
  41     sans-serif-font
  42     serif-font
  43 }
  44 "A data type for font metrics. The " { $vocab-link "fonts" } " vocabulary does not provide any means of computing font metrics, it simply defines a common data type that other vocabularies, such as " { $vocab-link "ui.text" } " may use:"
  45 { $subsections metrics } ;
  46
  47 ABOUT: "fonts"