Struct native_windows_gui::PopupMenuFlags
source · [−]pub struct PopupMenuFlags { /* private fields */ }
Expand description
Menu flags to use with the Menu::popup_with_flags
function.
Using PopupMenuFlags::empty
is the same as ALIGN_LEFT|ALIGN_TOP|LEFT_BUTTON
Aligment flags:
- ALIGN_LEFT: Positions the shortcut menu so that its left side is aligned with the coordinate specified by the x parameter.
- ALIGN_H_CENTER: Centers the shortcut menu horizontally relative to the coordinate specified by the x parameter.
- ALIGN_RIGHT: Positions the shortcut menu so that its right side is aligned with the coordinate specified by the x parameter.
- ALIGN_BOTTOM: Positions the shortcut menu so that its bottom side is aligned with the coordinate specified by the y parameter.
- ALIGN_TOP: Positions the shortcut menu so that its top side is aligned with the coordinate specified by the y parameter.
- ALIGN_V_CENTER: Centers the shortcut menu vertically relative to the coordinate specified by the y parameter.
Button flags:
- LEFT_BUTTON: The user can select menu items with only the left mouse button.
- RIGHT_BUTTON: The user can select menu items with both the left AND right mouse buttons.
Animations flags:
- ANIMATE_NONE: Displays menu without animation.
- ANIMATE_RIGHT_TO_LEFT: Animates the menu from right to left.
- ANIMATE_LEFT_TO_RIGHT: Animates the menu from left to right.
- ANIMATE_BOTTOM_TO_TOP: Animates the menu from bottom to top.
- ANIMATE_TOP_TO_BOTTOM: Animates the menu from top to bottom.
Implementations
sourceimpl PopupMenuFlags
impl PopupMenuFlags
pub const ALIGN_LEFT: Self = _
pub const ALIGN_H_CENTER: Self = _
pub const ALIGN_RIGHT: Self = _
pub const ALIGN_BOTTOM: Self = _
pub const ALIGN_TOP: Self = _
pub const ALIGN_V_CENTER: Self = _
pub const LEFT_BUTTON: Self = _
pub const RIGHT_BUTTON: Self = _
pub const ANIMATE_NONE: Self = _
pub const ANIMATE_RIGHT_TO_LEFT: Self = _
pub const ANIMATE_LEFT_TO_RIGHT: Self = _
pub const ANIMATE_BOTTOM_TO_TOP: Self = _
pub const ANIMATE_TOP_TO_BOTTOM: Self = _
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
sourceimpl Binary for PopupMenuFlags
impl Binary for PopupMenuFlags
sourceimpl BitAnd<PopupMenuFlags> for PopupMenuFlags
impl BitAnd<PopupMenuFlags> for PopupMenuFlags
type Output = PopupMenuFlags
type Output = PopupMenuFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<PopupMenuFlags> for PopupMenuFlags
impl BitAndAssign<PopupMenuFlags> for PopupMenuFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<PopupMenuFlags> for PopupMenuFlags
impl BitOr<PopupMenuFlags> for PopupMenuFlags
sourcefn bitor(self, other: PopupMenuFlags) -> Self
fn bitor(self, other: PopupMenuFlags) -> Self
Returns the union of the two sets of flags.
type Output = PopupMenuFlags
type Output = PopupMenuFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<PopupMenuFlags> for PopupMenuFlags
impl BitOrAssign<PopupMenuFlags> for PopupMenuFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<PopupMenuFlags> for PopupMenuFlags
impl BitXor<PopupMenuFlags> for PopupMenuFlags
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = PopupMenuFlags
type Output = PopupMenuFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<PopupMenuFlags> for PopupMenuFlags
impl BitXorAssign<PopupMenuFlags> for PopupMenuFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for PopupMenuFlags
impl Clone for PopupMenuFlags
sourcefn clone(&self) -> PopupMenuFlags
fn clone(&self) -> PopupMenuFlags
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for PopupMenuFlags
impl Debug for PopupMenuFlags
sourceimpl Extend<PopupMenuFlags> for PopupMenuFlags
impl Extend<PopupMenuFlags> for PopupMenuFlags
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<PopupMenuFlags> for PopupMenuFlags
impl FromIterator<PopupMenuFlags> for PopupMenuFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl Hash for PopupMenuFlags
impl Hash for PopupMenuFlags
sourceimpl LowerHex for PopupMenuFlags
impl LowerHex for PopupMenuFlags
sourceimpl Not for PopupMenuFlags
impl Not for PopupMenuFlags
type Output = PopupMenuFlags
type Output = PopupMenuFlags
The resulting type after applying the !
operator.
sourceimpl Octal for PopupMenuFlags
impl Octal for PopupMenuFlags
sourceimpl Ord for PopupMenuFlags
impl Ord for PopupMenuFlags
sourcefn cmp(&self, other: &PopupMenuFlags) -> Ordering
fn cmp(&self, other: &PopupMenuFlags) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
Restrict a value to a certain interval. Read more
sourceimpl PartialEq<PopupMenuFlags> for PopupMenuFlags
impl PartialEq<PopupMenuFlags> for PopupMenuFlags
sourcefn eq(&self, other: &PopupMenuFlags) -> bool
fn eq(&self, other: &PopupMenuFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourceimpl PartialOrd<PopupMenuFlags> for PopupMenuFlags
impl PartialOrd<PopupMenuFlags> for PopupMenuFlags
sourcefn partial_cmp(&self, other: &PopupMenuFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &PopupMenuFlags) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Sub<PopupMenuFlags> for PopupMenuFlags
impl Sub<PopupMenuFlags> for PopupMenuFlags
type Output = PopupMenuFlags
type Output = PopupMenuFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<PopupMenuFlags> for PopupMenuFlags
impl SubAssign<PopupMenuFlags> for PopupMenuFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for PopupMenuFlags
impl UpperHex for PopupMenuFlags
impl Copy for PopupMenuFlags
impl Eq for PopupMenuFlags
impl StructuralEq for PopupMenuFlags
impl StructuralPartialEq for PopupMenuFlags
Auto Trait Implementations
impl RefUnwindSafe for PopupMenuFlags
impl Send for PopupMenuFlags
impl Sync for PopupMenuFlags
impl Unpin for PopupMenuFlags
impl UnwindSafe for PopupMenuFlags
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
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