]> Pileus Git - ~andy/gtk/blob - gtk/gtklayout.h
d9743c63efed7f16ebbd0caf8fa2a8e5e458b610
[~andy/gtk] / gtk / gtklayout.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  * GtkLayout: Widget for scrolling of arbitrary-sized areas.
20  *
21  * Copyright Owen Taylor, 1998
22  */
23
24 /*
25  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
26  * file for a list of people on the GTK+ Team.  See the ChangeLog
27  * files for a list of changes.  These files are distributed with
28  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
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 #ifndef __GTK_LAYOUT_H__
36 #define __GTK_LAYOUT_H__
37
38 #include <gdk/gdk.h>
39 #include <gtk/gtkcontainer.h>
40 #include <gtk/gtkadjustment.h>
41
42 G_BEGIN_DECLS
43
44 #define GTK_TYPE_LAYOUT            (gtk_layout_get_type ())
45 #define GTK_LAYOUT(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_LAYOUT, GtkLayout))
46 #define GTK_LAYOUT_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_LAYOUT, GtkLayoutClass))
47 #define GTK_IS_LAYOUT(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_LAYOUT))
48 #define GTK_IS_LAYOUT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_LAYOUT))
49 #define GTK_LAYOUT_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_LAYOUT, GtkLayoutClass))
50
51
52 typedef struct _GtkLayout        GtkLayout;
53 typedef struct _GtkLayoutClass   GtkLayoutClass;
54
55 struct _GtkLayout
56 {
57   GtkContainer GSEAL (container);
58
59   GList *GSEAL (children);
60
61   guint GSEAL (width);
62   guint GSEAL (height);
63
64   GtkAdjustment *GSEAL (hadjustment);
65   GtkAdjustment *GSEAL (vadjustment);
66
67   /*< public >*/
68   GdkWindow *GSEAL (bin_window);
69
70   /*< private >*/
71   GdkVisibilityState GSEAL (visibility);
72   gint GSEAL (scroll_x);
73   gint GSEAL (scroll_y);
74
75   guint GSEAL (freeze_count);
76 };
77
78 struct _GtkLayoutClass
79 {
80   GtkContainerClass parent_class;
81
82   void  (*set_scroll_adjustments)   (GtkLayout      *layout,
83                                      GtkAdjustment  *hadjustment,
84                                      GtkAdjustment  *vadjustment);
85
86   /* Padding for future expansion */
87   void (*_gtk_reserved1) (void);
88   void (*_gtk_reserved2) (void);
89   void (*_gtk_reserved3) (void);
90   void (*_gtk_reserved4) (void);
91 };
92
93 GType          gtk_layout_get_type        (void) G_GNUC_CONST;
94 GtkWidget*     gtk_layout_new             (GtkAdjustment *hadjustment,
95                                            GtkAdjustment *vadjustment);
96 GdkWindow*     gtk_layout_get_bin_window  (GtkLayout     *layout);
97 void           gtk_layout_put             (GtkLayout     *layout,
98                                            GtkWidget     *child_widget,
99                                            gint           x,
100                                            gint           y);
101
102 void           gtk_layout_move            (GtkLayout     *layout,
103                                            GtkWidget     *child_widget,
104                                            gint           x,
105                                            gint           y);
106
107 void           gtk_layout_set_size        (GtkLayout     *layout,
108                                            guint          width,
109                                            guint          height);
110 void           gtk_layout_get_size        (GtkLayout     *layout,
111                                            guint         *width,
112                                            guint         *height);
113
114 GtkAdjustment* gtk_layout_get_hadjustment (GtkLayout     *layout);
115 GtkAdjustment* gtk_layout_get_vadjustment (GtkLayout     *layout);
116 void           gtk_layout_set_hadjustment (GtkLayout     *layout,
117                                            GtkAdjustment *adjustment);
118 void           gtk_layout_set_vadjustment (GtkLayout     *layout,
119                                            GtkAdjustment *adjustment);
120
121
122 #ifndef GTK_DISABLE_DEPRECATED
123 /* These disable and enable moving and repainting the scrolling window
124  * of the GtkLayout, respectively.  If you want to update the layout's
125  * offsets but do not want it to repaint itself, you should use these
126  * functions.
127  *
128  * - I don't understand these are supposed to work, so I suspect
129  * - they don't now.                    OWT 1/20/98
130  */
131 void           gtk_layout_freeze          (GtkLayout     *layout);
132 void           gtk_layout_thaw            (GtkLayout     *layout);
133 #endif /* GTK_DISABLE_DEPRECATED */
134
135 G_END_DECLS
136
137 #endif /* __GTK_LAYOUT_H__ */