class Gtk::FileLauncher

Overview

Asynchronous API to open a file with an application.

Gtk::FileLauncher collects the arguments that are needed to open the file.

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 Gtk::FileLauncher#launch function.

To launch uris that don't represent files, use Gtk::UriLauncher.

Defined in:

lib/gi-crystal/src/auto/gtk-4.0/file_launcher.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class GObject::Object

==(other : self) ==, bind_property(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags) : GObject::Binding bind_property, bind_property_full(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags, transform_to : GObject::Closure, transform_from : GObject::Closure) : GObject::Binding bind_property_full, data(key : String) : Pointer(Void) | Nil data, finalize finalize, freeze_notify : Nil freeze_notify, getv(names : Enumerable(String), values : Enumerable(_)) : Nil getv, hash(hasher) hash, notify(property_name : String) : Nil notify, notify_by_pspec(pspec : GObject::ParamSpec) : Nil notify_by_pspec, notify_signal notify_signal, property(property_name : String, value : _) : Nil property, qdata(quark : UInt32) : Pointer(Void) | Nil qdata, ref_count : UInt32 ref_count, run_dispose : Nil run_dispose, set_data(key : String, data : Pointer(Void) | Nil) : Nil set_data, set_property(property_name : String, value : _) : Nil set_property, steal_data(key : String) : Pointer(Void) | Nil steal_data, steal_qdata(quark : UInt32) : Pointer(Void) | Nil steal_qdata, thaw_notify : Nil thaw_notify, to_unsafe : Pointer(Void) to_unsafe, watch_closure(closure : GObject::Closure) : Nil watch_closure

Constructor methods inherited from class GObject::Object

cast(obj : GObject::Object) : self cast, new(pointer : Pointer(Void), transfer : GICrystal::Transfer)
new new, newv(object_type : UInt64, parameters : Enumerable(GObject::Parameter)) : self newv

Class methods inherited from class GObject::Object

cast?(obj : GObject::Object) : self | Nil cast?, compat_control(what : UInt64, data : Pointer(Void) | Nil) : UInt64 compat_control, g_type : UInt64 g_type, interface_find_property(g_iface : GObject::TypeInterface, property_name : String) : GObject::ParamSpec interface_find_property, interface_list_properties(g_iface : GObject::TypeInterface) : Enumerable(GObject::ParamSpec) interface_list_properties

Macros inherited from class GObject::Object

previous_vfunc(*args) previous_vfunc, previous_vfunc!(*args) previous_vfunc!, signal(signature) signal

Constructor Detail

def self.new(file : Gio::File | Nil) : self #

Creates a new Gtk::FileLauncher object.


def self.new #

Initialize a new FileLauncher.


def self.new(*, always_ask : Bool | Nil = nil, file : Gio::File | Nil = nil, writable : Bool | Nil = nil) #

Class Method Detail

def self.g_type : UInt64 #

Returns the type id (GType) registered in GLib type system.


Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def always_ask : Bool #

Returns whether to ask the user which app to use.


def always_ask=(always_ask : Bool) : Nil #

Sets whether to always ask the user which app to use.

If false, the file might be opened with a default app or the previous choice.


def always_ask? : Bool #

def file : Gio::File | Nil #

Gets the file that will be opened.


def file=(file : Gio::File | Nil) : Nil #

Sets the file that will be opened.


def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def launch(parent : Gtk::Window | Nil, cancellable : Gio::Cancellable | Nil, &callback : Gio::AsyncReadyCallback) : Nil #

Launches an application to open the file.

This may present an app chooser dialog to the user.


def launch_finish(result : Gio::AsyncResult) : Bool #

Finishes the Gtk::FileLauncher#launch call and returns the result.


def open_containing_folder(parent : Gtk::Window | Nil, cancellable : Gio::Cancellable | Nil, &callback : Gio::AsyncReadyCallback) : Nil #

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

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


def open_containing_folder_finish(result : Gio::AsyncResult) : Bool #

Finishes the Gtk::FileLauncher#open_containing_folder call and returns the result.


def writable : Bool #

Returns whether to make the file writable for the handler.


def writable=(writable : Bool) : Nil #

Sets whether to make the file writable for the handler.


def writable? : Bool #