1/* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
18 */
19
20/*
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
25 */
26
27#ifndef __GTK_SCROLLED_WINDOW_H__
28#define __GTK_SCROLLED_WINDOW_H__
29
30
31#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
32#error "Only <gtk/gtk.h> can be included directly."
33#endif
34
35#include <gtk/gtkhscrollbar.h>
36#include <gtk/gtkvscrollbar.h>
37#include <gtk/gtkviewport.h>
38
39
40G_BEGIN_DECLS
41
42
43#define GTK_TYPE_SCROLLED_WINDOW (gtk_scrolled_window_get_type ())
44#define GTK_SCROLLED_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_SCROLLED_WINDOW, GtkScrolledWindow))
45#define GTK_SCROLLED_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_SCROLLED_WINDOW, GtkScrolledWindowClass))
46#define GTK_IS_SCROLLED_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_SCROLLED_WINDOW))
47#define GTK_IS_SCROLLED_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_SCROLLED_WINDOW))
48#define GTK_SCROLLED_WINDOW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_SCROLLED_WINDOW, GtkScrolledWindowClass))
49
50
51
52typedef struct _GtkScrolledWindow GtkScrolledWindow;
53typedef struct _GtkScrolledWindowClass GtkScrolledWindowClass;
54
55struct _GtkScrolledWindow
56{
57 GtkBin container;
58
59 /*< public >*/
60 GtkWidget *GSEAL (hscrollbar);
61 GtkWidget *GSEAL (vscrollbar);
62
63 /*< private >*/
64 guint GSEAL (hscrollbar_policy) : 2;
65 guint GSEAL (vscrollbar_policy) : 2;
66 guint GSEAL (hscrollbar_visible) : 1;
67 guint GSEAL (vscrollbar_visible) : 1;
68 guint GSEAL (window_placement) : 2;
69 guint GSEAL (focus_out) : 1; /* Flag used by ::move-focus-out implementation */
70
71 guint16 GSEAL (shadow_type);
72};
73
74struct _GtkScrolledWindowClass
75{
76 GtkBinClass parent_class;
77
78 gint scrollbar_spacing;
79
80 /* Action signals for keybindings. Do not connect to these signals
81 */
82
83 /* Unfortunately, GtkScrollType is deficient in that there is
84 * no horizontal/vertical variants for GTK_SCROLL_START/END,
85 * so we have to add an additional boolean flag.
86 */
87 gboolean (*scroll_child) (GtkScrolledWindow *scrolled_window,
88 GtkScrollType scroll,
89 gboolean horizontal);
90
91 void (* move_focus_out) (GtkScrolledWindow *scrolled_window,
92 GtkDirectionType direction);
93
94 /* Padding for future expansion */
95 void (*_gtk_reserved1) (void);
96 void (*_gtk_reserved2) (void);
97 void (*_gtk_reserved3) (void);
98 void (*_gtk_reserved4) (void);
99};
100
101
102GType gtk_scrolled_window_get_type (void) G_GNUC_CONST;
103GtkWidget* gtk_scrolled_window_new (GtkAdjustment *hadjustment,
104 GtkAdjustment *vadjustment);
105void gtk_scrolled_window_set_hadjustment (GtkScrolledWindow *scrolled_window,
106 GtkAdjustment *hadjustment);
107void gtk_scrolled_window_set_vadjustment (GtkScrolledWindow *scrolled_window,
108 GtkAdjustment *vadjustment);
109GtkAdjustment* gtk_scrolled_window_get_hadjustment (GtkScrolledWindow *scrolled_window);
110GtkAdjustment* gtk_scrolled_window_get_vadjustment (GtkScrolledWindow *scrolled_window);
111GtkWidget* gtk_scrolled_window_get_hscrollbar (GtkScrolledWindow *scrolled_window);
112GtkWidget* gtk_scrolled_window_get_vscrollbar (GtkScrolledWindow *scrolled_window);
113void gtk_scrolled_window_set_policy (GtkScrolledWindow *scrolled_window,
114 GtkPolicyType hscrollbar_policy,
115 GtkPolicyType vscrollbar_policy);
116void gtk_scrolled_window_get_policy (GtkScrolledWindow *scrolled_window,
117 GtkPolicyType *hscrollbar_policy,
118 GtkPolicyType *vscrollbar_policy);
119void gtk_scrolled_window_set_placement (GtkScrolledWindow *scrolled_window,
120 GtkCornerType window_placement);
121void gtk_scrolled_window_unset_placement (GtkScrolledWindow *scrolled_window);
122
123GtkCornerType gtk_scrolled_window_get_placement (GtkScrolledWindow *scrolled_window);
124void gtk_scrolled_window_set_shadow_type (GtkScrolledWindow *scrolled_window,
125 GtkShadowType type);
126GtkShadowType gtk_scrolled_window_get_shadow_type (GtkScrolledWindow *scrolled_window);
127void gtk_scrolled_window_add_with_viewport (GtkScrolledWindow *scrolled_window,
128 GtkWidget *child);
129
130gint _gtk_scrolled_window_get_scrollbar_spacing (GtkScrolledWindow *scrolled_window);
131
132
133G_END_DECLS
134
135
136#endif /* __GTK_SCROLLED_WINDOW_H__ */
137