egui_alignments 0.3.8

Simple alignment tools for egui
Documentation 
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

use egui::{Align2, Response, Ui, Widget};

use crate::*;

/// A widget that can adjust its position using an [`Alignment`]
/// or a widget aligns its itself using the specified [`Alignment`]
/// before rendering.
///
/// # Examples
/// ```
/// use egui::{Button, Label};
/// use egui_alignments::Alignable;
///
/// # egui::__run_test_ui(|ui| {
/// Label::new("This label will be shown at the top")
///     .top(ui);
/// if Button::new("This label will be shown at the center")
///     .center(ui)
///     .clicked() {
///         println!("Center button clicked!");
///     }
/// Label::new("This label will be shown at the bottom")
///     .bottom(ui);
/// # });
/// ```
pub trait Alignable: Widget + Sized {
    /// Show the widget at the position specified by the [`Alignment`].
    fn align(self, ui: &mut Ui, align: impl Alignment) -> Response;

    /// Show the widget at the center of the available space.
    fn center(self, ui: &mut Ui) -> Response {
        self.align(ui, Align2::CENTER_CENTER)
    }

    /// Show the widget at the top of the available space.
    fn top(self, ui: &mut Ui) -> Response {
        self.align(ui, Align2::CENTER_TOP)
    }

    /// Show the widget at the bottom of the available space.
    fn bottom(self, ui: &mut Ui) -> Response {
        self.align(ui, Align2::CENTER_BOTTOM)
    }

    /// Show the widget at the left of the available space.
    fn left(self, ui: &mut Ui) -> Response {
        self.align(ui, Align2::LEFT_CENTER)
    }

    /// Show the widget at the right of the available space.
    fn right(self, ui: &mut Ui) -> Response {
        self.align(ui, Align2::RIGHT_CENTER)
    }

    /// Show the widget at the top left of the available space.
    fn top_left(self, ui: &mut Ui) -> Response {
        self.align(ui, Align2::LEFT_TOP)
    }

    /// Show the widget at the top right of the available space.
    fn top_right(self, ui: &mut Ui) -> Response {
        self.align(ui, Align2::RIGHT_TOP)
    }

    /// Show the widget at the bottom left of the available space.
    fn bottom_left(self, ui: &mut Ui) -> Response {
        self.align(ui, Align2::LEFT_BOTTOM)
    }

    /// Show the widget at the bottom right of the available space.
    fn bottom_right(self, ui: &mut Ui) -> Response {
        self.align(ui, Align2::RIGHT_BOTTOM)
    }
}

/// Implements [`Alignable`] for all [`Widget`]s
/// by adjust their positions using [`Aligner`].
impl<T: Widget> Alignable for T {
    fn align(self, ui: &mut Ui, align: impl Alignment) -> Response {
        Aligner::from_align(align).show(ui, |ui| self.ui(ui)).inner
    }
}