Struct egui::containers::Area
source · [−]pub struct Area { /* private fields */ }
Expand description
An area on the screen that can be moved by dragging.
This forms the base of the Window
container.
egui::Area::new("my_area")
.fixed_pos(egui::pos2(32.0, 32.0))
.show(ctx, |ui| {
ui.label("Floating text!");
});
Implementations
sourceimpl Area
impl Area
pub fn new(id_source: impl Hash) -> Self
pub fn id(self, id: Id) -> Self
pub fn layer(&self) -> LayerId
sourcepub fn enabled(self, enabled: bool) -> Self
pub fn enabled(self, enabled: bool) -> Self
If false, no content responds to click
and widgets will be shown grayed out.
You won’t be able to move the window.
Default: true
.
pub fn is_enabled(&self) -> bool
pub fn is_movable(&self) -> bool
sourcepub fn interactable(self, interactable: bool) -> Self
pub fn interactable(self, interactable: bool) -> Self
If false, clicks goes straight through to what is behind us. Good for tooltips etc.
sourcepub fn order(self, order: Order) -> Self
pub fn order(self, order: Order) -> Self
order(Order::Foreground)
for an Area that should always be on top
pub fn default_pos(self, default_pos: impl Into<Pos2>) -> Self
sourcepub fn fixed_pos(self, fixed_pos: impl Into<Pos2>) -> Self
pub fn fixed_pos(self, fixed_pos: impl Into<Pos2>) -> Self
Positions the window and prevents it from being moved
sourcepub fn current_pos(self, current_pos: impl Into<Pos2>) -> Self
pub fn current_pos(self, current_pos: impl Into<Pos2>) -> Self
Positions the window but you can still move it.
sourcepub fn anchor(self, align: Align2, offset: impl Into<Vec2>) -> Self
pub fn anchor(self, align: Align2, offset: impl Into<Vec2>) -> Self
Set anchor and distance.
An anchor of Align2::RIGHT_TOP
means “put the right-top corner of the window
in the right-top corner of the screen”.
The offset is added to the position, so e.g. an offset of [-5.0, 5.0]
would move the window left and down from the given anchor.
Anchoring also makes the window immovable.
It is an error to set both an anchor and a position.
sourcepub fn drag_bounds(self, bounds: Rect) -> Self
pub fn drag_bounds(self, bounds: Rect) -> Self
Constrain the area up to which the window can be dragged.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Area
impl Send for Area
impl Sync for Area
impl Unpin for Area
impl UnwindSafe for Area
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more