Struct gtk::PlacesOpenFlags
source · [−]pub struct PlacesOpenFlags { /* private fields */ }
Expand description
These flags serve two purposes. First, the application can call PlacesSidebar::set_open_flags()
using these flags as a bitmask. This tells the sidebar that the application is able to open
folders selected from the sidebar in various ways, for example, in new tabs or in new windows in
addition to the normal mode.
Second, when one of these values gets passed back to the application in the
signal::PlacesSidebar::open-location
signal, it means that the application should
open the selected location in the normal way, in a new tab, or in a new
window. The sidebar takes care of determining the desired way to open the location,
based on the modifier keys that the user is pressing at the time the selection is made.
If the application never calls PlacesSidebar::set_open_flags()
, then the sidebar will only
use NORMAL
in the signal::PlacesSidebar::open-location
signal. This is the
default mode of operation.
Implementations
sourceimpl PlacesOpenFlags
impl PlacesOpenFlags
sourcepub const NORMAL: Self = Self{bits: ffi::GTK_PLACES_OPEN_NORMAL as u32,}
pub const NORMAL: Self = Self{bits: ffi::GTK_PLACES_OPEN_NORMAL as u32,}
This is the default mode that PlacesSidebar
uses if no other flags
are specified. It indicates that the calling application should open the selected location
in the normal way, for example, in the folder view beside the sidebar.
sourcepub const NEW_TAB: Self = Self{bits: ffi::GTK_PLACES_OPEN_NEW_TAB as u32,}
pub const NEW_TAB: Self = Self{bits: ffi::GTK_PLACES_OPEN_NEW_TAB as u32,}
When passed to PlacesSidebar::set_open_flags()
, this indicates
that the application can open folders selected from the sidebar in new tabs. This value
will be passed to the signal::PlacesSidebar::open-location
signal when the user selects
that a location be opened in a new tab instead of in the standard fashion.
sourcepub const NEW_WINDOW: Self = Self{bits: ffi::GTK_PLACES_OPEN_NEW_WINDOW as u32,}
pub const NEW_WINDOW: Self = Self{bits: ffi::GTK_PLACES_OPEN_NEW_WINDOW as u32,}
Similar to NEW_TAB
, but indicates that the application
can open folders in new windows.
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 PlacesOpenFlags
impl Binary for PlacesOpenFlags
sourceimpl BitAnd<PlacesOpenFlags> for PlacesOpenFlags
impl BitAnd<PlacesOpenFlags> for PlacesOpenFlags
type Output = PlacesOpenFlags
type Output = PlacesOpenFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<PlacesOpenFlags> for PlacesOpenFlags
impl BitAndAssign<PlacesOpenFlags> for PlacesOpenFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<PlacesOpenFlags> for PlacesOpenFlags
impl BitOr<PlacesOpenFlags> for PlacesOpenFlags
sourcefn bitor(self, other: PlacesOpenFlags) -> Self
fn bitor(self, other: PlacesOpenFlags) -> Self
Returns the union of the two sets of flags.
type Output = PlacesOpenFlags
type Output = PlacesOpenFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<PlacesOpenFlags> for PlacesOpenFlags
impl BitOrAssign<PlacesOpenFlags> for PlacesOpenFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<PlacesOpenFlags> for PlacesOpenFlags
impl BitXor<PlacesOpenFlags> for PlacesOpenFlags
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 = PlacesOpenFlags
type Output = PlacesOpenFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<PlacesOpenFlags> for PlacesOpenFlags
impl BitXorAssign<PlacesOpenFlags> for PlacesOpenFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for PlacesOpenFlags
impl Clone for PlacesOpenFlags
sourcefn clone(&self) -> PlacesOpenFlags
fn clone(&self) -> PlacesOpenFlags
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 PlacesOpenFlags
impl Debug for PlacesOpenFlags
sourceimpl Display for PlacesOpenFlags
impl Display for PlacesOpenFlags
sourceimpl Extend<PlacesOpenFlags> for PlacesOpenFlags
impl Extend<PlacesOpenFlags> for PlacesOpenFlags
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<PlacesOpenFlags> for PlacesOpenFlags
impl FromIterator<PlacesOpenFlags> for PlacesOpenFlags
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<'a> FromValue<'a> for PlacesOpenFlags
impl<'a> FromValue<'a> for PlacesOpenFlags
type Checker = GenericValueTypeChecker<PlacesOpenFlags>
type Checker = GenericValueTypeChecker<PlacesOpenFlags>
Value type checker.
sourceunsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Get the contained value from a Value
. Read more
sourceimpl Hash for PlacesOpenFlags
impl Hash for PlacesOpenFlags
sourceimpl LowerHex for PlacesOpenFlags
impl LowerHex for PlacesOpenFlags
sourceimpl Not for PlacesOpenFlags
impl Not for PlacesOpenFlags
type Output = PlacesOpenFlags
type Output = PlacesOpenFlags
The resulting type after applying the !
operator.
sourceimpl Octal for PlacesOpenFlags
impl Octal for PlacesOpenFlags
sourceimpl Ord for PlacesOpenFlags
impl Ord for PlacesOpenFlags
sourceimpl PartialEq<PlacesOpenFlags> for PlacesOpenFlags
impl PartialEq<PlacesOpenFlags> for PlacesOpenFlags
sourcefn eq(&self, other: &PlacesOpenFlags) -> bool
fn eq(&self, other: &PlacesOpenFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &PlacesOpenFlags) -> bool
fn ne(&self, other: &PlacesOpenFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<PlacesOpenFlags> for PlacesOpenFlags
impl PartialOrd<PlacesOpenFlags> for PlacesOpenFlags
sourcefn partial_cmp(&self, other: &PlacesOpenFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &PlacesOpenFlags) -> 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 StaticType for PlacesOpenFlags
impl StaticType for PlacesOpenFlags
sourcefn static_type() -> Type
fn static_type() -> Type
Returns the type identifier of Self
.
sourceimpl Sub<PlacesOpenFlags> for PlacesOpenFlags
impl Sub<PlacesOpenFlags> for PlacesOpenFlags
type Output = PlacesOpenFlags
type Output = PlacesOpenFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<PlacesOpenFlags> for PlacesOpenFlags
impl SubAssign<PlacesOpenFlags> for PlacesOpenFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl ToValue for PlacesOpenFlags
impl ToValue for PlacesOpenFlags
sourceimpl UpperHex for PlacesOpenFlags
impl UpperHex for PlacesOpenFlags
sourceimpl ValueType for PlacesOpenFlags
impl ValueType for PlacesOpenFlags
type Type = PlacesOpenFlags
type Type = PlacesOpenFlags
Type to get the Type
from. Read more
impl Copy for PlacesOpenFlags
impl Eq for PlacesOpenFlags
impl StructuralEq for PlacesOpenFlags
impl StructuralPartialEq for PlacesOpenFlags
Auto Trait Implementations
impl RefUnwindSafe for PlacesOpenFlags
impl Send for PlacesOpenFlags
impl Sync for PlacesOpenFlags
impl Unpin for PlacesOpenFlags
impl UnwindSafe for PlacesOpenFlags
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
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
sourceimpl<T> StaticTypeExt for T where
T: StaticType,
impl<T> StaticTypeExt for T where
T: StaticType,
sourcefn ensure_type()
fn ensure_type()
Ensures that the type has been registered with the type system.
sourceimpl<T> ToClosureReturnValue for T where
T: ToValue,
impl<T> ToClosureReturnValue for T where
T: ToValue,
fn to_closure_return_value(&self) -> Option<Value>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> ToSendValue for T where
T: Send + ToValue + ?Sized,
impl<T> ToSendValue for T where
T: Send + ToValue + ?Sized,
sourcefn to_send_value(&self) -> SendValue
fn to_send_value(&self) -> SendValue
Returns a SendValue
clone of self
.