X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=doc%2Fgtk.texi;h=dac73fb115a27d0081bcc42d10ca26a22531270b;hb=ec9d532ae8c6b3a0a6ee1a7edf732fd1e67393ea;hp=472dbfda070336060bdf403ba1fe498110cdf5bc;hpb=9260d934453417ce89440f03ec6d0ed31760f29e;p=cl-gtk2.git diff --git a/doc/gtk.texi b/doc/gtk.texi index 472dbfd..dac73fb 100644 --- a/doc/gtk.texi +++ b/doc/gtk.texi @@ -6,61 +6,172 @@ @c @documentencoding utf-8 -@macro Function {args} -@defun \args\ +@macro Function {name} +@defun \name\ @end defun @end macro -@macro Macro {args} -@defmac \args\ +@macro Macro {name} +@defmac \name\ @end defmac @end macro -@macro Struct {args} -@deftp {Structure} \args\ +@macro Struct {name} +@deftp {Structure} \name\ @end deftp @end macro -@macro Class {args} -@deftp {Class} \args\ +@macro Class {name} +@deftp {Class} \name\ @end deftp @end macro -@macro Enum {args} -@deftp {Enum} \args\ +@macro Superclass {name} +Superclass: @ref{\name\} +@end macro + +@macro Enum {name} +@deftp {Enum} \name\ @end deftp @end macro -@macro Flags {args} -@deftp {Flags} \args\ +@macro EnumVRef {name,value} +@ref{enum.\name\.\value\,\value\} +@end macro + +@macro Flags {name} +@deftp {Flags} \name\ @end deftp @end macro -@macro Accessor {args} -@deffn {Accessor} \args\ +@macro Accessor {name} +@deffn {Accessor} \name\ +@end deffn +@end macro + +@macro TypedAccessor {name, class, type} +@deffn {Accessor} \name\ \class\ +For class: @ref{\class\} + +Type: \type\ +@end deffn +@end macro + +@macro GenericFunction {name} +@deffn {Generic Function} \name\ @end deffn @end macro -@macro GenericFunction {args} -@deffn {Generic Function} \args\ +@macro Method {name} +@deffn {Method} \name\ @end deffn @end macro -@macro ForeignType {args} -@deftp {Foreign Type} \args\ +@macro ForeignType {name} +@deftp {Foreign Type} \name\ @end deftp @end macro -@macro Variable {args} -@defvr {Special Variable} \args\ +@macro Variable {name} +@defvr {Special Variable} \name\ @end defvr @end macro -@macro Condition {args} -@deftp {Condition Type} \args\ +@macro Condition {name} +@deftp {Condition Type} \name\ +@end deftp +@end macro + +@macro Constant {name} +@defvr {Constant} \name\ +@end defvr +@end macro + +@macro RFunction {name} +@anchor{\name\}@defun \name\ +@end defun +@end macro + +@macro RMacro {name} +@anchor{\name\}@defmac \name\ +@end defmac +@end macro + +@macro RStruct {name} +@anchor{\name\}@deftp {Structure} \name\ +@end deftp +@end macro + +@macro RClass {name} +@anchor{\name\}@deftp {Class} \name\ +@end deftp +@end macro + +@macro RSuperclass {name} +@anchor{\name\}Superclass: @ref{\name\} +@end macro + +@macro REnum {name} +@anchor{\name\}@deftp {Enum} \name\ @end deftp @end macro +@macro RFlags {name} +@anchor{\name\}@deftp {Flags} \name\ +@end deftp +@end macro + +@macro RAccessor {name} +@anchor{\name\}@deffn {Accessor} \name\ +@end deffn +@end macro + +@macro RTypedAccessor {name, class, type} +@anchor{\name\}@deffn {Accessor} \name\ \class\ +For class: @ref{\class\} + +Type: \type\ +@end deffn +@end macro + +@macro RGenericFunction {name} +@anchor{\name\}@deffn {Generic Function} \name\ +@end deffn +@end macro + +@macro RMethod {name} +@anchor{\name\}@deffn {Method} \name\ +@end deffn +@end macro + +@macro RForeignType {name} +@anchor{\name\}@deftp {Foreign Type} \name\ +@end deftp +@end macro + +@macro RVariable {name} +@anchor{\name\}@defvr {Special Variable} \name\ +@end defvr +@end macro + +@macro RCondition {name} +@anchor{\name\}@deftp {Condition Type} \name\ +@end deftp +@end macro + +@macro RConstant {name} +@anchor{\name\}@defvr {Constant} \name\ +@end defvr +@end macro + +@macro SlotRef {class, slot} +@ref{slot.\class\.\slot\,\class\-\slot\} +@end macro + +@macro SignalRef {class, signal} +@ref{signal.\class\.\signal\,\class\::\signal\} +@end macro + @macro cffi @acronym{CFFI} @end macro @@ -81,17 +192,17 @@ @end macro @end ifinfo -@ifnotinfo -@alias seealso = ref -@end ifnotinfo +@c @ifnotinfo +@c @alias seealso = ref +@c @end ifnotinfo @c Typeset comments in roman font for the TeX output. -@iftex -@alias lispcmt = r -@end iftex -@ifnottex -@alias lispcmt = asis -@end ifnottex +@c @iftex +@c @alias lispcmt = r +@c @end iftex +@c @ifnottex +@c @alias lispcmt = asis +@c @end ifnottex @c My copy of makeinfo is not generating any HTML for @result{} for @c some odd reason. (It certainly used to...) @@ -138,6 +249,7 @@ @menu * Overview:: * Installation:: +* GLib Reference:: * GObject Reference:: * Gdk Reference:: * Gtk Reference:: @@ -148,7 +260,7 @@ @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. -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}. +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}. @code{cl-gtk2} provides a thin wrapper around @code{Gtk+} functionality, mostly retaining the same set of classes, properties and methods. @@ -186,6 +298,10 @@ To get sources with Git, clone @code{cl-gtk2} repository: @example git clone git://repo.or.cz/cl-gtk2.git @end example +or the mirror: +@example +git clone git://github.com/dmitryvk/cl-gtk2.git +@end example 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}. @@ -205,11 +321,22 @@ ln -s /path/to/cl-gtk2/gdk/cl-gtk2-gdk.asd . ln -s /path/to/cl-gtk2/gtk/cl-gtk2-gtk.asd . @end example +@node GLib Reference +@chapter GLib Reference + +@lowersections +@include glib.ref.texi +@raisesections + @node GObject Reference @chapter GObject Reference +@lowersections + @include gobject.ref.texi +@raisesections + @node Gdk Reference @chapter Gdk Reference @@ -218,6 +345,8 @@ ln -s /path/to/cl-gtk2/gtk/cl-gtk2-gtk.asd . @node Gtk Reference @chapter Gtk Reference +@lowersections @include gtk.ref.texi +@raisesections @bye