]> Pileus Git - ~andy/gtk/blob - gtk/gtkscrolledwindow.h
b05b8aae95dfa212aaf5c0cd2341c0bb89d47c7b
[~andy/gtk] / gtk / gtkscrolledwindow.h
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 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
28 #error "Only <gtk/gtk.h> can be included directly."
29 #endif
30
31 #ifndef __GTK_SCROLLED_WINDOW_H__
32 #define __GTK_SCROLLED_WINDOW_H__
33
34 #include <gtk/gtkbin.h>
35
36 G_BEGIN_DECLS
37
38
39 #define GTK_TYPE_SCROLLED_WINDOW            (gtk_scrolled_window_get_type ())
40 #define GTK_SCROLLED_WINDOW(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_SCROLLED_WINDOW, GtkScrolledWindow))
41 #define GTK_SCROLLED_WINDOW_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_SCROLLED_WINDOW, GtkScrolledWindowClass))
42 #define GTK_IS_SCROLLED_WINDOW(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_SCROLLED_WINDOW))
43 #define GTK_IS_SCROLLED_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_SCROLLED_WINDOW))
44 #define GTK_SCROLLED_WINDOW_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_SCROLLED_WINDOW, GtkScrolledWindowClass))
45
46
47 typedef struct _GtkScrolledWindow              GtkScrolledWindow;
48 typedef struct _GtkScrolledWindowPrivate       GtkScrolledWindowPrivate;
49 typedef struct _GtkScrolledWindowClass         GtkScrolledWindowClass;
50
51 struct _GtkScrolledWindow
52 {
53   GtkBin container;
54
55   GtkScrolledWindowPrivate *priv;
56 };
57
58 struct _GtkScrolledWindowClass
59 {
60   GtkBinClass parent_class;
61
62   gint scrollbar_spacing;
63
64   /* Action signals for keybindings. Do not connect to these signals
65    */
66
67   /* Unfortunately, GtkScrollType is deficient in that there is
68    * no horizontal/vertical variants for GTK_SCROLL_START/END,
69    * so we have to add an additional boolean flag.
70    */
71   gboolean (*scroll_child) (GtkScrolledWindow *scrolled_window,
72                             GtkScrollType      scroll,
73                             gboolean           horizontal);
74
75   void (* move_focus_out) (GtkScrolledWindow *scrolled_window,
76                            GtkDirectionType   direction);
77
78   /* Padding for future expansion */
79   void (*_gtk_reserved1) (void);
80   void (*_gtk_reserved2) (void);
81   void (*_gtk_reserved3) (void);
82   void (*_gtk_reserved4) (void);
83 };
84
85
86 GType          gtk_scrolled_window_get_type          (void) G_GNUC_CONST;
87 GtkWidget*     gtk_scrolled_window_new               (GtkAdjustment     *hadjustment,
88                                                       GtkAdjustment     *vadjustment);
89 void           gtk_scrolled_window_set_hadjustment   (GtkScrolledWindow *scrolled_window,
90                                                       GtkAdjustment     *hadjustment);
91 void           gtk_scrolled_window_set_vadjustment   (GtkScrolledWindow *scrolled_window,
92                                                       GtkAdjustment     *vadjustment);
93 GtkAdjustment* gtk_scrolled_window_get_hadjustment   (GtkScrolledWindow *scrolled_window);
94 GtkAdjustment* gtk_scrolled_window_get_vadjustment   (GtkScrolledWindow *scrolled_window);
95 GtkWidget*     gtk_scrolled_window_get_hscrollbar    (GtkScrolledWindow *scrolled_window);
96 GtkWidget*     gtk_scrolled_window_get_vscrollbar    (GtkScrolledWindow *scrolled_window);
97 void           gtk_scrolled_window_set_policy        (GtkScrolledWindow *scrolled_window,
98                                                       GtkPolicyType      hscrollbar_policy,
99                                                       GtkPolicyType      vscrollbar_policy);
100 void           gtk_scrolled_window_get_policy        (GtkScrolledWindow *scrolled_window,
101                                                       GtkPolicyType     *hscrollbar_policy,
102                                                       GtkPolicyType     *vscrollbar_policy);
103 void           gtk_scrolled_window_set_placement     (GtkScrolledWindow *scrolled_window,
104                                                       GtkCornerType      window_placement);
105 void           gtk_scrolled_window_unset_placement   (GtkScrolledWindow *scrolled_window);
106
107 GtkCornerType  gtk_scrolled_window_get_placement     (GtkScrolledWindow *scrolled_window);
108 void           gtk_scrolled_window_set_shadow_type   (GtkScrolledWindow *scrolled_window,
109                                                       GtkShadowType      type);
110 GtkShadowType  gtk_scrolled_window_get_shadow_type   (GtkScrolledWindow *scrolled_window);
111 void           gtk_scrolled_window_add_with_viewport (GtkScrolledWindow *scrolled_window,
112                                                       GtkWidget         *child);
113
114 gint           gtk_scrolled_window_get_min_content_width  (GtkScrolledWindow *scrolled_window);
115 void           gtk_scrolled_window_set_min_content_width  (GtkScrolledWindow *scrolled_window,
116                                                            gint               width);
117 gint           gtk_scrolled_window_get_min_content_height (GtkScrolledWindow *scrolled_window);
118 void           gtk_scrolled_window_set_min_content_height (GtkScrolledWindow *scrolled_window,
119                                                            gint               height);
120
121 gint _gtk_scrolled_window_get_scrollbar_spacing (GtkScrolledWindow *scrolled_window);
122
123
124 G_END_DECLS
125
126
127 #endif /* __GTK_SCROLLED_WINDOW_H__ */