]> Pileus Git - ~andy/gtk/blob - gtk/gtksizegroup.h
Add gtk_size_group_get_widgets, fixes #326324. Also mark all fields of
[~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 #ifndef __GTK_SIZE_GROUP_H__
22 #define __GTK_SIZE_GROUP_H__
23
24 #include <gtk/gtkwidget.h>
25
26 G_BEGIN_DECLS
27
28 #define GTK_TYPE_SIZE_GROUP            (gtk_size_group_get_type ())
29 #define GTK_SIZE_GROUP(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_SIZE_GROUP, GtkSizeGroup))
30 #define GTK_SIZE_GROUP_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_SIZE_GROUP, GtkSizeGroupClass))
31 #define GTK_IS_SIZE_GROUP(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_SIZE_GROUP))
32 #define GTK_IS_SIZE_GROUP_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_SIZE_GROUP))
33 #define GTK_SIZE_GROUP_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_SIZE_GROUP, GtkSizeGroupClass))
34
35
36 typedef struct _GtkSizeGroup       GtkSizeGroup;
37 typedef struct _GtkSizeGroupClass  GtkSizeGroupClass;
38
39 struct _GtkSizeGroup
40 {
41   GObject parent_instance;
42
43   /* <private> */
44   GSList *widgets;
45
46   guint8 mode;
47   
48   guint have_width : 1;
49   guint have_height : 1;
50   guint ignore_hidden : 1;
51
52   GtkRequisition requisition;
53 };
54
55 struct _GtkSizeGroupClass
56 {
57   GObjectClass parent_class;
58
59   /* Padding for future expansion */
60   void (*_gtk_reserved1) (void);
61   void (*_gtk_reserved2) (void);
62   void (*_gtk_reserved3) (void);
63   void (*_gtk_reserved4) (void);
64 };
65
66 /**
67  * GtkSizeGroupMode:
68  * @GTK_SIZE_GROUP_NONE: group has no effect  
69  * @GTK_SIZE_GROUP_HORIZONTAL: group affects horizontal requisition
70  * @GTK_SIZE_GROUP_VERTICAL: group affects vertical requisition
71  * @GTK_SIZE_GROUP_BOTH: group affects both horizontal and vertical requisition
72  * 
73  * The mode of the size group determines the directions in which the size
74  * group affects the requested sizes of its component widgets.
75  **/
76 typedef enum {
77   GTK_SIZE_GROUP_NONE,
78   GTK_SIZE_GROUP_HORIZONTAL,
79   GTK_SIZE_GROUP_VERTICAL,
80   GTK_SIZE_GROUP_BOTH
81 } GtkSizeGroupMode;
82
83 GType            gtk_size_group_get_type      (void) G_GNUC_CONST;
84
85 GtkSizeGroup *   gtk_size_group_new           (GtkSizeGroupMode  mode);
86 void             gtk_size_group_set_mode      (GtkSizeGroup     *size_group,
87                                                GtkSizeGroupMode  mode);
88 GtkSizeGroupMode gtk_size_group_get_mode      (GtkSizeGroup     *size_group);
89 void             gtk_size_group_set_ignore_hidden (GtkSizeGroup *size_group,
90                                                    gboolean      ignore_hidden);
91 gboolean         gtk_size_group_get_ignore_hidden (GtkSizeGroup *size_group);
92 void             gtk_size_group_add_widget    (GtkSizeGroup     *size_group,
93                                                GtkWidget        *widget);
94 void             gtk_size_group_remove_widget (GtkSizeGroup     *size_group,
95                                                GtkWidget        *widget);
96 GSList *         gtk_size_group_get_widgets   (GtkSizeGroup     *size_group);
97
98
99 void _gtk_size_group_get_child_requisition (GtkWidget      *widget,
100                                             GtkRequisition *requisition);
101 void _gtk_size_group_compute_requisition   (GtkWidget      *widget,
102                                             GtkRequisition *requisition);
103 void _gtk_size_group_queue_resize          (GtkWidget      *widget);
104
105 G_END_DECLS
106
107 #endif /* __GTK_SIZE_GROUP_H__ */