Struct gtk::PlacesOpenFlags

pub struct PlacesOpenFlags { /* fields omitted */ }

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 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 PlacesOpenFlags::Normal in the PlacesSidebar::open-location signal. This is the default mode of operation.

Implementations

impl PlacesOpenFlags

pub const NORMAL: PlacesOpenFlags

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

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

Similar to PlacesOpenFlags::NewTab, but indicates that the application can open folders in new windows.

pub const fn empty() -> PlacesOpenFlags

Returns an empty set of flags

pub const fn all() -> PlacesOpenFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

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

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

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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

type Output = PlacesOpenFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<PlacesOpenFlags> for PlacesOpenFlags

fn bitand_assign(&mut self, other: PlacesOpenFlags)

Disables all flags disabled in the set.

impl BitOr<PlacesOpenFlags> for PlacesOpenFlags

type Output = PlacesOpenFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<PlacesOpenFlags> for PlacesOpenFlags

fn bitor_assign(&mut self, other: PlacesOpenFlags)

Adds the set of flags.

impl BitXor<PlacesOpenFlags> for PlacesOpenFlags

type Output = PlacesOpenFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<PlacesOpenFlags> for PlacesOpenFlags

fn bitxor_assign(&mut self, other: PlacesOpenFlags)

Toggles the set of flags.

impl Clone for PlacesOpenFlags

fn clone(&self) -> PlacesOpenFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PlacesOpenFlags

impl Debug for PlacesOpenFlags

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

Formats the value using the given formatter.

impl Eq for PlacesOpenFlags

impl Extend<PlacesOpenFlags> for PlacesOpenFlags

fn extend<T: IntoIterator<Item = PlacesOpenFlags>>(&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 = PlacesOpenFlags>>(
    iterator: T
) -> PlacesOpenFlags

Creates a value from an iterator.

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

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

Safety

impl<'a> FromValueOptional<'a> for PlacesOpenFlags

unsafe fn from_value_optional(value: &Value) -> Option<Self>

Safety

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

type Output = PlacesOpenFlags

The resulting type after applying the ! operator.

fn not(self) -> PlacesOpenFlags

Returns the complement of this set of flags.

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.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

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

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

This method tests for !=.

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.

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

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

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

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

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

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

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

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

impl SetValue for PlacesOpenFlags

unsafe fn set_value(value: &mut Value, this: &Self)

Safety

impl StaticType for PlacesOpenFlags

fn static_type() -> Type

Returns the type identifier of Self.

impl StructuralEq for PlacesOpenFlags

impl StructuralPartialEq for PlacesOpenFlags

impl Sub<PlacesOpenFlags> for PlacesOpenFlags

type Output = PlacesOpenFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<PlacesOpenFlags> for PlacesOpenFlags

fn sub_assign(&mut self, other: PlacesOpenFlags)

Disables all flags enabled in the set.

impl UpperHex for PlacesOpenFlags

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

Formats the value using the given formatter.