Struct gtk::PlacesOpenFlags

pub struct PlacesOpenFlags { /* private fields */ }

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

impl PlacesOpenFlags

pub const NORMAL: Self = _

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.

pub const NEW_TAB: Self = _

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.

pub const NEW_WINDOW: Self = _

Similar to NEW_TAB, but indicates that the application can open folders in new windows.

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 PlacesOpenFlags

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

Formats the value using the given formatter.

impl BitAnd<PlacesOpenFlags> for PlacesOpenFlags

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

Returns the intersection between the two sets of flags.

type Output = PlacesOpenFlags

The resulting type after applying the & operator.

impl BitAndAssign<PlacesOpenFlags> for PlacesOpenFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<PlacesOpenFlags> for PlacesOpenFlags

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

Returns the union of the two sets of flags.

type Output = PlacesOpenFlags

The resulting type after applying the | operator.

impl BitOrAssign<PlacesOpenFlags> for PlacesOpenFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<PlacesOpenFlags> for PlacesOpenFlags

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

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

type Output = PlacesOpenFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<PlacesOpenFlags> for PlacesOpenFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for PlacesOpenFlags

fn clone(&self) -> PlacesOpenFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PlacesOpenFlags

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

Formats the value using the given formatter.

impl Display for PlacesOpenFlags

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

Formats the value using the given formatter.

impl Extend<PlacesOpenFlags> for PlacesOpenFlags

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<PlacesOpenFlags> for PlacesOpenFlags

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

Creates a value from an iterator.

impl<'a> FromValue<'a> for PlacesOpenFlags

type Checker = GenericValueTypeChecker<PlacesOpenFlags>

Value type checker.

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

Get the contained value from a Value.

impl Hash for PlacesOpenFlags

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 PlacesOpenFlags

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

Formats the value using the given formatter.

impl Not for PlacesOpenFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = PlacesOpenFlags

The resulting type after applying the ! operator.

impl Octal for PlacesOpenFlags

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

Formats the value using the given formatter.

impl Ord for PlacesOpenFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<PlacesOpenFlags> for PlacesOpenFlags

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

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

const 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<PlacesOpenFlags> for PlacesOpenFlags

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

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

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

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

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

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

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

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

const 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 PlacesOpenFlags

fn static_type() -> Type

Returns the type identifier of Self.

impl Sub<PlacesOpenFlags> for PlacesOpenFlags

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

Returns the set difference of the two sets of flags.

type Output = PlacesOpenFlags

The resulting type after applying the - operator.

impl SubAssign<PlacesOpenFlags> for PlacesOpenFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl ToValue for PlacesOpenFlags

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 PlacesOpenFlags

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

Formats the value using the given formatter.

impl ValueType for PlacesOpenFlags

type Type = PlacesOpenFlags

Type to get the Type from.

impl Copy for PlacesOpenFlags

impl Eq for PlacesOpenFlags

impl StructuralEq for PlacesOpenFlags

impl StructuralPartialEq for PlacesOpenFlags