Struct gtk4::FileLauncher

pub struct FileLauncher { /* private fields */ }

Available on crate feature v4_10 only.

A FileLauncher object collects the arguments that are needed to open a file with an application.

Depending on system configuration, user preferences and available APIs, this may or may not show an app chooser dialog or launch the default application right away.

The operation is started with the launch() function. This API follows the GIO async pattern, and the result can be obtained by calling Gtk::FileLauncher::launch_finish().

To launch uris that don’t represent files, use UriLauncher.

Properties

always-ask

Whether to ask the user to choose an app for opening the file. If FALSE, the file might be opened with a default app or the previous choice.

Readable | Writeable

file

The file to launch.

Readable | Writeable

writable

Whether to make the file writable for the handler.

Readable | Writeable

Implements

[trait@glib::ObjectExt]

Implementations

impl FileLauncher

pub fn new(file: Option<&impl IsA<File>>) -> FileLauncher

Creates a new FileLauncher object.

file

the file to open

Returns

the new FileLauncher

pub fn must_always_ask(&self) -> bool

Available on crate feature v4_12 only.

Returns whether to ask the user to choose an app for opening the file.

Returns

TRUE if always asking for app

pub fn file(&self) -> Option<File>

Gets the file that will be opened.

Returns

the file

pub fn is_writable(&self) -> bool

Available on crate feature v4_14 only.

Returns whether to make the file writable for the handler.

Returns

TRUE if the file will be made writable

pub fn launch<P: FnOnce(Result<(), Error>) + 'static>( &self, parent: Option<&impl IsA<Window>>, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

Launch an application to open the file.

This may present an app chooser dialog to the user.

The @callback will be called when the operation is completed. It should call Gtk::FileLauncher::launch_finish() to obtain the result.

parent

the parent Window

cancellable

a GCancellable to cancel the operation

callback

a callback to call when the operation is complete

pub fn launch_future( &self, parent: Option<&(impl IsA<Window> + Clone + 'static)> ) -> Pin<Box_<dyn Future<Output = Result<(), Error>> + 'static>>

pub fn open_containing_folder<P: FnOnce(Result<(), Error>) + 'static>( &self, parent: Option<&impl IsA<Window>>, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

Launch a file manager to show the file in its parent directory.

This is only supported native files. It will fail if @file is e.g. a http:// uri.

The @callback will be called when the operation is completed. It should call Gtk::FileLauncher::open_containing_folder_finish() to obtain the result.

parent

the parent Window

cancellable

a GCancellable to cancel the operation

callback

a callback to call when the operation is complete

pub fn open_containing_folder_future( &self, parent: Option<&(impl IsA<Window> + Clone + 'static)> ) -> Pin<Box_<dyn Future<Output = Result<(), Error>> + 'static>>

pub fn set_always_ask(&self, always_ask: bool)

Available on crate feature v4_12 only.

Sets whether to awlays ask the user to choose an app for opening the file. If FALSE, the file might be opened with a default app or the previous choice.

always_ask

a gboolean

pub fn set_file(&self, file: Option<&impl IsA<File>>)

Sets the file that will be opened.

file

a GFile

pub fn set_writable(&self, writable: bool)

Available on crate feature v4_14 only.

Sets whether to make the file writable for the handler.

writable

a gboolean

pub fn connect_always_ask_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Available on crate feature v4_12 only.

pub fn connect_file_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_writable_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Available on crate feature v4_14 only.

Trait Implementations

impl Clone for FileLauncher

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileLauncher

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

Formats the value using the given formatter.

impl HasParamSpec for FileLauncher

type ParamSpec = ParamSpecObject

type SetValue = FileLauncher

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, FileLauncher>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for FileLauncher

fn hash<H>(&self, state: &mut H)

where H: Hasher,

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 Ord for FileLauncher

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 + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for FileLauncher

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for FileLauncher

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

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

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<OT: ObjectType> PartialOrd<OT> for FileLauncher

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

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

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

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

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

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

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

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

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 FileLauncher

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for FileLauncher