1 \input texinfo @c -*-texinfo-*-
2 @c %**start of header (This is for running texinfo on a region.)
5 @c %**end of header (This is for running texinfo on a region.)
7 @c @documentencoding utf-8
20 @deftp {Structure} \name\
29 @macro Superclass {name}
30 Superclass: @ref{\name\}
38 @macro EnumVRef {name,value}
39 @ref{enum.\name\.\value\,\value\}
47 @macro Accessor {name}
48 @deffn {Accessor} \name\
52 @macro TypedAccessor {name, class, type}
53 @deffn {Accessor} \name\ \class\
54 For class: @ref{\class\}
60 @macro GenericFunction {name}
61 @deffn {Generic Function} \name\
66 @deffn {Method} \name\
70 @macro ForeignType {name}
71 @deftp {Foreign Type} \name\
75 @macro Variable {name}
76 @defvr {Special Variable} \name\
80 @macro Condition {name}
81 @deftp {Condition Type} \name\
85 @macro Constant {name}
86 @defvr {Constant} \name\
90 @macro RFunction {name}
91 @anchor{\name\}@defun \name\
96 @anchor{\name\}@defmac \name\
100 @macro RStruct {name}
101 @anchor{\name\}@deftp {Structure} \name\
106 @anchor{\name\}@deftp {Class} \name\
110 @macro RSuperclass {name}
111 @anchor{\name\}Superclass: @ref{\name\}
115 @anchor{\name\}@deftp {Enum} \name\
120 @anchor{\name\}@deftp {Flags} \name\
124 @macro RAccessor {name}
125 @anchor{\name\}@deffn {Accessor} \name\
129 @macro RTypedAccessor {name, class, type}
130 @anchor{\name\}@deffn {Accessor} \name\ \class\
131 For class: @ref{\class\}
137 @macro RGenericFunction {name}
138 @anchor{\name\}@deffn {Generic Function} \name\
142 @macro RMethod {name}
143 @anchor{\name\}@deffn {Method} \name\
147 @macro RForeignType {name}
148 @anchor{\name\}@deftp {Foreign Type} \name\
152 @macro RVariable {name}
153 @anchor{\name\}@defvr {Special Variable} \name\
157 @macro RCondition {name}
158 @anchor{\name\}@deftp {Condition Type} \name\
162 @macro RConstant {name}
163 @anchor{\name\}@defvr {Constant} \name\
167 @macro SlotRef {class, slot}
168 @ref{slot.\class\.\slot\,\class\-\slot\}
171 @macro SignalRef {class, signal}
172 @ref{signal.\class\.\signal\,\class\::\signal\}
179 @macro impnote {text}
181 @strong{Implementor's note:} @emph{\text\}
185 @c Info "requires" that x-refs end in a period or comma, or ) in the
186 @c case of @pxref. So the following implements that requirement for
187 @c the "See also" subheadings that permeate this manual, but only in
190 @macro seealso {name}
196 @c @alias seealso = ref
199 @c Typeset comments in roman font for the TeX output.
201 @c @alias lispcmt = r
204 @c @alias lispcmt = asis
207 @c My copy of makeinfo is not generating any HTML for @result{} for
208 @c some odd reason. (It certainly used to...)
215 @c Similar macro to @result. Its purpose is to work around the fact
216 @c that ⇒ does not work properly inside @lisp.
229 @c ============================= Macros =============================
232 @c Show types, functions, and concepts in the same index.
238 @subtitle A Common Lisp binding for Gtk+
239 @author Dmitry Kalyanov
253 * GObject Reference::
261 @code{cl-gtk2} is the GUI library for Common Lisp. @code{cl-gtk2} is based on @uref{http://www.gtk.org/,,Gtk+} GUI library and is Common Lisp binding for it. @code{cl-gtk2} allows you to create graphical user interfaces for Common Lisp applications.
263 As @code{Gtk+} is based on object system GObject, @code{cl-gtk2} is based on a binding to this object system called @code{cl-gtk2-gobject}.
265 @code{cl-gtk2} provides a thin wrapper around @code{Gtk+} functionality, mostly retaining the same set of classes, properties and methods.
267 The important parts of @code{Gtk+} are:
269 @item GObject type system
276 @item Layout and composition of widgets
278 @item Using Gtk+ with threads
279 @item Building stand-alone applications
283 @chapter Installation
285 @code{cl-gtk2} has the following dependencies. They all must be installed before installing @code{cl-gtk2}.
288 @item @uref{http://common-lisp.net/project/cffi/,,CFFI} (version >= 0.10.4)
289 @item @uref{http://www.cliki.net/trivial-garbage,,Trivial-Garbage} (version >= 0.18)
290 @item @uref{http://common-lisp.net/project/iterate/,,Iterate} (version >= 1.4.3)
291 @item @uref{http://common-lisp.net/project/bordeaux-threads/,,Bordeaux-Threads} (version >= 0.6.0)
292 @item @uref{http://common-lisp.net/project/closer/closer-mop.html,,Closer-MOP} (version >= 0.55)
295 At first, source code of @code{cl-gtk2} needs to be downloaded. There are two options to download the sources: use @uref{http://git-scm.org/,,Git} or download @code{tar.gz} archive.
297 To get sources with Git, clone @code{cl-gtk2} repository:
299 git clone git://repo.or.cz/cl-gtk2.git
303 git clone git://github.com/dmitryvk/cl-gtk2.git
306 Or download and unpack the @code{tar.gz}-archived @uref{http://repo.or.cz/w/cl-gtk2.git?a=snapshot;h=HEAD;sf=tgz,,snapshot} of @code{cl-gtk2}.
308 To be able to compile, load and use @code{cl-gtk2}, you should register the @code{ASDF} system definitions.
310 To do this, either add @code{glib}, @code{gdk} and @code{gtk} directories to @code{asdf:*central-registry*}:
312 (push "/path/to/cl-gtk2/glib" asdf:*central-registry*)
313 (push "/path/to/cl-gtk2/gdk" asdf:*central-registry*)
314 (push "/path/to/cl-gtk2/gtk" asdf:*central-registry*)
316 or create symlinks to @code{cl-gtk2-glib.asd}, @code{cl-gtk2-gdk.asd} and @code{cl-gtk2-gtk.asd} files in a directory where @code{ASDF} systems are located (it might be @code{/usr/share/common-lisp/systems/} for system-wide installation in Gentoo Linux and Debian Linux, @code{~/.sbcl/systems/} for user installation for SBCL compiler):
318 cd ~/.sbcl/systems # depends on your system
319 ln -s /path/to/cl-gtk2/glib/cl-gtk2-glib.asd .
320 ln -s /path/to/cl-gtk2/gdk/cl-gtk2-gdk.asd .
321 ln -s /path/to/cl-gtk2/gtk/cl-gtk2-gtk.asd .
325 @chapter GLib Reference
328 @include glib.ref.texi
331 @node GObject Reference
332 @chapter GObject Reference
336 @include gobject.ref.texi
341 @chapter Gdk Reference
343 @include gdk.ref.texi
346 @chapter Gtk Reference
349 @include gtk.ref.texi