]> Pileus Git - ~andy/gtk/blob - gtk/gtksizegroup.h
gtksizegroup: Move public members to private structure
[~andy/gtk] / gtk / gtksizegroup.h
1 /* GTK - The GIMP Toolkit
2  * gtksizegroup.h:
3  * Copyright (C) 2000 Red Hat Software
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the
17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18  * Boston, MA 02111-1307, USA.
19  */
20
21 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
22 #error "Only <gtk/gtk.h> can be included directly."
23 #endif
24
25 #ifndef __GTK_SIZE_GROUP_H__
26 #define __GTK_SIZE_GROUP_H__
27
28 #include <gtk/gtkwidget.h>
29
30 G_BEGIN_DECLS
31
32 #define GTK_TYPE_SIZE_GROUP            (gtk_size_group_get_type ())
33 #define GTK_SIZE_GROUP(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_SIZE_GROUP, GtkSizeGroup))
34 #define GTK_SIZE_GROUP_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_SIZE_GROUP, GtkSizeGroupClass))
35 #define GTK_IS_SIZE_GROUP(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_SIZE_GROUP))
36 #define GTK_IS_SIZE_GROUP_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_SIZE_GROUP))
37 #define GTK_SIZE_GROUP_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_SIZE_GROUP, GtkSizeGroupClass))
38
39
40 typedef struct _GtkSizeGroup       GtkSizeGroup;
41 typedef struct _GtkSizeGroupPriv   GtkSizeGroupPriv;
42 typedef struct _GtkSizeGroupClass  GtkSizeGroupClass;
43
44 struct _GtkSizeGroup
45 {
46   GObject parent_instance;
47
48   /* <private> */
49   GtkSizeGroupPriv *priv;
50 };
51
52 struct _GtkSizeGroupClass
53 {
54   GObjectClass parent_class;
55
56   /* Padding for future expansion */
57   void (*_gtk_reserved1) (void);
58   void (*_gtk_reserved2) (void);
59   void (*_gtk_reserved3) (void);
60   void (*_gtk_reserved4) (void);
61 };
62
63 /**
64  * GtkSizeGroupMode:
65  * @GTK_SIZE_GROUP_NONE: group has no effect
66  * @GTK_SIZE_GROUP_HORIZONTAL: group affects horizontal requisition
67  * @GTK_SIZE_GROUP_VERTICAL: group affects vertical requisition
68  * @GTK_SIZE_GROUP_BOTH: group affects both horizontal and vertical requisition
69  *
70  * The mode of the size group determines the directions in which the size
71  * group affects the requested sizes of its component widgets.
72  **/
73 typedef enum {
74   GTK_SIZE_GROUP_NONE,
75   GTK_SIZE_GROUP_HORIZONTAL,
76   GTK_SIZE_GROUP_VERTICAL,
77   GTK_SIZE_GROUP_BOTH
78 } GtkSizeGroupMode;
79
80 GType            gtk_size_group_get_type      (void) G_GNUC_CONST;
81
82 GtkSizeGroup *   gtk_size_group_new           (GtkSizeGroupMode  mode);
83 void             gtk_size_group_set_mode      (GtkSizeGroup     *size_group,
84                                                GtkSizeGroupMode  mode);
85 GtkSizeGroupMode gtk_size_group_get_mode      (GtkSizeGroup     *size_group);
86 void             gtk_size_group_set_ignore_hidden (GtkSizeGroup *size_group,
87                                                    gboolean      ignore_hidden);
88 gboolean         gtk_size_group_get_ignore_hidden (GtkSizeGroup *size_group);
89 void             gtk_size_group_add_widget    (GtkSizeGroup     *size_group,
90                                                GtkWidget        *widget);
91 void             gtk_size_group_remove_widget (GtkSizeGroup     *size_group,
92                                                GtkWidget        *widget);
93 GSList *         gtk_size_group_get_widgets   (GtkSizeGroup     *size_group);
94
95
96
97 gint _gtk_size_group_bump_requisition      (GtkWidget        *widget,
98                                             GtkSizeGroupMode  mode,
99                                             gint              widget_requisition);
100 void _gtk_size_group_queue_resize          (GtkWidget        *widget);
101
102
103 G_END_DECLS
104
105 #endif /* __GTK_SIZE_GROUP_H__ */