Welcome to the CHICKEN Scheme pasting service
zmarkup direct sxml representation (unmassaged) added by zbigniew the quixotic on Tue Feb 12 21:29:22 2013
;; this is the raw output of (pp (read-toplevel bb-port))
((h5 "bb:property"))
(procedure (bb:property WIDGET PROPERTY))
(setter (set! (bb:property WIDGET PROPERTY) VALUE))
("Gets or sets the properties given in "
(tt "PROPERTY1 ...")
" (which should be symbols)."
#\newline
"Values may also be lists, in that case the values are combined (this only applies to certain properties - see below).")
#\newline
("Some properties may be set for individual items of the "
(tt tree)
" and "
(tt table)
" widgets."
#\newline
"They are specified in the form "
(tt '(list WIDGET ITEMID))
"."
#\newline
(tt ITEMID)
" is either unique item id or one of the symbols"
#\:)
#\newline
(ul (li ((tt root)))
(li ((tt connector)))
(li ((tt leaf)))
(li ((tt branch))))
("In this case the "
(tt VALUE)
" will be applied either to root node, connector or"
#\newline
"all subsequent branches or leaves added to the tree.")
#\newline
((tt width)
" and "
(tt align)
" properties can be applied to the "
(tt table)
" widget's columns.")
#\newline
("Allowed widget properties are" #\:)
#\newline
(dl (dt x)
(dt y)
(dt width)
(dt height)
(dd ("Position and dimensions (integer). Positions are always relative"
#\newline
"to the container. "
(tt width)
" property may be set for "
(tt connector)
#\newline
"item of the "
(tt tree)
" widget."))
(dt text)
(dd ("The text of a label, button, text-fields or "
(tt html-view.)
" "
#\newline
"Also the title of a window. For the "
(tt tree)
" widget the value"
#\newline
"is the label of the subitem. For the "
(tt table)
" widget one can"
#\newline
"specify individual cells in the form "
(tt '(list TABLEWIDGET ROW COLUMN))
"."
#\newline
"The negative "
(tt ROW)
" means column header."))
(dt value)
(dd "The value of a \"range\" widget ("
(tt slider)
", "
(tt roller)
","
#\newline
(tt adjuster)
", "
(tt counter)
" or "
(tt dial)
"), in which case it should be a"
#\newline
"number. For "
(tt check-box)
" and "
(tt radio-button)
" widgets the value"
#\newline
"should be a boolean. For "
(tt list)
" widgets, the value is the index of"
#\newline
"the highlighted item, starting from 1. The value of the"
#\newline
(tt choice-button)
" widget is the index of the selected item. For"
#\newline
(tt tree)
" widgets, the value is the unique id of the currently"
#\newline
"selected item. The value of the "
(tt html-view)
" is a current file"
#\newline
"name. ")
(dt box)
(dd ("The " (em "box type") ". A box type is one of the symbols")
#\newline
(list (("no-box"))
(("flat-box"))
(("up-box"))
(("down-box"))
(("up-frame"))
(("down-frame"))
(("thin-up-box"))
(("thin-down-box"))
(("thin-up-frame"))
(("thin-down-frame"))
(("engraved-box"))
(("embossed-box"))
(("engraved-frame"))
(("embossed-frame"))
(("border-box"))))
(dt callback)
(dd "The callback procedure that is invoked when the"
#\newline
"value of a widget changes. See the "
(tt when)
#\newline
"property for more information. For "
(tt tree)
" widgets"
#\newline
"one can obtain additional information from"
#\newline
"properties "
(tt callback-reason)
" and"
#\newline
(tt callback-node.)
" ")
(dt image)
(dd ("An image that should be drawn into the widget. See "
(tt bb:image)
" for how to load images. You can also set"
#\newline
"the value "
(tt image)
" property to a string, which will"
#\newline
"load any image file with this name"
#\newline
"automatically. The value may also be a pointer"
#\newline
"object pointing to a data buffer for a "
(tt live-image)
" widget. Images may be set for a "
(tt tree)
#\newline
"widget items. If subitem is the "
(tt branch)
" or "
(tt connector)
", then "
(tt VALUE)
" can specify pair of the"
#\newline
"images"
#\:
" for closed and open state respectively."))
(dt type)
(dd ("The "
(em type)
" of a widget. The possible type symbols "
#\newline
"depend on what kind of widget it applies to"
#\:)
#\newline
(ul (li ((tt scroll) " (may be combined)")
#\newline
(ul (li ("scroll-horizontal"))
(li ("scroll-vertical"))
(li ("scroll-both"))
(li ("scroll-always-on"))
(li ("scroll-horizontal-always"))
(li ("scroll-vertical-always"))
(li ("scroll-both-always"))))
(li ((tt slider))
#\newline
(ul (li ("vertical-fill-slider"))
(li ("horizontal-fill-slider"))
(li ("vertical-nice-slider"))
(li ("horizontal-nice-slider"))))
(li ((tt dial))
#\newline
(ul (li ("normal-dial"))
(li ("line-dial"))
(li ("fill-dial"))
(li ("resizable")))))
("(FIXME Jim" #\: " Another way to write this list" #\: ")")
#\newline
(list (((tt scroll) " (may be combined)")
#\newline
(list (("scroll-horizontal"))
(("scroll-vertical"))
(("scroll-both"))
(("scroll-always-on"))
(("scroll-horizontal-always"))
(("scroll-vertical-always"))
(("scroll-both-always"))))
(((tt slider))
#\newline
(list (("vertical-fill-slider"))
(("horizontal-fill-slider"))
(("vertical-nice-slider"))
(("horizontal-nice-slider"))))
(((tt dial))
#\newline
(list (("normal-dial"))
(("line-dial"))
(("fill-dial"))
(("resizable")))))
("(FIXME Jim" #\: " A proposed way to write this list" #\: ")")
#\newline
(list (li ((tt scroll) " (may be combined)")
#\newline
(list (li ("scroll-horizontal"))
(li ("scroll-vertical"))
(li ("scroll-both"))
(li ("scroll-always-on"))
(li ("scroll-horizontal-always"))
(li ("scroll-vertical-always"))
(li ("scroll-both-always"))))
(li ((tt slider))
#\newline
(list (li ("vertical-fill-slider"))
(li ("horizontal-fill-slider"))
(li ("vertical-nice-slider"))
(li ("horizontal-nice-slider"))))
(li ((tt dial))
#\newline
(list (li ("normal-dial"))
(li ("line-dial"))
(li ("fill-dial"))
(li ("resizable"))))))
(dt modal)
(dd ("Whether a window is resizable and/or modal."))
(dt direction)
(dd ("The direction of a widget, which should be one of the symbols"
#\newline
(tt horizontal)
" or "
(tt vertical.)))
(dt color)
(dd ("The background color of a widget. This can either "
#\newline
"be a value returned by "
(tt bb:rgb)
" or one of the following symbols"
#\:)
#\newline
(list gray0
dark3
dark2
dark1
light1
light2
light3
gray
black
red
green
yellow
blue
magenta
cyan
dark-red
dark-green
dark-yellow
dark-blue
dark-magenta
dark-cyan
white)
("The color attribute of a "
(tt live-image)
" widget designates the number of color channels (1-4)."
#\newline
"Also is applicable to the "
(tt connector)
" subitem of the "
(tt tree)
" widget."))
(dt image-width)
(dd ("The width of a " (tt live-image) " widget."))
(dt image-height)
(dd ("The height of a " (tt live-image) " widget."))
(dt focus)
(dd ("Whether this widget has the input focus. "
#\newline
"Calling "
(tt bb:property)
" for this property will always return 0"
#\newline
"(but setting it will change the focus to the target widget)."))
(dt spacing)
(dd ("The spacing inside group widgets (in pixels)."))
(dt maximum)
(dd ("Maximum value for range widgets."))
(dt minimum)
(dd ("Minimum value for range widgets."))
(dt x-position)
(dd ("X-position for " (tt scroll) " widgets."))
(dt y-position)
(dd ("Y-position for " (tt scroll) " widgets."))
(dt text-color)
(dd ("Text color. Can also be applied to the " (tt tree) " subitems."))
(dt text-size)
(dd ("Text size. Can also be applied to the " (tt tree) " subitems."))
(dt text-font)
(dd ("Text font, which may be one of the following" #\:)
#\newline
(list (("helvetica"))
(("helvetica-bold"))
(("helvetica-italic"))
(("helvetica-bold-italic"))
(("courier"))
(("courier-bold"))
(("courier-italic"))
(("courier-bold-italic"))
(("times"))
(("times-bold"))
(("times-italic"))
(("times-bold-italic"))
(("symbol"))
(("screen"))
(("screen-bold")))
("Can be specified for the " (tt tree) " branches and leaves."))
(dt label-color)
(dd ("Color of a label."))
(dt label-size)
(dd ("Size of a label."))
(dt label-font)
(dd ("Font of a label."))
(dt selection-color)
(dd ("The color of the selection in a text widget or the color of indicators in other widgets."))
(dt position)
(dd ("The position of the caret in an "
(tt entry)
", "
(tt edit)
" or "
(tt text-editor)
" widget. Setting the position to "
(tt -1)
" will move the caret to the end of the current text."))
(dt mark)
(dd ("The position of the selection mark in an "
(tt entry)
", "
(tt edit)
" or "
(tt text-editor)
" widget. The text between the selection mark and the caret is the current selection."))
(dt selection)
(dd ("The currently selected text in an "
(tt entry)
", "
(tt edit)
" or "
(tt text-editor)
" widget. When set, the value should be a pair containing start and end position of the selection in the buffer."))
(dt tooltip)
(dd ("A string that should be displayed, when the mouse hovers over a widget."))
(dt visible)
(dd ("Whether a widget is visible or not."))
(dt resizable-widget)
(dd ("The widget in a group, which should be exclusively resizable."))
(dt valid-context)
(dd ("A flag indicating whether the GL context for a "
(tt glwindow)
" is already initialized."))
(dt read-only)
(dd ("If true, an "
(tt edit)
" or "
(tt entry)
" widget can not be changed by the user."))
(dt align)
(dd ("The alignment of the widget label. May be combination of the following symbols"
#\:)
#\newline
(list (li ("center"))
(li ("top"))
(li ("bottom"))
(li ("left"))
(li ("right"))
(li ("inside"))
(li ("text-over-image"))
(li ("image-over-text"))
(li ("clip"))
(li ("wrap"))))
(dt when)
(dd ("An indicator when a widgets callback should be"
#\newline
"invoked. The default behaviour depends on the type of the"
#\newline
"widget. Possible settings are"
#\:)
#\newline
(dl (dt never)
(dd ("never invoked the callback"))
(dt changed)
(dd ("when the widget's value changes"))
(dt released)
(dd ("when the button or key is released and the value changes"))
(dt enter)
(dd ("when the enter key is pressed and the value changes"))
(dt always)
(dd ("modifier for "
(tt released)
" or "
(tt enter)
", that indicates "
#\newline
"the callback should be invoked, even if the value doesn't change")))
("The default behaviour is to invoke the callback whenever the value of"
#\newline
"a widget changes, when a "
(tt window)
" is closed, when "
(tt glwindow)
" needs"
#\newline
"to be redrawn, or a "
(tt button)
" or "
(tt list)
" item has been clicked."))
(dt handler)
(dd "The callback procedure that is invoked when "
#\newline
"the event occurs. The event is passed in a"
#\newline
"first (and only) argument to the handler. "
#\newline
"A event is one of the symbols"
#\:
#\newline
(list no-event
push
release
enter
leave
drag
focus
unfocus
keydown
keyup
close
move
shortcut
deactivate
activate
hide
show
paste
selectionclear
mousewheel
dnd-enter
dnd-drag
dnd-leave
dnd-release
unknown)
#\newline
"Additional information about event can be obtained with "
(tt bb:event)
#\newline
"procedure. Returning "
(tt #f)
" from handler indicates that widget is not"
#\newline
"interested in handling this event. "
(tt #t)
" means that event was"
#\newline
"successfully handled. Any other value leads to invoking default"
#\newline
"handler of this widget."
#\newline
"The "
(tt html-view)
" widget's "
(tt handler)
" is invoked when user tries to"
#\newline
"follow the link (which URI is passed as an argument). "
(tt handler)
#\newline
"should return either the name of the temporary file or "
(tt #f)
" and set"
#\newline
"the "
(tt text)
" property. ")
(dt callback-reason)
(dd ("The reason for callback. Available only for "
(tt tree)
" widget. Valid values are"
#\:)
#\newline
(list (li ("hilighted"))
(li ("unhilighted"))
(li ("selected"))
(li ("unselected"))
(li ("opened"))
(li ("closed"))
(li ("double-click"))
(li ("widget-callback"))
(li ("moved-node"))
(li ("new-node"))
(li ("nothing"))))
(dt callback-node)
(dd ("The unique id of the node that caused callback. Available only for "
(tt tree)
" widget."))))