Package org.gnome.gtk

Class FileLauncher

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.FileLauncher

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class FileLauncher
extends GObject

A GtkFileLauncher 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(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) function.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileLauncher.Builder<B extends FileLauncher.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	FileLauncher.FileLauncherClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
FileLauncher()	Calls FileLauncher(org.gnome.gio.File) with file = null
FileLauncher(MemorySegment address)	Create a FileLauncher proxy instance for the provided memory address.
FileLauncher(@Nullable File file)	Creates a new GtkFileLauncher object.

Method Summary

Modifier and Type	Method	Description
protected FileLauncher	asParent()	Returns this instance as if it were its parent type.
static FileLauncher.Builder<? extends FileLauncher.Builder>	builder()	A FileLauncher.Builder object constructs a FileLauncher with the specified properties.
boolean	getAlwaysAsk()	Returns whether to ask the user to choose an app for opening the file.
File	getFile()	Gets the file that will be opened.
static Type	getType()	Get the GType of the FileLauncher class
boolean	getWritable()	Returns whether to make the file writable for the handler.
void	launch(@Nullable Window parent, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Launch an application to open the file.
boolean	launchFinish(AsyncResult result)	Finishes the launch(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call and returns the result.
void	openContainingFolder(@Nullable Window parent, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Launch a file manager to show the file in its parent directory.
boolean	openContainingFolderFinish(AsyncResult result)	Finishes the openContainingFolder(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call and returns the result.
void	setAlwaysAsk(boolean alwaysAsk)	Sets whether to awlays ask the user to choose an app for opening the file.
void	setFile(@Nullable File file)	Sets the file that will be opened.
void	setWritable(boolean writable)	Sets whether to make the file writable for the handler.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newInstance, newInstance, newv, notify_, notify_, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FileLauncher

public FileLauncher(MemorySegment address)

Create a FileLauncher proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

FileLauncher

public FileLauncher(@Nullable
 @Nullable File file)

Creates a new GtkFileLauncher object.

Parameters:

file - the file to open

FileLauncher

public FileLauncher()

Calls FileLauncher(org.gnome.gio.File) with file = null

Method Details

getType

public static Type getType()

Get the GType of the FileLauncher class

Returns:

the GType

asParent

protected FileLauncher asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

getAlwaysAsk

public boolean getAlwaysAsk()

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

Returns:

TRUE if always asking for app

getFile

public File getFile()

Gets the file that will be opened.

Returns:

the file

getWritable

public boolean getWritable()

Returns whether to make the file writable for the handler.

Returns:

TRUE if the file will be made writable

launch

public void launch(@Nullable
 @Nullable Window parent,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Launch an application to open the file.

This may present an app chooser dialog to the user.

Parameters:

parent - the parent GtkWindow

cancellable - a GCancellable to cancel the operation

callback - a callback to call when the operation is complete

launchFinish

public boolean launchFinish(AsyncResult result)
                     throws GErrorException

Finishes the launch(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call and returns the result.

Parameters:

result - a GAsyncResult

Returns:

TRUE if an application was launched, or FALSE and error is set

Throws:

GErrorException - see GError

openContainingFolder

public void openContainingFolder(@Nullable
 @Nullable Window parent,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

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.

Parameters:

parent - the parent GtkWindow

cancellable - a GCancellable to cancel the operation

callback - a callback to call when the operation is complete

openContainingFolderFinish

public boolean openContainingFolderFinish(AsyncResult result)
                                   throws GErrorException

Finishes the openContainingFolder(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call and returns the result.

Parameters:

result - a GAsyncResult

Returns:

TRUE if an application was launched, or FALSE and error is set

Throws:

GErrorException - see GError

setAlwaysAsk

public void setAlwaysAsk(boolean alwaysAsk)

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.

Parameters:

alwaysAsk - a gboolean

setFile

public void setFile(@Nullable
 @Nullable File file)

Sets the file that will be opened.

Parameters:

file - a GFile

setWritable

public void setWritable(boolean writable)

Sets whether to make the file writable for the handler.

Parameters:

writable - a gboolean

builder

public static FileLauncher.Builder<? extends FileLauncher.Builder> builder()

A FileLauncher.Builder object constructs a FileLauncher with the specified properties. Use the various set...() methods to set properties, and finish construction with FileLauncher.Builder.build().