Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-xul Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:30:17 2021 GMT+0.
| • Introduction | What cl-xul is all about | |
| • Systems | The systems documentation | |
| • Modules | The modules documentation | |
| • Files | The files documentation | |
| • Packages | The packages documentation | |
| • Definitions | The symbols documentation | |
| • Indexes | Concepts, functions, variables and data types |
CL-XUL is a library that helps to create Mozilla XUL user interfaces in Common Lisp.
It uses IOlib based clws library for the communication between the Mozilla XULRunner and Common Lisp via web sockets. Because of the IOlib limitation, it works only on Linux at the moment, until a platform independent implementation of websockets is found. Also, I've only tried it from SBCL so far.
CL-XUL implements a component-based architecture, standard widgets support, easy communication between client and server and automatic view updates and a readable description of GUI directly in Common Lisp, with no need of external XML files.
Its implementation can be considered similar to that of the Phobos Smalltalk framework, and to the javascript implementation XULJet, although it is not quite the same.
This is still work in progress, and there's no documentation at the moment (it is coming soon, though) but a demo can be tried.
As of December 26 of 2013, CL-XUL can be obtained from Quicklisp.
Evaluate (ql:quickload :cl-xul) to download and install the system, and (ql:quickload :cl-xul-test) followed by (xul-test:showcase) to run the demo.
Alternatively, download the source code from here and point cl-xul.asd and cl-xul-test.asd system definition files from ./sbcl/system (ln -s <system definition file path>) and then evaluate:
(require :cl-xul-test)
and
(xul-test:showcase)
from your lisp listener.
You will also need to satisfy the system dependencies:
The easiest way of installing those packages is via Quicklisp.
This library is under the MIT licence.
Next: Modules, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The cl-xul system |
Mariano Montone <marianomontone@gmail.com>
Mariano Montone <marianomontone@gmail.com>
Copyright (c) 2013 Mariano Montone
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Mozilla XUL bindings
0.1
cl-xul.asd (file)
src (module)
Modules are listed depth-first from the system components tree.
| • The cl-xul/src module | ||
| • The cl-xul/src/controls module | ||
| • The cl-xul/src/widgets module |
Next: The cl-xul/src/controls module, Previous: Modules, Up: Modules [Contents][Index]
cl-xul (system)
src/
Next: The cl-xul/src/widgets module, Previous: The cl-xul/src module, Up: Modules [Contents][Index]
package.lisp (file)
src (module)
src/controls/
Previous: The cl-xul/src/controls module, Up: Modules [Contents][Index]
component.lisp (file)
src (module)
src/widgets/
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files |
Next: The cl-xul/src/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cl-xul.asd
cl-xul (system)
Next: The cl-xul/src/controls/mop․lisp file, Previous: The cl-xul․asd file, Up: Lisp files [Contents][Index]
src (module)
src/package.lisp
Next: The cl-xul/src/controls/control․lisp file, Previous: The cl-xul/src/package․lisp file, Up: Lisp files [Contents][Index]
controls (module)
src/controls/mop.lisp
Next: The cl-xul/src/controls/window․lisp file, Previous: The cl-xul/src/controls/mop․lisp file, Up: Lisp files [Contents][Index]
mop.lisp (file)
controls (module)
src/controls/control.lisp
Next: The cl-xul/src/controls/box․lisp file, Previous: The cl-xul/src/controls/control․lisp file, Up: Lisp files [Contents][Index]
control.lisp (file)
controls (module)
src/controls/window.lisp
Next: The cl-xul/src/controls/label․lisp file, Previous: The cl-xul/src/controls/window․lisp file, Up: Lisp files [Contents][Index]
window.lisp (file)
controls (module)
src/controls/box.lisp
Next: The cl-xul/src/controls/button․lisp file, Previous: The cl-xul/src/controls/box․lisp file, Up: Lisp files [Contents][Index]
box.lisp (file)
controls (module)
src/controls/label.lisp
Next: The cl-xul/src/controls/text․lisp file, Previous: The cl-xul/src/controls/label․lisp file, Up: Lisp files [Contents][Index]
label.lisp (file)
controls (module)
src/controls/button.lisp
Next: The cl-xul/src/controls/menu․lisp file, Previous: The cl-xul/src/controls/button․lisp file, Up: Lisp files [Contents][Index]
button.lisp (file)
controls (module)
src/controls/text.lisp
Next: The cl-xul/src/controls/list․lisp file, Previous: The cl-xul/src/controls/text․lisp file, Up: Lisp files [Contents][Index]
text.lisp (file)
controls (module)
src/controls/menu.lisp
Next: The cl-xul/src/controls/tree․lisp file, Previous: The cl-xul/src/controls/menu․lisp file, Up: Lisp files [Contents][Index]
menu.lisp (file)
controls (module)
src/controls/list.lisp
Next: The cl-xul/src/controls/panel․lisp file, Previous: The cl-xul/src/controls/list․lisp file, Up: Lisp files [Contents][Index]
list.lisp (file)
controls (module)
src/controls/tree.lisp
Next: The cl-xul/src/controls/toolbar․lisp file, Previous: The cl-xul/src/controls/tree․lisp file, Up: Lisp files [Contents][Index]
tree.lisp (file)
controls (module)
src/controls/panel.lisp
Next: The cl-xul/src/controls/tooltip․lisp file, Previous: The cl-xul/src/controls/panel․lisp file, Up: Lisp files [Contents][Index]
panel.lisp (file)
controls (module)
src/controls/toolbar.lisp
toolbox (macro)
toolbox (class)
Next: The cl-xul/src/controls/picker․lisp file, Previous: The cl-xul/src/controls/toolbar․lisp file, Up: Lisp files [Contents][Index]
toolbar.lisp (file)
controls (module)
src/controls/tooltip.lisp
tooltip (class)
Next: The cl-xul/src/controls/tabs․lisp file, Previous: The cl-xul/src/controls/tooltip․lisp file, Up: Lisp files [Contents][Index]
tooltip.lisp (file)
controls (module)
src/controls/picker.lisp
Next: The cl-xul/src/controls/splitter․lisp file, Previous: The cl-xul/src/controls/picker․lisp file, Up: Lisp files [Contents][Index]
picker.lisp (file)
controls (module)
src/controls/tabs.lisp
Next: The cl-xul/src/controls/grid․lisp file, Previous: The cl-xul/src/controls/tabs․lisp file, Up: Lisp files [Contents][Index]
tabs.lisp (file)
controls (module)
src/controls/splitter.lisp
Next: The cl-xul/src/controls/dialog․lisp file, Previous: The cl-xul/src/controls/splitter․lisp file, Up: Lisp files [Contents][Index]
splitter.lisp (file)
controls (module)
src/controls/grid.lisp
Next: The cl-xul/src/controls/browser․lisp file, Previous: The cl-xul/src/controls/grid․lisp file, Up: Lisp files [Contents][Index]
grid.lisp (file)
controls (module)
src/controls/dialog.lisp
Next: The cl-xul/src/controls/html․lisp file, Previous: The cl-xul/src/controls/dialog․lisp file, Up: Lisp files [Contents][Index]
dialog.lisp (file)
controls (module)
src/controls/browser.lisp
Next: The cl-xul/src/util․lisp file, Previous: The cl-xul/src/controls/browser․lisp file, Up: Lisp files [Contents][Index]
browser.lisp (file)
controls (module)
src/controls/html.lisp
Next: The cl-xul/src/websocket․lisp file, Previous: The cl-xul/src/controls/html․lisp file, Up: Lisp files [Contents][Index]
controls (module)
src (module)
src/util.lisp
replace-all (function)
Next: The cl-xul/src/xul․lisp file, Previous: The cl-xul/src/util․lisp file, Up: Lisp files [Contents][Index]
util.lisp (file)
src (module)
src/websocket.lisp
Next: The cl-xul/src/events․lisp file, Previous: The cl-xul/src/websocket․lisp file, Up: Lisp files [Contents][Index]
websocket.lisp (file)
src (module)
src/xul.lisp
Next: The cl-xul/src/dialog․lisp file, Previous: The cl-xul/src/xul․lisp file, Up: Lisp files [Contents][Index]
xul.lisp (file)
src (module)
src/events.lisp
Next: The cl-xul/src/component․lisp file, Previous: The cl-xul/src/events․lisp file, Up: Lisp files [Contents][Index]
events.lisp (file)
src (module)
src/dialog.lisp
Next: The cl-xul/src/widgets/widget․lisp file, Previous: The cl-xul/src/dialog․lisp file, Up: Lisp files [Contents][Index]
dialog.lisp (file)
src (module)
src/component.lisp
Next: The cl-xul/src/widgets/button․lisp file, Previous: The cl-xul/src/component․lisp file, Up: Lisp files [Contents][Index]
widgets (module)
src/widgets/widget.lisp
Next: The cl-xul/src/widgets/text-box․lisp file, Previous: The cl-xul/src/widgets/widget․lisp file, Up: Lisp files [Contents][Index]
widgets (module)
src/widgets/button.lisp
render (method)
Next: The cl-xul/src/widgets/list-box․lisp file, Previous: The cl-xul/src/widgets/button․lisp file, Up: Lisp files [Contents][Index]
widgets (module)
src/widgets/text-box.lisp
render (method)
Previous: The cl-xul/src/widgets/text-box․lisp file, Up: Lisp files [Contents][Index]
widgets (module)
src/widgets/list-box.lisp
render (method)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The xul-system package | ||
| • The xul package | ||
| • The xul-widgets package | ||
| • The xul-builder package | ||
| • The html-builder package |
Next: The xul package, Previous: Packages, Up: Packages [Contents][Index]
cl-xul.asd
Next: The xul-widgets package, Previous: The xul-system package, Up: Packages [Contents][Index]
package.lisp (file)
Next: The xul-builder package, Previous: The xul package, Up: Packages [Contents][Index]
package.lisp (file)
w
common-lisp
Next: The html-builder package, Previous: The xul-widgets package, Up: Packages [Contents][Index]
package.lisp (file)
<
common-lisp
Previous: The xul-builder package, Up: Packages [Contents][Index]
package.lisp (file)
<html
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions | ||
| • Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported macros | ||
| • Exported functions | ||
| • Exported generic functions | ||
| • Exported classes |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
html.lisp (file)
window.lisp (file)
menu.lisp (file)
tabs.lisp (file)
tabs.lisp (file)
control.lisp (file)
control.lisp (file)
control.lisp (file)
menu.lisp (file)
tree.lisp (file)
menu.lisp (file)
browser.lisp (file)
browser.lisp (file)
browser.lisp (file)
panel.lisp (file)
tabs.lisp (file)
box.lisp (file)
browser.lisp (file)
button.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
panel.lisp (file)
button.lisp (file)
list.lisp (file)
button.lisp (file)
control.lisp (file)
window.lisp (file)
control.lisp (file)
panel.lisp (file)
tabs.lisp (file)
menu.lisp (file)
control.lisp (file)
splitter.lisp (file)
control.lisp (file)
picker.lisp (file)
picker.lisp (file)
text.lisp (file)
grid.lisp (file)
grid.lisp (file)
tabs.lisp (file)
panel.lisp (file)
control.lisp (file)
tree.lisp (file)
control.lisp (file)
control.lisp (file)
control.lisp (file)
label.lisp (file)
tabs.lisp (file)
list.lisp (file)
tree.lisp (file)
control.lisp (file)
picker.lisp (file)
text.lisp (file)
panel.lisp (file)
tooltip.lisp (file)
dialog.lisp (file)
component.lisp (file)
text.lisp (file)
menu.lisp (file)
dialog.lisp (file)
button.lisp (file)
window.lisp (file)
window.lisp (file)
browser.lisp (file)
browser.lisp (file)
browser.lisp (file)
menu.lisp (file)
tabs.lisp (file)
tabs.lisp (file)
tree.lisp (file)
html.lisp (file)
button.lisp (file)
tree.lisp (file)
window.lisp (file)
tree.lisp (file)
tree.lisp (file)
text.lisp (file)
tree.lisp (file)
control.lisp (file)
tabs.lisp (file)
panel.lisp (file)
tabs.lisp (file)
picker.lisp (file)
tree.lisp (file)
tree.lisp (file)
control.lisp (file)
panel.lisp (file)
menu.lisp (file)
window.lisp (file)
grid.lisp (file)
splitter.lisp (file)
menu.lisp (file)
panel.lisp (file)
button.lisp (file)
html.lisp (file)
tabs.lisp (file)
tabs.lisp (file)
box.lisp (file)
control.lisp (file)
tree.lisp (file)
window.lisp (file)
tree.lisp (file)
tree.lisp (file)
picker.lisp (file)
text.lisp (file)
browser.lisp (file)
label.lisp (file)
html.lisp (file)
html.lisp (file)
button.lisp (file)
window.lisp (file)
browser.lisp (file)
tree.lisp (file)
panel.lisp (file)
label.lisp (file)
tabs.lisp (file)
picker.lisp (file)
control.lisp (file)
control.lisp (file)
menu.lisp (file)
label.lisp (file)
tabs.lisp (file)
tabs.lisp (file)
panel.lisp (file)
panel.lisp (file)
html.lisp (file)
window.lisp (file)
window.lisp (file)
tabs.lisp (file)
list.lisp (file)
list.lisp (file)
list.lisp (file)
list.lisp (file)
list.lisp (file)
list.lisp (file)
list.lisp (file)
text.lisp (file)
control.lisp (file)
control.lisp (file)
text.lisp (file)
menu.lisp (file)
menu.lisp (file)
menu.lisp (file)
menu.lisp (file)
menu.lisp (file)
menu.lisp (file)
control.lisp (file)
menu.lisp (file)
text.lisp (file)
control.lisp (file)
control.lisp (file)
tree.lisp (file)
control.lisp (file)
text.lisp (file)
menu.lisp (file)
text.lisp (file)
panel.lisp (file)
tooltip.lisp (file)
panel.lisp (file)
control.lisp (file)
events.lisp (file)
control.lisp (file)
events.lisp (file)
events.lisp (file)
events.lisp (file)
text.lisp (file)
picker.lisp (file)
tabs.lisp (file)
tabs.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
label.lisp (file)
text.lisp (file)
text.lisp (file)
label.lisp (file)
tabs.lisp (file)
tooltip.lisp (file)
tooltip.lisp (file)
tooltip.lisp (file)
tooltip.lisp (file)
tabs.lisp (file)
tree.lisp (file)
control.lisp (file)
button.lisp (file)
html.lisp (file)
control.lisp (file)
tooltip.lisp (file)
panel.lisp (file)
tabs.lisp (file)
control.lisp (file)
tree.lisp (file)
tabs.lisp (file)
text.lisp (file)
control.lisp (file)
tooltip.lisp (file)
control.lisp (file)
picker.lisp (file)
tree.lisp (file)
tree.lisp (file)
control.lisp (file)
button.lisp (file)
button.lisp (file)
picker.lisp (file)
tree.lisp (file)
browser.lisp (file)
control.lisp (file)
splitter.lisp (file)
splitter.lisp (file)
grid.lisp (file)
grid.lisp (file)
tree.lisp (file)
window.lisp (file)
window.lisp (file)
browser.lisp (file)
text.lisp (file)
tabs.lisp (file)
tabs.lisp (file)
tabs.lisp (file)
tree.lisp (file)
tabs.lisp (file)
browser.lisp (file)
window.lisp (file)
text.lisp (file)
menu.lisp (file)
tree.lisp (file)
control.lisp (file)
control.lisp (file)
control.lisp (file)
tree.lisp (file)
tree.lisp (file)
box.lisp (file)
text.lisp (file)
splitter.lisp (file)
browser.lisp (file)
splitter.lisp (file)
tree.lisp (file)
control.lisp (file)
menu.lisp (file)
control.lisp (file)
html.lisp (file)
splitter.lisp (file)
list.lisp (file)
tabs.lisp (file)
tabs.lisp (file)
tabs.lisp (file)
tabs.lisp (file)
tabs.lisp (file)
tabs.lisp (file)
tabs.lisp (file)
html.lisp (file)
control.lisp (file)
text.lisp (file)
picker.lisp (file)
text.lisp (file)
dialog.lisp (file)
panel.lisp (file)
toolbar.lisp (file)
tooltip.lisp (file)
control.lisp (file)
control.lisp (file)
tabs.lisp (file)
panel.lisp (file)
browser.lisp (file)
tree.lisp (file)
tree.lisp (file)
tree.lisp (file)
tree.lisp (file)
tree.lisp (file)
tree.lisp (file)
tree.lisp (file)
tree.lisp (file)
tree.lisp (file)
browser.lisp (file)
html.lisp (file)
tabs.lisp (file)
tree.lisp (file)
tabs.lisp (file)
tabs.lisp (file)
box.lisp (file)
control.lisp (file)
tree.lisp (file)
window.lisp (file)
window.lisp (file)
component.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
text.lisp (file)
text.lisp (file)
control.lisp (file)
control.lisp (file)
Next: Exported generic functions, Previous: Exported macros, Up: Exported definitions [Contents][Index]
dialog.lisp (file)
component.lisp (file)
dialog.lisp (file)
events.lisp (file)
events.lisp (file)
events.lisp (file)
events.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
dialog.lisp (file)
Next: Exported classes, Previous: Exported functions, Up: Exported definitions [Contents][Index]
component.lisp (file)
automatically generated reader method
component.lisp (file)
automatically generated writer method
component.lisp (file)
automatically generated reader method
control.lisp (file)
automatically generated writer method
control.lisp (file)
automatically generated reader method
component.lisp (file)
automatically generated writer method
component.lisp (file)
automatically generated reader method
component.lisp (file)
automatically generated writer method
component.lisp (file)
component.lisp (file)
component.lisp (file)
component.lisp (file)
list-box.lisp (file)
text-box.lisp (file)
button.lisp (file)
Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
component.lisp (file)
standard-object (class)
widget (class)
parent (generic function)
(setf parent) (generic function)
:dirty-p
dirty-p (generic function)
(setf dirty-p) (generic function)
:children
(make-hash-table :test (function equalp))
children (generic function)
(setf children) (generic function)
xul.lisp (file)
standard-object (class)
Specifies the application name.
string
:name
(error "provide the application name")
name (generic function)
(setf name) (generic function)
The application vendor.
(or string null)
:vendor
vendor (generic function)
(setf vendor) (generic function)
Specifies the application version number.
string
:version
"1.0"
version (generic function)
(setf version) (generic function)
Specifies a unique build identifier. This is typically a date identifier, and should be different for every released version of an application.
string
:build-id
(error "provide the build id")
build-id (generic function)
(setf build-id) (generic function)
Specifies the unique application ID. REQUIRED. The application ID, like extension IDs, can be formatted either like an email ApplicationName@vendor.tld or a UUID {12345678-1234-1234-1234-123456789abc}. The email format is recommended for newly developed applications. Example: ID=TestApplication@example.tld
Specifies the path to use for the application’s profile, based within the user’s application data directory. OPTIONAL. Example: Profile=MyAppData
(or pathname null)
:profile
profile (generic function)
(setf profile) (generic function)
Specifies the minimum XULRunner version needed by this application. If there are binary components, MinVersion must equal the version of the libxul SDK which is used to build the application.
string
:gecko-min-version
"1.8"
gecko-min-version (generic function)
(setf gecko-min-version) (generic function)
Specify the maximum XULRunner version needed by this application. OPTIONAL - default value is any XULRunner less than XULRunner 2
string
:gecko-max-version
"200.*"
gecko-max-version (generic function)
(setf gecko-max-version) (generic function)
(or xul::xul-element null)
:xul
app-xul (generic function)
(setf app-xul) (generic function)
(or xul:component null)
:root-component
root-component (generic function)
(setf root-component) (generic function)
:javascripts
javascripts (generic function)
(setf javascripts) (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal special variables | ||
| • Internal macros | ||
| • Internal functions | ||
| • Internal generic functions | ||
| • Internal classes |
Next: Internal macros, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
events.lisp (file)
websocket.lisp (file)
dialog.lisp (file)
websocket.lisp (file)
websocket.lisp (file)
The xul runner. It can be the XUL runner or Mozilla firefox
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
widget.lisp (file)
control.lisp (file)
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
button.lisp (file)
events.lisp (file)
events.lisp (file)
dialog.lisp (file)
list-box.lisp (file)
component.lisp (file)
component.lisp (file)
component.lisp (file)
events.lisp (file)
Returns a new string in which all the occurences of the part is replaced with replacement.
component.lisp (file)
websocket.lisp (file)
websocket.lisp (file)
text-box.lisp (file)
component.lisp (file)
component.lisp (file)
Next: Internal classes, Previous: Internal functions, Up: Internal definitions [Contents][Index]
Specifies a unique build identifier. This is typically a date identifier, and should be different for every released version of an application.
xul.lisp (file)
automatically generated reader method
widget.lisp (file)
automatically generated writer method
widget.lisp (file)
widget.lisp (file)
list-box.lisp (file)
automatically generated reader method
control.lisp (file)
automatically generated writer method
control.lisp (file)
automatically generated reader method
component.lisp (file)
automatically generated writer method
component.lisp (file)
html.lisp (file)
control.lisp (file)
Specify the maximum XULRunner version needed by this application. OPTIONAL - default value is any XULRunner less than XULRunner 2
xul.lisp (file)
Specifies the minimum XULRunner version needed by this application. If there are binary components, MinVersion must equal the version of the libxul SDK which is used to build the application.
xul.lisp (file)
automatically generated reader method
component.lisp (file)
automatically generated writer method
component.lisp (file)
Specifies the unique application ID. REQUIRED. The application ID, like extension IDs, can be formatted either like an email ApplicationName@vendor.tld or a UUID {12345678-1234-1234-1234-123456789abc}. The email format is recommended for newly developed applications. Example: ID=TestApplication@example.tld
xul.lisp (file)
automatically generated reader method
list-box.lisp (file)
automatically generated writer method
list-box.lisp (file)
automatically generated reader method
button.lisp (file)
automatically generated writer method
button.lisp (file)
automatically generated reader method
component.lisp (file)
automatically generated writer method
component.lisp (file)
automatically generated reader method
list-box.lisp (file)
automatically generated writer method
list-box.lisp (file)
Triggered when the text box changes
text-box.lisp (file)
Client event: Triggered when the text box changes
text-box.lisp (file)
Triggered when button clicked
button.lisp (file)
Client event: Triggered when button clicked
button.lisp (file)
Triggered when item selected
list-box.lisp (file)
Client event: Triggered when item selected
list-box.lisp (file)
Specifies the path to use for the application’s profile, based within the user’s application data directory. OPTIONAL. Example: Profile=MyAppData
xul.lisp (file)
automatically generated reader method
list-box.lisp (file)
automatically generated writer method
list-box.lisp (file)
component.lisp (file)
control.lisp (file)
control.lisp (file)
control.lisp (file)
control.lisp (file)
control.lisp (file)
dialog.lisp (file)
window.lisp (file)
automatically generated reader method
text-box.lisp (file)
automatically generated writer method
text-box.lisp (file)
Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
html.lisp (file)
html-element (class)
box.lisp (file)
container-element (class)
A frame which is expected to contain a view of a Web document. It is similar to an iframe except that it holds a page history and contains additional methods to manipulate the currently displayed page.
Most of the properties and methods of the browser will rarely be used and can only be called from chrome URLs. Other URLs will need to use the document and history objects to change the displayed document.
browser.lisp (file)
xul-element (class)
:autocomplete-enabled
:autocomplete-popup
:autoscroll
:disable-history
:disable-global-history
:disable-security
:homepage
:remoteshowcaret
:src
:type*
A button that can be pressed by the user. Event handlers can be used to trap mouse, keyboard and other events. It is typically rendered as a grey outset rectangle. You can specify the label of the button using the label attribute or by placing content inside the button.
button.lisp (file)
container-element (class)
:accesskey
:autocheck
:checkstate
:checked
:command
:crop
:dir
:disabled
:dlgtype
:group
:icon
:image
:label
:open
:orient
:tabindex
:type
:default
button.lisp (file)
widget (class)
:label
(error "provide the button label")
label (generic function)
(setf label) (generic function)
Triggered when button clicked
:on-command
on-command (generic function)
(setf on-command) (generic function)
Client event: Triggered when button clicked
:on-command*
on-command* (generic function)
(setf on-command*) (generic function)
A header for a groupbox. It may contain either a text label, using the label attribute, or child elements for a more complex caption.
panel.lisp (file)
xul-control (class)
:accesskey
:crop
:image
:label
:tabindex
An element that can be turned on and off. This is most commonly rendered as a box when the element is off and a box with a check when the element is on. The user can switch the state of the check box by selecting it with the mouse. A label, specified with the label attribute, may be added beside the check box.
button.lisp (file)
xul-element (class)
:accesskey
:checked
:command
:crop
:disabled
:src
:label
:preference
:tabindex
:default
A palette of colors from which a user may select by clicking on one of the grid cells.
picker.lisp (file)
xul-element (class)
:disabled
:color
:onchange
:preference
:tabindex
:type
A single column in a columns element. Each child of the column element is placed in each successive cell of the grid. The column with the most child elements determines the number of rows in each column.
It is common to use columns only to define width and flexibility for the grid column and not place elements directly inside the column.
grid.lisp (file)
container-element (class)
Defines the columns of a grid. Child column elements define the individual columns to appear in the grid. The columns element may be nested inside another columns element. Other elements placed inside a columns element occupy the full height of the grid and are placed in their corresponding positions between the columns.
grid.lisp (file)
container-element (class)
component.lisp (file)
standard-class (class)
component.lisp (file)
component.lisp (file)
component.lisp (file)
standard-object (class)
:make-component-dirty-p
t
make-component-dirty-p (generic function)
(setf make-component-dirty-p) (generic function)
control.lisp (file)
xul-element (class)
:children
children (generic function)
(setf children) (generic function)
A datepicker allows the user to enter a date. Three types are available, which can be specified using the type attribute.
normal - a datepicker with three fields for entering the year, month and date.
grid - a datepicker with a calendar grid for selecting a date.
popup - a normal datepicker with three fields, but with an additional dropdown button to display a popup grid.
picker.lisp (file)
xul-element (class)
:disabled
:firstdayofweek
:readonly
:type
:tabindex
:value
An element that displays only one of its children at a time. The selectedIndex attribute determines which child is displayed.
panel.lisp (file)
container-element (class)
:selected-index
This element is used to create a block of text. The text can be set either with the value attribute or by placing text inside the open and close description tags. The value attribute is used to set text that appears in a single line. If text appears as a child of the description, it will wrap to multiple lines. It may contain arbitrary markup, which can be styled as needed.
text.lisp (file)
xul-element (class)
:crop
:disabled
:tabindex
:value
This element should be used in place of the window element for dialog boxes.
The buttons attribute may be used to set which buttons should appear in the dialog box.
These buttons will be placed in the correct locations for the user’s platform.
dialog.lisp (file)
container-element (class)
serialize-xul (method)
:buttonaccesskeyaccept
:buttonaccesskeycancel
:buttonaccesskeydisclosure
:buttonaccesskeyextra1
:buttonaccesskeyextra2
:buttonaccesskeyhelp
:buttonalign
:buttondir
:buttondisabledaccept
:buttonlabelaccept
:buttonlabelcancel
:buttonlabeldisclosure
:buttonlabelextra1
:buttonlabelextra2
:buttonlabelhelp
:buttonorient
:buttonpack
:buttons
:defaultbutton
:ondialogaccept
:ondialogcancel
:ondialogdisclosure
:ondialogextra1
:ondialogextra2
:ondialoghelp
:title
html.lisp (file)
A grid is a layout type that arranges elements in rows and columns. The grid is expected to contain both a columns element as a child which defines the structure of the columns and a rows element as child to define the rows. The size and attributes defined on columns and rows will affect the size and placement of elements in each cell. Elements placed within both the columns and rows will be displayed, although usually only elements will be placed inside one of these. In is most common to place elements within the rows and use the columns only to define their flexibility and width. Whichever of the columns and rows is last in the grid is displayed on top; commonly the columns element appears in the grid first.
grid.lisp (file)
container-element (class)
An element that may be used inside a splitter which can be used to collapse a sibling element of the splitter.
splitter.lisp (file)
xul-element (class)
The groupbox is used to group related elements together. If a caption element is placed inside the groupbox, it will be used as a caption which appears along the top of the groupbox. Typically, the groupbox will be drawn with a border around it and the caption either above or over the top border, however the actual appearance will be platform specific. On Linux, for instance, only the caption appears with no border around the group.
panel.lisp (file)
container-element (class)
html.lisp (file)
html-element (class)
html.lisp (file)
xml-element (class)
element-name (method)
An inner frame that works much like the HTML iframe element.
The src attribute can be used to specify the content of the frame.
This content is a separate document. The children of the iframe are ignored.
browser.lisp (file)
container-element (class)
:showcaret
:src
:type*
:transparent
An element that displays an image, much like the HTML img element. The src attribute can be used to specify the URL of the image.
label.lisp (file)
xul-control (class)
:onerror
:onload
:src
:validate
This element is used to provide a label for a control element. If the user clicks the label, it will move the focus to the associated control, specified with the control attribute.
label.lisp (file)
xul-control (class)
:accesskey
:control
:crop
:disabled
:href
:value
html.lisp (file)
html-element (class)
This element is used to create a list of items where one or more of the items may be selected. A listbox may contain multiple columns. There are numerous methods which allow the items in the listbox to be retrieved and modified.
You may specify the number of rows to display in the list using the rows attribute. Additional rows can be viewed using a scroll bar. A listbox is expected to contain listitem elements. All the rows in the listbox are the same height, which is the height of the tallest item in the list. If you wish to create a list with variable height rows, or with non-text content, you should instead use the richlistbox element.
list.lisp (file)
container-element (class)
:disabled
:disablekeynavigation
:preference
:rows
:seltype
:suppressonselect
:tabindex
:value
:onselect
list-box.lisp (file)
widget (class)
:items
items (generic function)
(setf items) (generic function)
:selected-item
selected-item (generic function)
(setf selected-item) (generic function)
:menu-popup
menu-popup (generic function)
(setf menu-popup) (generic function)
Triggered when item selected
:on-select
on-select (generic function)
(setf on-select) (generic function)
Client event: Triggered when item selected
:on-select*
on-select* (generic function)
(setf on-select*) (generic function)
A single cell of a listbox. By default it only contains text but iconic and checkbox listcells are also available
list.lisp (file)
xul-control (class)
:crop
:disabled
:image
:label
:type
A column in a listbox. You can make some columns flexible and other columns non-flexible.
list.lisp (file)
xul-control (class)
A container for the columns of a listbox, each of which are created with the listcol element. There should be only one listcols element in a list box. If there is no listcols element, the list box has a single column.
list.lisp (file)
container-element (class)
A header row of a listbox. It is usual to place listheader elements inside the listhead, one for each column.
list.lisp (file)
container-element (class)
:disabled
A header for a single column in a listbox.
list.lisp (file)
xul-control (class)
:disabled
:label
A single row in a listbox. The text of the listitem is specified either using listcell elements, or by placing a label attribute directly on the listitem element. By default it contains a single listcell element of type and class appropriate to that of the listitem.
list.lisp (file)
container-element (class)
:accesskey
:checked
:command
:crop
:current
:disabled
:image
:label
:preference
:selected
:tabindex
:type
:value
An element, much like a button, that is placed on a menubar. When the user clicks the menu element, the child menupopup of the menu will be displayed. This element is also used to create submenus.
menu.lisp (file)
container-element (class)
:acceltext
:accesskey
:allowevents
:command
:crop
:disabled
:image
:label
:menuactive
:open*
:sizetopopup
:tabindex
:value
A container that usually contains menu elements. On the Macintosh, the menubar is displayed along the top of the screen, and all non-menu related elements inside the menubar will be ignored. To look native (at least on Windows), the menubar element needs to be placed inside a toolbox element.
menu.lisp (file)
container-element (class)
:grippyhidden
:statusbar
A single choice in a menupopup element. It acts much like a button but it is rendered on a menu.
menu.lisp (file)
xul-element (class)
:acceltext
:accesskey
:allowevents
:autocheck
:checked
:closemenu
:command
:crop
:description
:disabled
:image
:key
:label
:name
:selected
:tabindex
:type*
:validate
:value
An element that can be used for drop-down choice lists. The user may select one of the elements displayed in the menulist. The currently selected choice is displayed on the menulist element. To create the drop-down, put a menupopup inside the menulist containing the choices as menuitem elements. The command event may be used to execute code when the menulist selection changes.
menu.lisp (file)
container-element (class)
:accesskey
:crop
:disableautoselect
:disabled
:editable
:focused
:image
:label
:oncommand
:open
:preference
:readonly
:sizetopopup
:tabindex
:value
A container used to display the contents of a popup menu. When a menupopup is open, it floats above the window and may extend outside the window border. There are several ways in which a menupopup may be used:
It may be placed inside a menu, menulist, toolbarbutton, or a button with the type attribute set to "menu" to create a popup that will open when the menu or button is pressed.
It may be attached to any element using the popup attribute. When the element is clicked with the left mouse button, the menupopup will be displayed.
It may be attached to any element using the context attribute. When a context menu is opened, the menupopup will be displayed. A context menu may be opened by right-clicking the element, or by pressing the menu key on the keyboard.
menu.lisp (file)
container-element (class)
:ignorekeys
:left
:onpopuphidden
:onpopuphiding
:onpopupshowing
:onpopupshown
:position*
:top
Used to create a separator between menu items. Typically drawn as a thin line.
menu.lisp (file)
xul-element (class)
:acceltext
:accesskey
:allowevents
:command
:crop
:disabled
:image
:label
:selected
:tabindex
:value
html.lisp (file)
html-element (class)
A panel is a used as a temporary floating popup window that may contain any type of content. It does not have any window decorations. When open, it floats above the window and may extend outside the border of the main window. Typically, it will be attached to a button using the button’s type attribute so that when the button is pressed, the panel will be displayed. A panel may also be opened via a script using the openPopup method.
panel.lisp (file)
container-element (class)
:backdrag
:close*
:consumeoutsideclicks
:fade
:flip
:ignorekeys
:label
:left
:level
:noautofocus
:noautohide
:norestorefocus
:onpopuphidden
:onpopuphiding
:onpopupshowing
:onpopupshown
:position*
:titlebar
:top
:type*
An element that can be turned on and off. Radio buttons are almost always grouped together in groups. Only one radio button within the same radiogroup may be selected at a time. The user can switch which radio button is turned on by selecting it with the mouse or keyboard. Other radio buttons in the same group are turned off. A label, specified with the label attribute may be added beside the radio button.
button.lisp (file)
xul-control (class)
:accesskey
:command
:crop
:disabled
:focused
:group
:image
:label
:selected
:tabindex
:value
:src
A group of radio buttons. Only one radio button inside the group can be selected at a time. The radio buttons may either direct children of the radiogroup or descendants. Place the radiogroup inside a groupbox if you would like a border or caption for the group. The radiogroup defaults to vertical orientation.
button.lisp (file)
container-element (class)
:disabled
:focused
:preference
:tabindex
:value
component.lisp (file)
xul-change (class)
:component
(error "provide the component")
component (generic function)
(setf component) (generic function)
A single row in a rows element. Each child of the row element is placed in each successive cell of the grid. The row with the most child elements determines the number of columns in each row, which may be smaller or larger than the number of column elements defined in the grid.
grid.lisp (file)
container-element (class)
Defines the rows of a grid. Child row elements define the individual rows to appear in the grid. Each child of a rows element should be a row element.
The rows element may be nested inside another rows element. The children of these nested rows are counted as normal rows as if they were part of the parent. However, nesting rows elements allows groups of rows to have a separate appearance such as a different border, or separate scrolling may be defined for these rows.
Non-row related elements placed inside a rows element occupy the full width of the grid and are placed in their corresponding positions between the rows.
grid.lisp (file)
container-element (class)
Much like the HTML script element, this is used to declare a script to be used by the XUL window.
You should usually put scripts in a separate file pointed to by the src attribute, but you may also place the script inline inside the opening and closing script tags.
browser.lisp (file)
container-element (class)
:src
:type*
An element that takes up space but does not display anything. It is usually used to place spacing within a container. If you don’t specify that the spacer has a size or is flexible, the spacer does not occupy any space. If you want a small gap, consider using a separator instead.
box.lisp (file)
xul-control (class)
An element which should appear before or after an element inside a container.
When the splitter is dragged, the sibling elements of the splitter are resized.
If a grippy is placed inside the splitter, one sibling element of the splitter is collapsed when the grippy is clicked.
splitter.lisp (file)
container-element (class)
:collapse
:resizeafter
:resizebefore
:state
:substate
A single tab which should be placed inside a tabs element.
The user may click a tab to bring the associated page of the tabbox to the front.
tabs.lisp (file)
xul-element (class)
:accesskey
:afterselected
:beforeselected
:command
:crop
:disabled
:first-tab
:image
:label
:last-tab
:linkedpanel
:oncommand
:pending
:pinned
:selected
:tabindex
:unread
:validate
:value
A container used to display a set of tabbed pages of elements. A row of tabs is displayed at the top of tabbox which may be used to switch between each page. The tabbox should contain two children, the first a tabs element which contains the tabs and the second a tabpanels element which contains the contents of the pages.
tabs.lisp (file)
container-element (class)
:eventnode
:handlectrlpageupdown
:handlectrltab
:selected-index
A individual panel in a tabpanels element. This element is optional and you may just use any other container in place of it.
tabs.lisp (file)
container-element (class)
A container to hold the set of pages in a tabbox.
The tabpanels element should be placed in a tabbox although it does not have to be a direct child.
The children of the tabpanels element become the panels of the tabbox.
In most cases you would use a vbox, but they can be any element, although some people like to use tabpanel elements.
By clicking the first tab, the first panel will be displayed.
By clicking the second tab, the second panel will be displayed and so on.
There should be the same number of panels as there are tabs.
Panels should never be hidden; hiding the tab suffices to make the panel inaccessible.
tabs.lisp (file)
container-element (class)
:selected-index
A row of tabs. A tabs element should be placed inside a tabbox and should contain tab elements.
NB: You can add some other elements to tabs such as button, but they will receive an index. Activating them will not change the selectedIndex.
tabs.lisp (file)
container-element (class)
:closebutton
:disableclose
:disabled
:onclosetab
:onnewtab
:onselect
:setfocus
:selectedindex
:tabbox
:tabindex
:tooltiptextnew
:value
An input field where the user can enter text. It is similar to the HTML input element. Only one line of text is displayed by default. The multiline attribute can be specified to display a field with multiple rows.
text.lisp (file)
xul-element (class)
:cols
:decimalplaces
:disabled
:emptytext
:hidespinbuttons
:increment
:label
:max
:maxlength
:min
:multiline
:newlines
:onblur
:onchange
:onfocus
:oninput
:placeholder
:preference
:readonly
:rows
:searchbutton
:size
:spellcheck
:tabindex
:timeout
:type
:value
:wrap
:wraparound
text-box.lisp (file)
widget (class)
:value
value (generic function)
(setf value) (generic function)
Triggered when the text box changes
:on-change
on-change (generic function)
(setf on-change) (generic function)
Client event: Triggered when the text box changes
:on-change*
on-change* (generic function)
(setf on-change*) (generic function)
The timepicker is used to allow the user to enter a time. It contains three fields to enter the hour, minute and second. Arrow buttons next to the fields allow the values to be adjusted with the mouse. A fourth textbox appears for 12 hour clocks which allows selection of AM or PM.
To specify the initial, use the value attribute set to a value of either the form HH:MM:SS or HH:MM. The value may be retrieved and changed using the value property or the dateValue property. The former specifies the time as a string of the form HH:MM:SS whereas the latter specifies the time as a Date object. In addition, the hour, minute and second properties may be used to retrieve and modify each component of the time separately.
picker.lisp (file)
xul-element (class)
:disabled
:hideseconds
:increment
:readonly
:tabindex
:value
A container for toolbars. It is a type of box but defaults to vertical orientation. If a toolbar is placed inside a toolbox, a grippy is displayed on its left or upper edge. The user may click the grippy to collapse the toolbar. If multiple toolbars are placed in the same toolbox, they will all collapse into the same row. The Firefox browser does not have grippies so toolbars cannot be collapsed and expanded.
toolbar.lisp (file)
container-element (class)
This element is used for the tooltip popups.
For text-only tooltips, this element doesn’t need to be used; instead you may just add a tooltiptext attribute to an element.
tooltip.lisp (file)
container-element (class)
:crop
:default
:label
:noautohide
:onpopuphidden
:onpopuphiding
:onpopupshowing
:onpopupshown
:page
:position*
A container which can be used to hold a tabular or hierarchical set of rows of elements.
The tree may contain any number of rows and any number of columns.
Each row of the tree may contain child rows which are displayed indented from the parent.
tree.lisp (file)
container-element (class)
:disablekeynavigation
:disabled
:editable
:enablecolumndrag
:flags
:hidecolumnpicker
:onselect
:rows
:seltype
:statedatasource
:tabindex
:treelines
A single cell in a tree.
This element should be placed inside a treerow.
You can set the text for the cell using the label attribute.
tree.lisp (file)
xul-element (class)
:editable
:label
:mode
:properties
:ref
:src
:value
This element is the body of the tree.
For content trees, the content will be placed inside this element.
This element is also used to define container rows in the tree.
tree.lisp (file)
container-element (class)
:alternating-background
A column of a tree.
It displays the column header and holds the size and other information about the column.
You can also place splitter elements between the columns to allow column resizing.
You should always place an id attribute on a treecol element to ensure that the column positioning is handled properly.
tree.lisp (file)
xul-element (class)
:crop
:cycler
:dragging
:editable
:fixed
:hidden
:hideheader
:ignoreincolumnpicker
:label
:primary
:sort*
:sortactive
:sortdirection
:src
:type*
:width
A group of treecol elements. There should one and only one treecols element in a tree.
tree.lisp (file)
container-element (class)
:picker-tooltip-text
A treeitem should be placed inside a treechildren element and should contain treerow elements.
The treeitem can be clicked by the user to select the row of the tree.
The treeitem contains a single row and all of what appear to the user as that row’s descendants.
tree.lisp (file)
container-element (class)
:container
:empty
:label
:open*
:uri
A single row in a tree.
It should be placed inside a treeitem element.
Children of the treerow should be treecell elements.
If child rows are necessary, they should be placed in a treechildren element inside the parent treeitem.
tree.lisp (file)
container-element (class)
:properties
Used to place a separator row in a tree.
tree.lisp (file)
xul-element (class)
:properties
html.lisp (file)
widget.lisp (file)
component (class)
client-initialization (generic function)
(setf client-initialization) (generic function)
window.lisp (file)
container-element (class)
serialize-xul (method)
:accelerated
:chrome-margin
:disable-chrome
:disable-fast-find
:draw-in-title-bar
:fullscreen-button
:hide-chrome
:id
:lightweight-themes
:lightweight-themes-footer
:screenx
:screeny
:size-mode
:title
:window-type
control.lisp (file)
standard-object (class)
:content
content (generic function)
(setf content) (generic function)
component.lisp (file)
standard-object (class)
replace-component-change (class)
mop.lisp (file)
standard-class (class)
control.lisp (file)
xul-element (class)
mop.lisp (file)
mop.lisp (file)
initialize-instance (method)
control.lisp (file)
xml-element (class)
:align
:allow-events
:allow-negative-assertions
:class*
:coalesce-duplicate-arcs
:collapsed
:container
:containment
:context
:context-menu
:data-sources
:dir
:empty
:equal-size
:flags
:flex
:height
:hidden
:id
:insert-after
:insert-before
:left
:max-height
:max-width
:menu
:min-height
:min-width
:mouse-through
:observes
:ordinal
Orientation
(member :horizontal :vertical)
:orient
:pack
:persist
:popup
:position*
:preference-editable
:query-type
:ref
:remove-element
:sort-direction
:sort-resource
:sort-resource-2
:status-text
:style
:template
:tooltip
:tooltip-text
:top
:uri
:wait-cursor
:width
:on-command
websocket.lisp (file)
ws-resource (class)
mop.lisp (file)
standard-slot-definition (class)
Whether the slot is a XUL attribute
boolean
:attribute
t
is-attribute (generic function)
(setf is-attribute) (generic function)
The attribute name
(or null string)
:attribute-name
(setf attribute-name) (generic function)
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index | ||
| • Function index | ||
| • Variable index | ||
| • Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | C F L M |
|---|
| Jump to: | C F L M |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | (
A B C D E F G H I J K L M N O P Q R S T U V W X |
|---|
| Jump to: | (
A B C D E F G H I J K L M N O P Q R S T U V W X |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | *
A B C D E F G H I J K L M N O P Q R S T U V W X |
|---|