Skip to main content

Region

Struct Region 

Source
pub struct Region<ID> { /* private fields */ }
Expand description

A region representing a rectangular area with an associated widget ID.

This struct is used to define the position and size of widgets within the GUI.

Implementations§

Source§

impl<ID: WidgetId> Region<ID>

Source

pub const fn new(id: ID, x: i16, y: i16, w: u16, h: u16) -> Self

Creates a new region with the specified ID and dimensions.

§Arguments
  • id - The widget ID for this region
  • x - The x-coordinate of the top-left corner
  • y - The y-coordinate of the top-left corner
  • w - The width of the region
  • h - The height of the region
Source

pub const fn new_with_area(id: ID, area: LwRectangle<i16, u16>) -> Self

Creates a new region with the specified ID and area.

Source

pub const fn zero(id: ID) -> Self

Creates a new region with zero dimensions at the origin.

§Arguments
  • id - The widget ID for this region
Source

pub const fn id(&self) -> ID

Returns the widget ID associated with this region.

Source

pub const fn replace_id(&self, id: ID) -> Self

Replace the widget ID of the region.

Source

pub fn top_left(&self) -> Point

Returns the top-left corner of the region as a Point.

Source

pub fn size(&self) -> Size

Returns the size of the region as a Size.

Source

pub fn rectangle(&self) -> Rectangle

Returns the region as a Rectangle.

Source

pub const fn x(&self) -> i32

Returns the x-coordinate of the top-left corner as an i32.

Source

pub const fn y(&self) -> i32

Returns the y-coordinate of the top-left corner as an i32.

Source

pub const fn width(&self) -> u32

Returns the width of the region as a u32.

Source

pub const fn height(&self) -> u32

Returns the height of the region as a u32.

Source

pub fn delta_resize(&self, delta: DeltaResize) -> Region<ID>

Returns a new region resized according to the specified delta.

§Arguments
  • delta - The resize delta to use for resizing
Source

pub fn move_by(&self, dx: i16, dy: i16) -> Self

Moves the region by the specified amount.

§Arguments
  • dx - The x-direction offset
  • dy - The y-direction offset
§Returns

A new Region instance with the moved position.

Source

pub fn resized( &self, width: u16, height: u16, anchor_point: AnchorPoint, ) -> Self

Returns a new region resized according to the specified width and height.

§Arguments
  • width - The new width of the region
  • height - The new height of the region
  • anchor_point - The anchor point to use for resizing
§Returns

A new Region instance with the resized dimensions.

Trait Implementations§

Source§

impl<ID: Clone> Clone for Region<ID>

Source§

fn clone(&self) -> Region<ID>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<ID: Debug> Debug for Region<ID>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<ID: Default> Default for Region<ID>

Source§

fn default() -> Region<ID>

Returns the “default value” for a type. Read more
Source§

impl<ID: PartialEq> PartialEq for Region<ID>

Source§

fn eq(&self, other: &Region<ID>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<ID: Copy> Copy for Region<ID>

Source§

impl<ID: Eq> Eq for Region<ID>

Source§

impl<ID> StructuralPartialEq for Region<ID>

Auto Trait Implementations§

§

impl<ID> Freeze for Region<ID>
where ID: Freeze,

§

impl<ID> RefUnwindSafe for Region<ID>
where ID: RefUnwindSafe,

§

impl<ID> Send for Region<ID>
where ID: Send,

§

impl<ID> Sync for Region<ID>
where ID: Sync,

§

impl<ID> Unpin for Region<ID>
where ID: Unpin,

§

impl<ID> UnsafeUnpin for Region<ID>
where ID: UnsafeUnpin,

§

impl<ID> UnwindSafe for Region<ID>
where ID: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.