Struct gdk4::AnchorHints

pub struct AnchorHints { /* private fields */ }

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: Self = _

allow flipping anchors horizontally

pub const FLIP_Y: Self = _

allow flipping anchors vertically

pub const SLIDE_X: Self = _

allow sliding surface horizontally

pub const SLIDE_Y: Self = _

allow sliding surface vertically

pub const RESIZE_X: Self = _

allow resizing surface horizontally

pub const RESIZE_Y: Self = _

allow resizing surface vertically

pub const FLIP: Self = _

allow flipping anchors on both axes

pub const SLIDE: Self = _

allow sliding surface on both axes

pub const RESIZE: Self = _

allow resizing surface on both axes

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

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) -> Self

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

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

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

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

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: Self) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

pub const fn intersection(self, other: Self) -> Self

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

pub const fn union(self, other: Self) -> Self

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

pub const fn difference(self, other: Self) -> Self

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

pub const fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

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: Self) -> Self

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: Self)

Disables all flags disabled in the set.

impl BitOr<AnchorHints> for AnchorHints

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

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: Self)

Adds the set of flags.

impl BitXor<AnchorHints> for AnchorHints

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

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: Self)

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 = Self>>(&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 = Self>>(iterator: T) -> Self

Creates a value from an iterator.

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

type Checker = GenericValueTypeChecker<AnchorHints>

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,
    Self: Sized,

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) -> Self

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) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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: Self) -> Self

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: Self)

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 = AnchorHints

Type to get the Type from.

impl Copy for AnchorHints

impl Eq for AnchorHints

impl StructuralEq for AnchorHints

impl StructuralPartialEq for AnchorHints