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
// Take a look at the license at the top of the repository in the LICENSE file.
use crate::Gravity;
use glib::translate::*;
use std::fmt;
glib::wrapper! {
/// The [`Geometry`][crate::Geometry] struct gives the window manager information about
/// a window’s geometry constraints. Normally you would set these on
/// the GTK+ level using `gtk_window_set_geometry_hints()`. `GtkWindow`
/// then sets the hints on the [`Window`][crate::Window] it creates.
///
/// [`Window::set_geometry_hints()`][crate::Window::set_geometry_hints()] expects the hints to be fully valid already
/// and simply passes them to the window manager; in contrast,
/// `gtk_window_set_geometry_hints()` performs some interpretation. For example,
/// `GtkWindow` will apply the hints to the geometry widget instead of the
/// toplevel window, if you set a geometry widget. Also, the
/// `min_width`/`min_height`/`max_width`/`max_height` fields may be set to -1, and
/// `GtkWindow` will substitute the size request of the window or geometry widget.
/// If the minimum size hint is not provided, `GtkWindow` will use its requisition
/// as the minimum size. If the minimum size is provided and a geometry widget is
/// set, `GtkWindow` will take the minimum size as the minimum size of the
/// geometry widget rather than the entire window. The base size is treated
/// similarly.
///
/// The canonical use-case for `gtk_window_set_geometry_hints()` is to get a
/// terminal widget to resize properly. Here, the terminal text area should be
/// the geometry widget; `GtkWindow` will then automatically set the base size to
/// the size of other widgets in the terminal window, such as the menubar and
/// scrollbar. Then, the `width_inc` and `height_inc` fields should be set to the
/// size of one character in the terminal. Finally, the base size should be set
/// to the size of one character. The net effect is that the minimum size of the
/// terminal will have a 1x1 character terminal area, and only terminal sizes on
/// the “character grid” will be allowed.
///
/// Here’s an example of how the terminal example would be implemented, assuming
/// a terminal area widget called “terminal” and a toplevel window “toplevel”:
///
///
///
/// **⚠️ The following code is in C ⚠️**
///
/// ```C
/// GdkGeometry hints;
///
/// hints.base_width = terminal->char_width;
/// hints.base_height = terminal->char_height;
/// hints.min_width = terminal->char_width;
/// hints.min_height = terminal->char_height;
/// hints.width_inc = terminal->char_width;
/// hints.height_inc = terminal->char_height;
///
/// gtk_window_set_geometry_hints (GTK_WINDOW (toplevel),
/// GTK_WIDGET (terminal),
/// &hints,
/// GDK_HINT_RESIZE_INC |
/// GDK_HINT_MIN_SIZE |
/// GDK_HINT_BASE_SIZE);
/// ```
///
/// The other useful fields are the `min_aspect` and `max_aspect` fields; these
/// contain a width/height ratio as a floating point number. If a geometry widget
/// is set, the aspect applies to the geometry widget rather than the entire
/// window. The most common use of these hints is probably to set `min_aspect` and
/// `max_aspect` to the same value, thus forcing the window to keep a constant
/// aspect ratio.
#[doc(alias = "GdkGeometry")]
pub struct Geometry(BoxedInline<ffi::GdkGeometry>);
}
impl Geometry {
#[allow(clippy::too_many_arguments)]
pub fn new(
min_width: i32,
min_height: i32,
max_width: i32,
max_height: i32,
base_width: i32,
base_height: i32,
width_inc: i32,
height_inc: i32,
min_aspect: f64,
max_aspect: f64,
win_gravity: Gravity,
) -> Self {
assert_initialized_main_thread!();
unsafe {
Geometry::unsafe_from(ffi::GdkGeometry {
min_width,
min_height,
max_width,
max_height,
base_width,
base_height,
width_inc,
height_inc,
min_aspect,
max_aspect,
win_gravity: win_gravity.into_glib(),
})
}
}
pub fn min_width(&self) -> i32 {
self.inner.min_width
}
pub fn min_height(&self) -> i32 {
self.inner.min_height
}
pub fn max_width(&self) -> i32 {
self.inner.max_width
}
pub fn max_height(&self) -> i32 {
self.inner.max_height
}
pub fn base_width(&self) -> i32 {
self.inner.base_width
}
pub fn base_height(&self) -> i32 {
self.inner.base_height
}
pub fn width_inc(&self) -> i32 {
self.inner.width_inc
}
pub fn height_inc(&self) -> i32 {
self.inner.height_inc
}
pub fn min_aspect(&self) -> f64 {
self.inner.min_aspect
}
pub fn max_aspect(&self) -> f64 {
self.inner.max_aspect
}
pub fn win_gravity(&self) -> Gravity {
unsafe { from_glib(self.inner.win_gravity) }
}
}
impl fmt::Debug for Geometry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("Geometry")
.field("min_width", &self.min_width())
.field("min_height", &self.min_height())
.field("max_width", &self.max_width())
.field("max_height", &self.max_height())
.field("base_width", &self.base_width())
.field("base_height", &self.base_height())
.field("width_inc", &self.width_inc())
.field("height_inc", &self.height_inc())
.field("min_aspect", &self.min_aspect())
.field("max_aspect", &self.max_aspect())
.field("win_gravity", &self.win_gravity())
.finish()
}
}