Struct gdk4::AnchorHints
source · pub struct AnchorHints { /* private fields */ }
Expand description
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§
source§impl AnchorHints
impl AnchorHints
sourcepub const fn from_bits(bits: u32) -> Option<Self>
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.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
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
.
sourcepub const fn union(self, other: Self) -> Self
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
.
sourcepub const fn difference(self, other: Self) -> Self
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
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
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
.
sourcepub const fn complement(self) -> Self
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§
source§impl Binary for AnchorHints
impl Binary for AnchorHints
source§impl BitAnd<AnchorHints> for AnchorHints
impl BitAnd<AnchorHints> for AnchorHints
source§impl BitAndAssign<AnchorHints> for AnchorHints
impl BitAndAssign<AnchorHints> for AnchorHints
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<AnchorHints> for AnchorHints
impl BitOr<AnchorHints> for AnchorHints
source§fn bitor(self, other: AnchorHints) -> Self
fn bitor(self, other: AnchorHints) -> Self
Returns the union of the two sets of flags.
§type Output = AnchorHints
type Output = AnchorHints
|
operator.source§impl BitOrAssign<AnchorHints> for AnchorHints
impl BitOrAssign<AnchorHints> for AnchorHints
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<AnchorHints> for AnchorHints
impl BitXor<AnchorHints> for AnchorHints
source§impl BitXorAssign<AnchorHints> for AnchorHints
impl BitXorAssign<AnchorHints> for AnchorHints
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for AnchorHints
impl Clone for AnchorHints
source§fn clone(&self) -> AnchorHints
fn clone(&self) -> AnchorHints
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for AnchorHints
impl Debug for AnchorHints
source§impl Display for AnchorHints
impl Display for AnchorHints
source§impl Extend<AnchorHints> for AnchorHints
impl Extend<AnchorHints> for AnchorHints
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl From<AnchorHints> for Value
impl From<AnchorHints> for Value
source§fn from(v: AnchorHints) -> Self
fn from(v: AnchorHints) -> Self
source§impl FromIterator<AnchorHints> for AnchorHints
impl FromIterator<AnchorHints> for AnchorHints
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl<'a> FromValue<'a> for AnchorHints
impl<'a> FromValue<'a> for AnchorHints
§type Checker = GenericValueTypeChecker<AnchorHints>
type Checker = GenericValueTypeChecker<AnchorHints>
source§unsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Value
. Read moresource§impl HasParamSpec for AnchorHints
impl HasParamSpec for AnchorHints
type ParamSpec = ParamSpecFlags
§type SetValue = AnchorHints
type SetValue = AnchorHints
type BuilderFn = fn(_: &str) -> ParamSpecFlagsBuilder<'_, AnchorHints>
fn param_spec_builder() -> Self::BuilderFn
source§impl Hash for AnchorHints
impl Hash for AnchorHints
source§impl LowerHex for AnchorHints
impl LowerHex for AnchorHints
source§impl Not for AnchorHints
impl Not for AnchorHints
source§impl Octal for AnchorHints
impl Octal for AnchorHints
source§impl Ord for AnchorHints
impl Ord for AnchorHints
source§fn cmp(&self, other: &AnchorHints) -> Ordering
fn cmp(&self, other: &AnchorHints) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<AnchorHints> for AnchorHints
impl PartialEq<AnchorHints> for AnchorHints
source§fn eq(&self, other: &AnchorHints) -> bool
fn eq(&self, other: &AnchorHints) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<AnchorHints> for AnchorHints
impl PartialOrd<AnchorHints> for AnchorHints
source§fn partial_cmp(&self, other: &AnchorHints) -> Option<Ordering>
fn partial_cmp(&self, other: &AnchorHints) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl StaticType for AnchorHints
impl StaticType for AnchorHints
source§fn static_type() -> Type
fn static_type() -> Type
Self
.source§impl Sub<AnchorHints> for AnchorHints
impl Sub<AnchorHints> for AnchorHints
source§impl SubAssign<AnchorHints> for AnchorHints
impl SubAssign<AnchorHints> for AnchorHints
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
source§impl ToValue for AnchorHints
impl ToValue for AnchorHints
source§impl UpperHex for AnchorHints
impl UpperHex for AnchorHints
source§impl ValueType for AnchorHints
impl ValueType for AnchorHints
§type Type = AnchorHints
type Type = AnchorHints
Type
from. Read moreimpl Copy for AnchorHints
impl Eq for AnchorHints
impl StructuralEq for AnchorHints
impl StructuralPartialEq for AnchorHints
Auto Trait Implementations§
impl RefUnwindSafe for AnchorHints
impl Send for AnchorHints
impl Sync for AnchorHints
impl Unpin for AnchorHints
impl UnwindSafe for AnchorHints
Blanket Implementations§
source§impl<T> IntoClosureReturnValue for Twhere
T: Into<Value>,
impl<T> IntoClosureReturnValue for Twhere T: Into<Value>,
fn into_closure_return_value(self) -> Option<Value>
source§impl<T> PropertyGet for Twhere
T: HasParamSpec,
impl<T> PropertyGet for Twhere T: HasParamSpec,
source§impl<T> StaticTypeExt for Twhere
T: StaticType,
impl<T> StaticTypeExt for Twhere T: StaticType,
source§fn ensure_type()
fn ensure_type()
source§impl<T> ToSendValue for Twhere
T: Send + ToValue + ?Sized,
impl<T> ToSendValue for Twhere T: Send + ToValue + ?Sized,
source§fn to_send_value(&self) -> SendValue
fn to_send_value(&self) -> SendValue
SendValue
clone of self
.