Struct FOS

pub struct FOS(/* private fields */);

Available on crate features kernel and shell only.

_FILEOPENDIALOGOPTIONS enumeration (u32).

This is a bitflag constant.

Implementations

impl FOS

pub const unsafe fn as_mut(&mut self) -> &mut u32

Returns a mutable reference to the underlying raw value.

Safety

Be sure the integer being set is meaningful for the actual type.

pub const unsafe fn from_raw(v: u32) -> Self

Constructs a new object by wrapping the given integer value.

Safety

Be sure the given value is meaningful for the actual type.

pub const fn raw(&self) -> u32

Returns the primitive integer underlying value.

This method is similar to Into, but it is const, therefore it can be used in const contexts.

impl FOS

pub const fn has(&self, other: Self) -> bool

Returns true if the other bitflag value is present.

Equivalent to (val & other) != 0.

impl FOS

pub const OVERWRITEPROMPT: Self

When saving a file prompt before overwriting an existing file of the same name. This is a default value for the Save dialog.

pub const STRICTFILETYPES: Self

In the Save dialog only allow the user to choose a file that has one of the file name extensions specified through IFileDialog::SetFileTypes.

pub const NOCHANGEDIR: Self

Don’t change the current working directory.

pub const PICKFOLDERS: Self

Present an Open dialog that offers a choice of folders rather than files.

pub const FORCEFILESYSTEM: Self

Ensures that returned items are file system items (SFGAO::FILESYSTEM). Note that this does not apply to items returned by IFileDialog::GetCurrentSelection.

pub const ALLNONSTORAGEITEMS: Self

Enables the user to choose any item in the Shell namespace not just those with SFGAO::STREAM or SFAGO::FILESYSTEM attributes. This flag cannot be combined with FOS::FORCEFILESYSTEM.

pub const NOVALIDATE: Self

Do not check for situations that would prevent an application from opening the selected file such as sharing violations or access denied errors.

pub const ALLOWMULTISELECT: Self

Enables the user to select multiple items in the open dialog. Note that when this flag is set the IFileOpenDialog interface must be used to retrieve those items.

pub const PATHMUSTEXIST: Self

The item returned must be in an existing folder. This is a default value.

pub const FILEMUSTEXIST: Self

The item returned must exist. This is a default value for the Open dialog.

pub const CREATEPROMPT: Self

Prompt for creation if the item returned in the save dialog does not exist. Note that this does not actually create the item.

pub const SHAREAWARE: Self

In the case of a sharing violation when an application is opening a file call the application back through OnShareViolation for guidance. This flag is overridden by FOS::NOVALIDATE.

pub const NOREADONLYRETURN: Self

Do not return read-only items. This is a default value for the Save dialog.

pub const NOTESTFILECREATE: Self

Do not test whether creation of the item as specified in the Save dialog will be successful. If this flag is not set the calling application must handle errors such as denial of access discovered when the item is created.

pub const HIDEMRUPLACES: Self

Hide the list of places from which the user has recently opened or saved items. This value is not supported as of Windows 7.

pub const HIDEPINNEDPLACES: Self

Hide items shown by default in the view’s navigation pane. This flag is often used in conjunction with the IFileDialog::AddPlace method, to hide standard locations and replace them with custom locations.

Windows 7 and later. Hide all of the standard namespace locations (such as Favorites Libraries Computer and Network) shown in the navigation pane.

Windows Vista. Hide the contents of the Favorite Links tree in the navigation pane. Note that the category itself is still displayed but shown as empty.

pub const NODEREFERENCELINKS: Self

Shortcuts should not be treated as their target items. This allows an application to open a .lnk file rather than what that file is a shortcut to.

pub const OKBUTTONNEEDSINTERACTION: Self

(This constant has no official documentation.)

pub const DONTADDTORECENT: Self

Do not add the item being opened or saved to the recent documents list (SHAddToRecentDocs).

pub const FORCESHOWHIDDEN: Self

Include hidden and system items.

pub const DEFAULTNOMINIMODE: Self

Indicates to the Save As dialog box that it should open in expanded mode. Expanded mode is the mode that is set and unset by clicking the button in the lower-left corner of the Save As dialog box that switches between Browse Folders and Hide Folders when clicked. This value is not supported as of Windows 7.

pub const FORCEPREVIEWPANEON: Self

Indicates to the Open dialog box that the preview pane should always be displayed.

pub const SUPPORTSTREAMABLEITEMS: Self

Indicates that the caller is opening a file as a stream (BHID_Stream) so there is no need to download that file.

Trait Implementations

impl AsRef<u32> for FOS

fn as_ref(&self) -> &u32

Converts this type into a shared reference of the (usually inferred) input type.

impl Binary for FOS

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

Formats the value using the given formatter.

impl BitAnd for FOS

type Output = FOS

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign for FOS

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for FOS

type Output = FOS

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self

Performs the | operation.

impl BitOrAssign for FOS

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for FOS

type Output = FOS

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXorAssign for FOS

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for FOS

fn clone(&self) -> FOS

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FOS

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

Formats the value using the given formatter.

impl Default for FOS

fn default() -> FOS

Returns the “default value” for a type.

impl Display for FOS

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

Formats the value using the given formatter.

impl From<FOS> for u32

fn from(v: FOS) -> Self

Converts to this type from the input type.

impl Hash for FOS

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for FOS

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

Formats the value using the given formatter.

impl Not for FOS

type Output = FOS

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Octal for FOS

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

Formats the value using the given formatter.

impl Ord for FOS

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FOS

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for FOS

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl UpperHex for FOS

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

Formats the value using the given formatter.

impl Copy for FOS

impl Eq for FOS

impl StructuralPartialEq for FOS