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} \args\
39 @macro Accessor {args}
40 @deffn {Accessor} \args\
44 @macro GenericFunction {args}
45 @deffn {Generic Function} \args\
49 @macro ForeignType {args}
50 @deftp {Foreign Type} \args\
54 @macro Variable {args}
55 @defvr {Special Variable} \args\
59 @macro Condition {args}
60 @deftp {Condition Type} \args\
70 @strong{Implementor's note:} @emph{\text\}
74 @c Info "requires" that x-refs end in a period or comma, or ) in the
75 @c case of @pxref. So the following implements that requirement for
76 @c the "See also" subheadings that permeate this manual, but only in
88 @c Typeset comments in roman font for the TeX output.
96 @c My copy of makeinfo is not generating any HTML for @result{} for
97 @c some odd reason. (It certainly used to...)
104 @c Similar macro to @result. Its purpose is to work around the fact
105 @c that ⇒ does not work properly inside @lisp.
118 @c ============================= Macros =============================
121 @c Show types, functions, and concepts in the same index.
127 @subtitle A Common Lisp binding for Gtk+
128 @author Dmitry Kalyanov
141 * GObject Reference::
149 @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.
151 As @code{Gtk+} is based on object system GObject, @code{cl-gtk2} is based on a binding to this object system called @uref{../gobject/index.html,,cl-gtk2-gobject}.
153 @code{cl-gtk2} provides a thin wrapper around @code{Gtk+} functionality, mostly retaining the same set of classes, properties and methods.
155 The important parts of @code{Gtk+} are:
157 @item GObject type system
164 @item Layout and composition of widgets
166 @item Using Gtk+ with threads
167 @item Building stand-alone applications
171 @chapter Installation
173 @code{cl-gtk2} has the following dependencies. They all must be installed before installing @code{cl-gtk2}.
176 @item @uref{http://common-lisp.net/project/cffi/,,CFFI} (version >= 0.10.4)
177 @item @uref{http://www.cliki.net/trivial-garbage,,Trivial-Garbage} (version >= 0.18)
178 @item @uref{http://common-lisp.net/project/iterate/,,Iterate} (version >= 1.4.3)
179 @item @uref{http://common-lisp.net/project/bordeaux-threads/,,Bordeaux-Threads} (version >= 0.6.0)
180 @item @uref{http://common-lisp.net/project/closer/closer-mop.html,,Closer-MOP} (version >= 0.55)
183 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.
185 To get sources with Git, clone @code{cl-gtk2} repository:
187 git clone git://repo.or.cz/cl-gtk2.git
190 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}.
192 To be able to compile, load and use @code{cl-gtk2}, you should register the @code{ASDF} system definitions.
194 To do this, either add @code{glib}, @code{gdk} and @code{gtk} directories to @code{asdf:*central-registry*}:
196 (push "/path/to/cl-gtk2/glib" asdf:*central-registry*)
197 (push "/path/to/cl-gtk2/gdk" asdf:*central-registry*)
198 (push "/path/to/cl-gtk2/gtk" asdf:*central-registry*)
200 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):
202 cd ~/.sbcl/systems # depends on your system
203 ln -s /path/to/cl-gtk2/glib/cl-gtk2-glib.asd .
204 ln -s /path/to/cl-gtk2/gdk/cl-gtk2-gdk.asd .
205 ln -s /path/to/cl-gtk2/gtk/cl-gtk2-gtk.asd .
208 @node GObject Reference
209 @chapter GObject Reference
211 @include gobject.ref.texi
214 @chapter Gdk Reference
216 @include gdk.ref.texi
219 @chapter Gtk Reference
221 @include gtk.ref.texi