1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::Buildable;
use crate::SizeGroupMode;
use crate::Widget;
use glib::object::IsA;
use glib::object::ObjectType as ObjectType_;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use std::boxed::Box as Box_;
use std::fmt;
use std::mem::transmute;

glib::wrapper! {
    /// [`SizeGroup`][crate::SizeGroup] groups widgets together so they all request the same size.
    ///
    /// This is typically useful when you want a column of widgets to have the
    /// same size, but you can’t use a [`Grid`][crate::Grid].
    ///
    /// In detail, the size requested for each widget in a [`SizeGroup`][crate::SizeGroup] is
    /// the maximum of the sizes that would have been requested for each
    /// widget in the size group if they were not in the size group. The mode
    /// of the size group (see [`set_mode()`][Self::set_mode()]) determines whether
    /// this applies to the horizontal size, the vertical size, or both sizes.
    ///
    /// Note that size groups only affect the amount of space requested, not
    /// the size that the widgets finally receive. If you want the widgets in
    /// a [`SizeGroup`][crate::SizeGroup] to actually be the same size, you need to pack them in
    /// such a way that they get the size they request and not more.
    ///
    /// [`SizeGroup`][crate::SizeGroup] objects are referenced by each widget in the size group,
    /// so once you have added all widgets to a [`SizeGroup`][crate::SizeGroup], you can drop
    /// the initial reference to the size group with g_object_unref(). If the
    /// widgets in the size group are subsequently destroyed, then they will
    /// be removed from the size group and drop their references on the size
    /// group; when all widgets have been removed, the size group will be
    /// freed.
    ///
    /// Widgets can be part of multiple size groups; GTK will compute the
    /// horizontal size of a widget from the horizontal requisition of all
    /// widgets that can be reached from the widget by a chain of size groups
    /// of type [`SizeGroupMode::Horizontal`][crate::SizeGroupMode::Horizontal] or [`SizeGroupMode::Both`][crate::SizeGroupMode::Both], and the
    /// vertical size from the vertical requisition of all widgets that can be
    /// reached from the widget by a chain of size groups of type
    /// [`SizeGroupMode::Vertical`][crate::SizeGroupMode::Vertical] or [`SizeGroupMode::Both`][crate::SizeGroupMode::Both].
    ///
    /// Note that only non-contextual sizes of every widget are ever consulted
    /// by size groups (since size groups have no knowledge of what size a widget
    /// will be allocated in one dimension, it cannot derive how much height
    /// a widget will receive for a given width). When grouping widgets that
    /// trade height for width in mode [`SizeGroupMode::Vertical`][crate::SizeGroupMode::Vertical] or [`SizeGroupMode::Both`][crate::SizeGroupMode::Both]:
    /// the height for the minimum width will be the requested height for all
    /// widgets in the group. The same is of course true when horizontally grouping
    /// width for height widgets.
    ///
    /// Widgets that trade height-for-width should set a reasonably large minimum
    /// width by way of `property::Label::width-chars` for instance. Widgets with
    /// static sizes as well as widgets that grow (such as ellipsizing text) need no
    /// such considerations.
    ///
    /// # GtkSizeGroup as GtkBuildable
    ///
    /// Size groups can be specified in a UI definition by placing an <object>
    /// element with `class="GtkSizeGroup"` somewhere in the UI definition. The
    /// widgets that belong to the size group are specified by a <widgets> element
    /// that may contain multiple <widget> elements, one for each member of the
    /// size group. The ”name” attribute gives the id of the widget.
    ///
    /// An example of a UI definition fragment with [`SizeGroup`][crate::SizeGroup]:
    /// ```xml
    /// <object class="GtkSizeGroup">
    ///   <property name="mode">horizontal</property>
    ///   <widgets>
    ///     <widget name="radio1"/>
    ///     <widget name="radio2"/>
    ///   </widgets>
    /// </object>
    /// ```
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`], [`BuildableExt`][trait@crate::prelude::BuildableExt]
    #[doc(alias = "GtkSizeGroup")]
    pub struct SizeGroup(Object<ffi::GtkSizeGroup>) @implements Buildable;

    match fn {
        type_ => || ffi::gtk_size_group_get_type(),
    }
}

impl SizeGroup {
    /// Create a new [`SizeGroup`][crate::SizeGroup].
    /// ## `mode`
    /// the mode for the new size group.
    ///
    /// # Returns
    ///
    /// a newly created [`SizeGroup`][crate::SizeGroup]
    #[doc(alias = "gtk_size_group_new")]
    pub fn new(mode: SizeGroupMode) -> SizeGroup {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gtk_size_group_new(mode.into_glib())) }
    }

    /// Adds a widget to a [`SizeGroup`][crate::SizeGroup].
    ///
    /// In the future, the requisition
    /// of the widget will be determined as the maximum of its requisition
    /// and the requisition of the other widgets in the size group.
    /// Whether this applies horizontally, vertically, or in both directions
    /// depends on the mode of the size group.
    /// See [`set_mode()`][Self::set_mode()].
    ///
    /// When the widget is destroyed or no longer referenced elsewhere, it
    /// will be removed from the size group.
    /// ## `widget`
    /// the [`Widget`][crate::Widget] to add
    #[doc(alias = "gtk_size_group_add_widget")]
    pub fn add_widget(&self, widget: &impl IsA<Widget>) {
        unsafe {
            ffi::gtk_size_group_add_widget(self.to_glib_none().0, widget.as_ref().to_glib_none().0);
        }
    }

    /// Gets the current mode of the size group.
    ///
    /// # Returns
    ///
    /// the current mode of the size group.
    #[doc(alias = "gtk_size_group_get_mode")]
    #[doc(alias = "get_mode")]
    pub fn mode(&self) -> SizeGroupMode {
        unsafe { from_glib(ffi::gtk_size_group_get_mode(self.to_glib_none().0)) }
    }

    /// Returns the list of widgets associated with @self.
    ///
    /// # Returns
    ///
    /// a `GSList` of
    ///   widgets. The list is owned by GTK and should not be modified.
    #[doc(alias = "gtk_size_group_get_widgets")]
    #[doc(alias = "get_widgets")]
    pub fn widgets(&self) -> Vec<Widget> {
        unsafe {
            FromGlibPtrContainer::from_glib_none(ffi::gtk_size_group_get_widgets(
                self.to_glib_none().0,
            ))
        }
    }

    /// Removes a widget from a [`SizeGroup`][crate::SizeGroup].
    /// ## `widget`
    /// the [`Widget`][crate::Widget] to remove
    #[doc(alias = "gtk_size_group_remove_widget")]
    pub fn remove_widget(&self, widget: &impl IsA<Widget>) {
        unsafe {
            ffi::gtk_size_group_remove_widget(
                self.to_glib_none().0,
                widget.as_ref().to_glib_none().0,
            );
        }
    }

    /// Sets the [`SizeGroupMode`][crate::SizeGroupMode] of the size group.
    ///
    /// The mode of the size group determines whether the widgets in the
    /// size group should all have the same horizontal requisition
    /// ([`SizeGroupMode::Horizontal`][crate::SizeGroupMode::Horizontal]) all have the same vertical requisition
    /// ([`SizeGroupMode::Vertical`][crate::SizeGroupMode::Vertical]), or should all have the same requisition
    /// in both directions ([`SizeGroupMode::Both`][crate::SizeGroupMode::Both]).
    /// ## `mode`
    /// the mode to set for the size group.
    #[doc(alias = "gtk_size_group_set_mode")]
    pub fn set_mode(&self, mode: SizeGroupMode) {
        unsafe {
            ffi::gtk_size_group_set_mode(self.to_glib_none().0, mode.into_glib());
        }
    }

    #[doc(alias = "mode")]
    pub fn connect_mode_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_mode_trampoline<F: Fn(&SizeGroup) + 'static>(
            this: *mut ffi::GtkSizeGroup,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::mode\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_mode_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl fmt::Display for SizeGroup {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str("SizeGroup")
    }
}