1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
|
-----------------------------------------------------------------------
-- GtkAda - Ada95 binding for Gtk+/Gnome --
-- --
-- Copyright (C) 1998-2000 E. Briot, J. Brobecker and A. Charlet --
-- Copyright (C) 2000-2006 AdaCore --
-- --
-- This library is free software; you can redistribute it and/or --
-- modify it under the terms of the GNU General Public --
-- License as published by the Free Software Foundation; either --
-- version 2 of the License, or (at your option) any later version. --
-- --
-- This library is distributed in the hope that it will be useful, --
-- but WITHOUT ANY WARRANTY; without even the implied warranty of --
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU --
-- General Public License for more details. --
-- --
-- You should have received a copy of the GNU General Public --
-- License along with this library; if not, write to the --
-- Free Software Foundation, Inc., 59 Temple Place - Suite 330, --
-- Boston, MA 02111-1307, USA. --
-- --
-----------------------------------------------------------------------
-- <description>
--
-- Gtk_Scrolled_Window is a Gtk_Bin child: it's a container the accepts a
-- single child widget. Gtk_Scrolled_Window adds scrollbars to the child
-- widget.
--
-- The scrolled window can work in two ways. Some widgets have native
-- scrolling support; these widgets have "slots" for Gtk_Adjustment objects.
-- The scrolled window installs Gtk_Adjustment objects in the child window's
-- slots using the "set_scroll_adjustments" signal (Conceptually, these
-- widgets implement a "Scrollable" interface).
--
-- The second way to use the scrolled window is useful with widgets that lack
-- the "set_scroll_adjustments" signal. The Gtk_Viewport widget acts as a
-- proxy, implementing scrollability for child widgets that lack their own
-- scrolling capabilities.
--
-- If a widget has native scrolling abilities, it can be added to the
-- Gtk_Scrolled_Window with Gtk.Container.Add. If a widget does not, you must
-- first add the widget to a Gtk_Viewport, then add the Gtk_Viewport to the
-- scrolled window. The convenience function Add_With_Viewport does exactly
-- this, so you can ignore the presence of the viewport.
--
-- If you want to create your own new widget type that can be inserted
-- directly into a scrolled_window, you need to specify a signal for
-- Set_Scroll_Adjustments in the call to Gtk.Object.Initialize_Class_Record.
--
-- </description>
-- <c_version>2.8.17</c_version>
-- <group>Scrolling</group>
-- <testgtk>create_scrolled.adb</testgtk>
-- <screenshot>gtk-scrolled_window</screenshot>
with Glib.Properties;
with Gtk.Adjustment; use Gtk.Adjustment;
with Gtk.Bin;
with Gtk.Enums;
with Gtk.Scrollbar;
with Gtk.Widget;
package Gtk.Scrolled_Window is
type Gtk_Scrolled_Window_Record is new Bin.Gtk_Bin_Record with private;
type Gtk_Scrolled_Window is access all Gtk_Scrolled_Window_Record'Class;
procedure Gtk_New
(Scrolled_Window : out Gtk_Scrolled_Window;
Hadjustment : Gtk_Adjustment := null;
Vadjustment : Gtk_Adjustment := null);
-- Create a new scrolled window.
-- The two arguments are the scrolled window's horizontal and vertical
-- adjustments; these will be shared with the scrollbars and the child
-- widget to keep the bars in sync with the child. Usually you want to use
-- the default value Null_Adjustment for the adjustments, which will cause
-- the scrolled window to create them for you.
procedure Initialize
(Scrolled_Window : access Gtk_Scrolled_Window_Record'Class;
Hadjustment : Gtk_Adjustment := null;
Vadjustment : Gtk_Adjustment := null);
-- Internal initialization function.
-- See the section "Creating your own widgets" in the documentation.
function Get_Type return Gtk.Gtk_Type;
-- Return the internal value associated with a Gtk_Scrolled_Window.
procedure Set_Hadjustment
(Scrolled_Window : access Gtk_Scrolled_Window_Record;
Hadjustment : Gtk_Adjustment);
function Get_Hadjustment
(Scrolled_Window : access Gtk_Scrolled_Window_Record)
return Gtk_Adjustment;
-- Set the Gtk_Adjustment for the horizontal scrollbar.
-- This adjustment is used to connect the horizontal scrollbar to the child
-- widget's horizontal scroll functionality.
procedure Set_Vadjustment
(Scrolled_Window : access Gtk_Scrolled_Window_Record;
Vadjustment : Gtk_Adjustment);
function Get_Vadjustment
(Scrolled_Window : access Gtk_Scrolled_Window_Record)
return Gtk_Adjustment;
-- Set the Gtk_Adjustment for the vertical scrollbar.
-- This adjustment is used to connect the vertical scrollbar to the child
-- widget's vertical scroll functionality.
function Get_Hscrollbar
(Scrolled_Window : access Gtk_Scrolled_Window_Record)
return Gtk.Scrollbar.Gtk_Scrollbar;
-- Returns the horizontal scrollbar, or null if it doesn't have one.
function Get_Vscrollbar
(Scrolled_Window : access Gtk_Scrolled_Window_Record)
return Gtk.Scrollbar.Gtk_Scrollbar;
-- Returns the vertical scrollbar, or null if it doesn't have one.
procedure Set_Policy
(Scrolled_Window : access Gtk_Scrolled_Window_Record;
H_Scrollbar_Policy : Enums.Gtk_Policy_Type;
V_Scrollbar_Policy : Enums.Gtk_Policy_Type);
procedure Get_Policy
(Scrolled_Window : access Gtk_Scrolled_Window_Record;
H_Scrollbar_Policy : out Enums.Gtk_Policy_Type;
V_Scrollbar_Policy : out Enums.Gtk_Policy_Type);
-- Set the scrollbar policy for the horizontal and vertical scrollbars.
-- It determines when the scrollbar should appear; it is a value
-- from the Gtk_Policy_Type enumeration. If Policy_Always, the scrollbar is
-- always present; if Policy_Never, the scrollbar is never present; if
-- Policy_Automatic, the scrollbar is present only if needed (that is, if
-- the slider part of the bar would be smaller than the trough - the
-- display is larger than the page size).
procedure Set_Placement
(Scrolled_Window : access Gtk_Scrolled_Window_Record;
Window_Placement : Gtk.Enums.Gtk_Corner_Type);
function Get_Placement
(Scrolled_Window : access Gtk_Scrolled_Window_Record)
return Gtk.Enums.Gtk_Corner_Type;
-- Determine or return the location of the widget with respect to the
-- scrollbars. The default is Corner_Top_Left.
procedure Set_Shadow_Type
(Scrolled_Window : access Gtk_Scrolled_Window_Record;
Shadow_Type : Gtk.Enums.Gtk_Shadow_Type);
function Get_Shadow_Type
(Scrolled_Window : access Gtk_Scrolled_Window_Record)
return Gtk.Enums.Gtk_Shadow_Type;
-- Change the type of shadow drawn around the contents of Scrolled_Window.
procedure Add_With_Viewport
(Scrolled_Window : access Gtk_Scrolled_Window_Record;
Child : access Gtk.Widget.Gtk_Widget_Record'Class);
-- Used to add children without native scrolling capabilities.
-- This is simply a convenience function; it is equivalent to adding the
-- unscrollable child to a viewport, then adding the viewport to the
-- scrolled window. If a child has native scrolling, use Gtk.Container.Add
-- instead of this function.
--
-- The viewport scrolls the child by moving its Gdk_Window, and takes the
-- size of the child to be the size of its toplevel Gdk_Window. This will
-- be very wrong for most widgets that support native scrolling; for
-- example, if you add a Gtk_Clist with a viewport, the whole widget will
-- scroll, including the column headings. Thus Gtk_Clist supports scrolling
-- already, and should not be used with the GtkViewport proxy.
--
-- A widget supports scrolling natively if it contains a valid
-- "set_scroll_adjustments" signal.
----------------
-- Properties --
----------------
-- The following properties are defined for this widget. See
-- Glib.Properties for more information on properties.
-- <properties>
-- Name: Hadjustment_Property
-- Type: Object
-- Descr: The GtkAdjustment for the horizontal position
--
-- Name: Hscrollbar_Policy_Property
-- Type: Enum
-- Descr: When the horizontal scrollbar is displayed
--
-- Name: Shadow_Type_Property
-- Type: Enum
-- Descr: Style of bevel around the contents
--
-- Name: Vadjustment_Property
-- Type: Object
-- Descr: The GtkAdjustment for the vertical position
--
-- Name: Vscrollbar_Policy_Property
-- Type: Enum
-- Descr: When the vertical scrollbar is displayed
--
-- Name: Window_Placement_Property
-- Type: Enum
-- Descr: Where the contents are located with respect to the scrollbars
-- </properties>
Hadjustment_Property : constant Glib.Properties.Property_Object;
Hscrollbar_Policy_Property : constant Gtk.Enums.Property_Gtk_Policy_Type;
Shadow_Type_Property : constant Gtk.Enums.Property_Gtk_Shadow_Type;
Vadjustment_Property : constant Glib.Properties.Property_Object;
Vscrollbar_Policy_Property : constant Gtk.Enums.Property_Gtk_Policy_Type;
Window_Placement_Property : constant Gtk.Enums.Property_Gtk_Shadow_Type;
----------------------
-- Style Properties --
----------------------
-- The following properties can be changed through the gtk theme and
-- configuration files, and retrieved through Gtk.Widget.Style_Get_Property
-- <style_properties>
-- Name: Scrollbar_Spacing_Property
-- Type: Int
-- Descr: Number of pixels between the scrollbars and the scrolled window
-- </style_properties>
Scrollbar_Spacing_Property : constant Glib.Properties.Property_Int;
-------------
-- Signals --
-------------
-- <signals>
-- The following new signals are defined for this widget:
--
-- - "scroll_child"
-- procedure Handler
-- (Window : access Gtk_Scrolled_Window_Record'Class;
-- Typ : Gtk_Scroll_Type;
-- Horizontal : Gboolean);
-- You should emit this signal to request a scrolling of the child. This
-- signal is almost never needed directly, unless you connect it to a
-- key binding.
-- The boolean is used to further qualify Scroll_Start and Scroll_End,
-- which do not have horizontal and vertical variants.
--
-- - "move_focus_out"
-- procedure Handler
-- (Window : access Gtk_Scrolled_Window_Record'Class;
-- Direction : Gtk_Direction_Type);
-- Request that the keyboard focus be moved. You almost never have to
-- emit this signal yourself, unless you are binding it to a key for
-- user interaction. You do not need to connect to this signal
-- </signals>
Signal_Move_Focus_Out : constant String := "move_focus_out";
Signal_Scroll_Child : constant String := "scroll_child";
private
type Gtk_Scrolled_Window_Record is new Bin.Gtk_Bin_Record with null record;
Hadjustment_Property : constant Glib.Properties.Property_Object :=
Glib.Properties.Build ("hadjustment");
Hscrollbar_Policy_Property : constant Gtk.Enums.Property_Gtk_Policy_Type :=
Gtk.Enums.Build ("hscrollbar-policy");
Shadow_Type_Property : constant Gtk.Enums.Property_Gtk_Shadow_Type :=
Gtk.Enums.Build ("shadow-type");
Vadjustment_Property : constant Glib.Properties.Property_Object :=
Glib.Properties.Build ("vadjustment");
Vscrollbar_Policy_Property : constant Gtk.Enums.Property_Gtk_Policy_Type :=
Gtk.Enums.Build ("vscrollbar-policy");
Window_Placement_Property : constant Gtk.Enums.Property_Gtk_Shadow_Type :=
Gtk.Enums.Build ("window-placement");
Scrollbar_Spacing_Property : constant Glib.Properties.Property_Int :=
Glib.Properties.Build ("scrollbar-spacing");
pragma Import (C, Get_Type, "gtk_scrolled_window_get_type");
end Gtk.Scrolled_Window;
|
