basis/ui/gadgets/books/books-docs.factor

   1 USING: help.markup help.syntax ui.gadgets models ;
   2 IN: ui.gadgets.books
   3
   4 HELP: book
   5 { $class-description "A book is a control containing one or more children. The " { $link control-value } " is the index of exactly one child to be visible at any one time, the rest being hidden by having their " { $snippet "visible?" } " slots set to " { $link f } ". The sole visible child assumes the dimensions of the book gadget."
   6 $nl
   7 "Books are created by calling " { $link <book> } "." } ;
   8
   9 HELP: <book>
  10 { $values { "pages" "a sequence of gadgets" } { "model" model } { "book" book } }
  11 { $description "Creates a " { $link book } " control, which contains the gadgets in " { $snippet "pages" } "." } ;
  12
  13 HELP: <empty-book>
  14 { $values { "model" model } { "book" book } }
  15 { $description "Creates a " { $link book } " control with no children." }
  16 { $notes "Children must be added to the book before it is grafted, otherwise an error will be thrown." } ;
  17
  18 ARTICLE: "ui-book-layout" "Book layouts"
  19 "Books can contain any number of children, and display one child at a time. The currently visible child is determined by the value of the model, which must be an integer."
  20 { $subsection book }
  21 { $subsection <book> }
  22 { $subsection <empty-book> } ;
  23
  24 ABOUT: "ui-book-layout"