#lang scribble/manual
@(require
  (for-label "main.rkt" (except-in scheme/gui/base send-event)))

@title{@bold{Books and Cycles}}

@author["Sam Anklesaria"]

@defmodule[books]

Books and cycles are two widgets for use with the
@schememodname[frtime] language. They define modal containers
that only displays one of their children at a time.

@defclass[book% pane% (area-container<%> subarea<%>)]{

@defconstructor[([page event?]
                 [parent (or/c (is-a?/c frame%) (is-a?/c dialog%) 
                               (is-a?/c panel%) (is-a?/c pane%))]
                 [vert-margin (integer-in 0 1000) 2]
                 [horiz-margin (integer-in 0 1000) 2]
                 [min-width (integer-in 0 10000) _graphical-minimum-width]
                 [min-height (integer-in 0 10000) _graphical-minimum-height]
                 [stretchable-width any/c #f]
                 [stretchable-height any/c #f])]{The @scheme[pane%] argument
takes an event carrying the names of the page to go to on updates}

@defmethod[(add-loc [name symbol?]) void?]{Declares the name of the next child added to the @scheme[book%].}

@defmethod[(set-page [name symbol?]) void?]{Sets the starting page for a @scheme[book%].}
}

@defclass[cycle% pane% (area-container<%> subarea<%>)]{

@defconstructor[([parent (or/c (is-a?/c frame%) (is-a?/c dialog%) 
                               (is-a?/c panel%) (is-a?/c pane%))]
                 [vert-margin (integer-in 0 1000) 2]
                 [horiz-margin (integer-in 0 1000) 2]
                 [min-width (integer-in 0 10000) _graphical-minimum-width]
                 [min-height (integer-in 0 10000) _graphical-minimum-height]
                 [stretchable-width any/c #f]
                 [stretchable-height any/c #f])]{}

@defmethod[(activate) void?]{Must be called before showing a @scheme[cycle%].}
}