Struct gdk4::AnchorHints

pub struct AnchorHints { /* fields omitted */ }

Positioning hints for aligning a surface relative to a rectangle.

These hints determine how the surface should be positioned in the case that the surface would fall off-screen if placed in its ideal position.

For example, FLIP_X will replace Gravity::NorthWest with Gravity::NorthEast and vice versa if the surface extends beyond the left or right edges of the monitor.

If SLIDE_X is set, the surface can be shifted horizontally to fit on-screen. If RESIZE_X is set, the surface can be shrunken horizontally to fit.

In general, when multiple flags are set, flipping should take precedence over sliding, which should take precedence over resizing.

Implementations

impl AnchorHints

pub const FLIP_X: AnchorHints

allow flipping anchors horizontally

pub const FLIP_Y: AnchorHints

allow flipping anchors vertically

pub const SLIDE_X: AnchorHints

allow sliding surface horizontally

pub const SLIDE_Y: AnchorHints

allow sliding surface vertically

pub const RESIZE_X: AnchorHints

allow resizing surface horizontally

pub const RESIZE_Y: AnchorHints

allow resizing surface vertically

pub const FLIP: AnchorHints

allow flipping anchors on both axes

pub const SLIDE: AnchorHints

allow sliding surface on both axes

pub const RESIZE: AnchorHints

allow resizing surface on both axes

pub const fn empty() -> AnchorHints

Returns an empty set of flags

pub const fn all() -> AnchorHints

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<AnchorHints>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> AnchorHints

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> AnchorHints

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: AnchorHints) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: AnchorHints) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: AnchorHints)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: AnchorHints)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: AnchorHints)

Toggles the specified flags in-place.

pub fn set(&mut self, other: AnchorHints, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for AnchorHints

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

Formats the value using the given formatter.

impl BitAnd<AnchorHints> for AnchorHints

fn bitand(self, other: AnchorHints) -> AnchorHints

Returns the intersection between the two sets of flags.

type Output = AnchorHints

The resulting type after applying the & operator.

impl BitAndAssign<AnchorHints> for AnchorHints

fn bitand_assign(&mut self, other: AnchorHints)

Disables all flags disabled in the set.

impl BitOr<AnchorHints> for AnchorHints

fn bitor(self, other: AnchorHints) -> AnchorHints

Returns the union of the two sets of flags.

type Output = AnchorHints

The resulting type after applying the | operator.

impl BitOrAssign<AnchorHints> for AnchorHints

fn bitor_assign(&mut self, other: AnchorHints)

Adds the set of flags.

impl BitXor<AnchorHints> for AnchorHints

fn bitxor(self, other: AnchorHints) -> AnchorHints

Returns the left flags, but with all the right flags toggled.

type Output = AnchorHints

The resulting type after applying the ^ operator.

impl BitXorAssign<AnchorHints> for AnchorHints

fn bitxor_assign(&mut self, other: AnchorHints)

Toggles the set of flags.

impl Clone for AnchorHints

fn clone(&self) -> AnchorHints

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnchorHints

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

Formats the value using the given formatter.

impl Display for AnchorHints

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

Formats the value using the given formatter.

impl Extend<AnchorHints> for AnchorHints

fn extend<T: IntoIterator<Item = AnchorHints>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<AnchorHints> for AnchorHints

fn from_iter<T: IntoIterator<Item = AnchorHints>>(iterator: T) -> AnchorHints

Creates a value from an iterator.

impl<'a> FromValue<'a> for AnchorHints

type Checker = GenericValueTypeChecker<Self>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl Hash for AnchorHints

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for AnchorHints

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

Formats the value using the given formatter.

impl Not for AnchorHints

fn not(self) -> AnchorHints

Returns the complement of this set of flags.

type Output = AnchorHints

The resulting type after applying the ! operator.

impl Octal for AnchorHints

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

Formats the value using the given formatter.

impl Ord for AnchorHints

fn cmp(&self, other: &AnchorHints) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<AnchorHints> for AnchorHints

fn eq(&self, other: &AnchorHints) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<AnchorHints> for AnchorHints

fn partial_cmp(&self, other: &AnchorHints) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for AnchorHints

fn static_type() -> Type

Returns the type identifier of Self.

impl Sub<AnchorHints> for AnchorHints

fn sub(self, other: AnchorHints) -> AnchorHints

Returns the set difference of the two sets of flags.

type Output = AnchorHints

The resulting type after applying the - operator.

impl SubAssign<AnchorHints> for AnchorHints

fn sub_assign(&mut self, other: AnchorHints)

Disables all flags enabled in the set.

impl ToValue for AnchorHints

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifer of self.

impl UpperHex for AnchorHints

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

Formats the value using the given formatter.

impl ValueType for AnchorHints

type Type = Self

Type to get the Type from.

impl Copy for AnchorHints

impl Eq for AnchorHints

impl StructuralEq for AnchorHints

impl StructuralPartialEq for AnchorHints