1
2@c %start of fragment
3
4@deftp Class <gtk-layout>
5Derives from @code{<gtk-container>}.
6
7This class defines the following slots:
8
9@table @code
10@item hadjustment
11The GtkAdjustment for the horizontal position
12
13@item vadjustment
14The GtkAdjustment for the vertical position
15
16@item width
17The width of the layout
18
19@item height
20The height of the layout
21
22@end table
23
24@end deftp
25
26@defop Signal <gtk-layout> set-scroll-adjustments  (arg0@tie{}@code{<gtk-adjustment>}) (arg1@tie{}@code{<gtk-adjustment>})
27@end defop
28
29@deffn Function gtk-layout-new  (hadjustment@tie{}@code{<gtk-adjustment>}) (vadjustment@tie{}@code{<gtk-adjustment>}) @result{}@tie{} (ret@tie{}@code{<gtk-widget>})
30Creates a new @code{<gtk-layout>}. Unless you have a specific adjustment you'd
31like the layout to use for scrolling, pass @samp{@code{#f}} for
32@var{hadjustment} and @var{vadjustment}.
33
34@table @var
35@item hadjustment
36horizontal scroll adjustment, or @samp{@code{#f}}
37
38@item vadjustment
39vertical scroll adjustment, or @samp{@code{#f}}
40
41@item ret
42a new @code{<gtk-layout>}
43
44@end table
45
46@end deffn
47
48@deffn Function gtk-layout-put  (self@tie{}@code{<gtk-layout>}) (child_widget@tie{}@code{<gtk-widget>}) (x@tie{}@code{int}) (y@tie{}@code{int})
49@deffnx Method put
50Adds @var{child-widget} to @var{layout}, at position (@var{x},@var{y}).
51@var{layout} becomes the new parent container of @var{child-widget}.
52
53@table @var
54@item layout
55a @code{<gtk-layout>}
56
57@item child-widget
58child widget
59
60@item x
61X position of child widget
62
63@item y
64Y position of child widget
65
66@end table
67
68@end deffn
69
70@deffn Function gtk-layout-move  (self@tie{}@code{<gtk-layout>}) (child_widget@tie{}@code{<gtk-widget>}) (x@tie{}@code{int}) (y@tie{}@code{int})
71@deffnx Method move
72Moves a current child of @var{layout} to a new position.
73
74@table @var
75@item layout
76a @code{<gtk-layout>}
77
78@item child-widget
79a current child of @var{layout}
80
81@item x
82X position to move to
83
84@item y
85Y position to move to
86
87@end table
88
89@end deffn
90
91@deffn Function gtk-layout-set-size  (self@tie{}@code{<gtk-layout>}) (width@tie{}@code{unsigned-int}) (height@tie{}@code{unsigned-int})
92@deffnx Method set-size
93Sets the size of the scrollable area of the layout.
94
95@table @var
96@item layout
97a @code{<gtk-layout>}
98
99@item width
100width of entire scrollable area
101
102@item height
103height of entire scrollable area
104
105@end table
106
107@end deffn
108
109@deffn Function gtk-layout-get-size  (self@tie{}@code{<gtk-layout>}) @result{}@tie{} (width@tie{}@code{unsigned-int}) (height@tie{}@code{unsigned-int})
110@deffnx Method get-size
111Gets the size that has been set on the layout, and that determines the total
112extents of the layout's scrollbar area. See @code{gtk-layout-set-size}.
113
114@table @var
115@item layout
116a @code{<gtk-layout>}
117
118@item width
119location to store the width set on @var{layout}, or @samp{@code{#f}}
120
121@item height
122location to store the height set on @var{layout}, or @samp{@code{#f}}
123
124@end table
125
126@end deffn
127
128@deffn Function gtk-layout-get-hadjustment  (self@tie{}@code{<gtk-layout>}) @result{}@tie{} (ret@tie{}@code{<gtk-adjustment>})
129@deffnx Method get-hadjustment
130This function should only be called after the layout has been placed in a
131@code{<gtk-scrolled-window>} or otherwise configured for scrolling. It returns
132the @code{<gtk-adjustment>} used for communication between the horizontal
133scrollbar and @var{layout}.
134
135See @code{<gtk-scrolled-window>}, @code{<gtk-scrollbar>},
136@code{<gtk-adjustment>} for details.
137
138@table @var
139@item layout
140a @code{<gtk-layout>}
141
142@item ret
143horizontal scroll adjustment
144
145@end table
146
147@end deffn
148
149@deffn Function gtk-layout-get-vadjustment  (self@tie{}@code{<gtk-layout>}) @result{}@tie{} (ret@tie{}@code{<gtk-adjustment>})
150@deffnx Method get-vadjustment
151This function should only be called after the layout has been placed in a
152@code{<gtk-scrolled-window>} or otherwise configured for scrolling. It returns
153the @code{<gtk-adjustment>} used for communication between the vertical
154scrollbar and @var{layout}.
155
156See @code{<gtk-scrolled-window>}, @code{<gtk-scrollbar>},
157@code{<gtk-adjustment>} for details.
158
159@table @var
160@item layout
161a @code{<gtk-layout>}
162
163@item ret
164vertical scroll adjustment
165
166@end table
167
168@end deffn
169
170@deffn Function gtk-layout-set-hadjustment  (self@tie{}@code{<gtk-layout>}) (adjustment@tie{}@code{<gtk-adjustment>})
171@deffnx Method set-hadjustment
172Sets the horizontal scroll adjustment for the layout.
173
174See @code{<gtk-scrolled-window>}, @code{<gtk-scrollbar>},
175@code{<gtk-adjustment>} for details.
176
177@table @var
178@item layout
179a @code{<gtk-layout>}
180
181@item adjustment
182new scroll adjustment
183
184@end table
185
186@end deffn
187
188@deffn Function gtk-layout-set-vadjustment  (self@tie{}@code{<gtk-layout>}) (adjustment@tie{}@code{<gtk-adjustment>})
189@deffnx Method set-vadjustment
190Sets the vertical scroll adjustment for the layout.
191
192See @code{<gtk-scrolled-window>}, @code{<gtk-scrollbar>},
193@code{<gtk-adjustment>} for details.
194
195@table @var
196@item layout
197a @code{<gtk-layout>}
198
199@item adjustment
200new scroll adjustment
201
202@end table
203
204@end deffn
205
206
207@c %end of fragment
208