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

USING: help.markup help.syntax ui.gadgets models ;
IN: ui.gadgets.books

HELP: book
{ $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."
$nl
"Books are created by calling " { $link <book> } "." } ;

HELP: <book>
{ $values { "pages" "a sequence of gadgets" } { "model" model } { "book" book } }
{ $description "Creates a " { $link book } " control, which contains the gadgets in " { $snippet "pages" } "." } ;

HELP: <empty-book>
{ $values { "model" model } { "book" book } }
{ $description "Creates a " { $link book } " control with no children." }
{ $notes "Children must be added to the book before it is grafted, otherwise an error will be thrown." } ;

ARTICLE: "ui-book-layout" "Book layouts"
"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."
{ $subsection book }
{ $subsection <book> }
{ $subsection <empty-book> } ;

ABOUT: "ui-book-layout"