Merge remote-tracking branch 'andy128k/master'
[cl-gtk2.git] / doc / gobject.texi
blob2a00ecad795cdaddb3a58ee7e14d022f1bd0b368
1 \input texinfo  @c -*-texinfo-*-
2 @c %**start of header (This is for running texinfo on a region.)
3 @setfilename gobject.info
4 @settitle CL-Gtk2-GObject
5 @c %**end of header (This is for running texinfo on a region.)
7 @c @documentencoding utf-8
9 @macro Function {args}
10 @defun \args\
11 @end defun
12 @end macro
14 @macro RFunction {name}
15 @anchor{\name\}@defun \name\
16 @end defun
17 @end macro
19 @macro Macro {args}
20 @defmac \args\
21 @end defmac
22 @end macro
24 @macro RMacro {args}
25 @anchor{\args\}@defmac \args\
26 @end defmac
27 @end macro
29 @macro Struct {args}
30 @deftp {Structure} \args\
31 @end deftp
32 @end macro
34 @macro Class {args}
35 @deftp {Class} \args\
36 @end deftp
37 @end macro
39 @macro Accessor {args}
40 @deffn {Accessor} \args\
41 @end deffn
42 @end macro
44 @macro GenericFunction {args}
45 @deffn {Generic Function} \args\
46 @end deffn
47 @end macro
49 @macro ForeignType {args}
50 @deftp {Foreign Type} \args\
51 @end deftp
52 @end macro
54 @macro Variable {args}
55 @defvr {Special Variable} \args\
56 @end defvr
57 @end macro
59 @macro Condition {args}
60 @deftp {Condition Type} \args\
61 @end deftp
62 @end macro
64 @macro cffi
65 @acronym{CFFI}
66 @end macro
68 @macro impnote {text}
69 @quotation
70 @strong{Implementor's note:} @emph{\text\}
71 @end quotation
72 @end macro
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
77 @c Info mode.
78 @ifinfo
79 @macro seealso {name}
80 @ref{\name\}.
81 @end macro
82 @end ifinfo
84 @ifnotinfo
85 @alias seealso = ref
86 @end ifnotinfo
88 @c Typeset comments in roman font for the TeX output.
89 @iftex
90 @alias lispcmt = r
91 @end iftex
92 @ifnottex
93 @alias lispcmt = asis
94 @end ifnottex
96 @c My copy of makeinfo is not generating any HTML for @result{} for
97 @c some odd reason. (It certainly used to...)
98 @ifhtml
99 @macro result
101 @end macro
102 @end ifhtml
104 @c Similar macro to @result. Its purpose is to work around the fact
105 @c that ⇒ does not work properly inside @lisp.
106 @ifhtml
107 @macro res
108 @html
109 ⇒
110 @end html
111 @end macro
112 @end ifhtml
114 @ifnothtml
115 @alias res = result
116 @end ifnothtml
118 @c ============================= Macros =============================
121 @c Show types, functions, and concepts in the same index.
122 @syncodeindex tp cp
123 @syncodeindex fn cp
125 @titlepage
126 @title CL-GTK2
127 @subtitle A Common Lisp binding for Gtk+
128 @subtitle GObject
129 @author Dmitry Kalyanov
130 @end titlepage
132 @contents
134 @ifnottex
135 @node Top
136 @top cl-gtk2-gobject
137 @end ifnottex
139 @include gobject.ref.texi
141 @bye