Package org.gnome.gio

Class AppLaunchContext

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.AppLaunchContext

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

AppLaunchContext

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

Integrating the launch with the launching application. This is used to handle for instance startup notification and launching the new application on the same screen as the launching window.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AppLaunchContext.AppLaunchContextClass
static class	AppLaunchContext.Builder<B extends AppLaunchContext.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	AppLaunchContext.LaunchedCallback	Functional interface declaration of the LaunchedCallback callback.
static interface	AppLaunchContext.LaunchFailedCallback	Functional interface declaration of the LaunchFailedCallback callback.
static interface	AppLaunchContext.LaunchStartedCallback	Functional interface declaration of the LaunchStartedCallback callback.

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
AppLaunchContext()	Creates a new application launch context.
AppLaunchContext(MemorySegment address)	Create a AppLaunchContext proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected AppLaunchContext	asParent()	Returns this instance as if it were its parent type.
static AppLaunchContext.Builder<? extends AppLaunchContext.Builder>	builder()	A AppLaunchContext.Builder object constructs a AppLaunchContext with the specified properties.
void	emitLaunched(AppInfo info, Variant platformData)	Emits the "launched" signal.
void	emitLaunchFailed(String startupNotifyId)	Emits the "launch-failed" signal.
void	emitLaunchStarted(AppInfo info, @Nullable Variant platformData)	Emits the "launch-started" signal.
String	getDisplay(AppInfo info, List<File> files)	Gets the display string for the this AppLaunchContext.
String[]	getEnvironment()	Gets the complete environment variable list to be passed to the child process when this AppLaunchContext is used to launch an application.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
String	getStartupNotifyId(@Nullable AppInfo info, @Nullable List<File> files)	Initiates startup notification for the application and returns the XDG_ACTIVATION_TOKEN or DESKTOP_STARTUP_ID for the launched operation, if supported.
static Type	getType()	Get the GType of the AppLaunchContext class
protected void	launched(AppInfo info, Variant platformData)
void	launchFailed(String startupNotifyId)	Called when an application has failed to launch, so that it can cancel the application startup notification started in getStartupNotifyId(org.gnome.gio.AppInfo, org.gnome.glib.List<org.gnome.gio.File>).
protected void	launchStarted(AppInfo info, Variant platformData)
SignalConnection<AppLaunchContext.LaunchedCallback>	onLaunched(AppLaunchContext.LaunchedCallback handler)	The Gio.AppLaunchContext::launched signal is emitted when a AppInfo is successfully launched.
SignalConnection<AppLaunchContext.LaunchFailedCallback>	onLaunchFailed(AppLaunchContext.LaunchFailedCallback handler)	The Gio.AppLaunchContext::launch-failed signal is emitted when a AppInfo launch fails.
SignalConnection<AppLaunchContext.LaunchStartedCallback>	onLaunchStarted(AppLaunchContext.LaunchStartedCallback handler)	The Gio.AppLaunchContext::launch-started signal is emitted when a AppInfo is about to be launched.
void	setenv(String variable, String value)	Arranges for variable to be set to value in the child’s environment when this AppLaunchContext is used to launch an application.
void	unsetenv(String variable)	Arranges for variable to be unset in the child’s environment when this AppLaunchContext is used to launch an application.

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

AppLaunchContext

public AppLaunchContext(MemorySegment address)

Create a AppLaunchContext proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

AppLaunchContext

public AppLaunchContext()

Creates a new application launch context. This is not normally used, instead you instantiate a subclass of this, such as GdkAppLaunchContext.

Method Details

getType

public static Type getType()

Get the GType of the AppLaunchContext class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected AppLaunchContext 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

getDisplay

public String getDisplay(AppInfo info,
 List<File> files)

Gets the display string for the this AppLaunchContext. This is used to ensure new applications are started on the same display as the launching application, by setting the DISPLAY environment variable.

Parameters:

info - the app info

files - a list of File objects

Returns:

a display string for the display.

getEnvironment

public String[] getEnvironment()

Gets the complete environment variable list to be passed to the child process when this AppLaunchContext is used to launch an application. This is a NULL-terminated array of strings, where each string has the form KEY=VALUE.

Returns:

the child’s environment

getStartupNotifyId

public String getStartupNotifyId(@Nullable
 @Nullable AppInfo info,
 @Nullable
 @Nullable List<File> files)

Initiates startup notification for the application and returns the XDG_ACTIVATION_TOKEN or DESKTOP_STARTUP_ID for the launched operation, if supported.

The returned token may be referred to equivalently as an ‘activation token’ (using Wayland terminology) or a ‘startup sequence ID’ (using X11 terminology). The two are interoperable.

Activation tokens are defined in the XDG Activation Protocol, and startup notification IDs are defined in the freedesktop.org Startup Notification Protocol.

Support for the XDG Activation Protocol was added in GLib 2.76. Since GLib 2.82 info and files can be NULL. If that’s not supported by the backend, the returned token will be NULL.

Parameters:

info - the app info

files - a list of File objects

Returns:

a startup notification ID for the application, or NULL if not supported.

launchFailed

public void launchFailed(String startupNotifyId)

Called when an application has failed to launch, so that it can cancel the application startup notification started in getStartupNotifyId(org.gnome.gio.AppInfo, org.gnome.glib.List<org.gnome.gio.File>).

Parameters:

startupNotifyId - the startup notification id that was returned by getStartupNotifyId(org.gnome.gio.AppInfo, org.gnome.glib.List<org.gnome.gio.File>).

setenv

public void setenv(String variable,
 String value)

Arranges for variable to be set to value in the child’s environment when this AppLaunchContext is used to launch an application.

Parameters:

variable - the environment variable to set

value - the value for to set the variable to.

unsetenv

public void unsetenv(String variable)

Arranges for variable to be unset in the child’s environment when this AppLaunchContext is used to launch an application.

Parameters:

variable - the environment variable to remove

launchStarted

protected void launchStarted(AppInfo info,
 Variant platformData)

launched

protected void launched(AppInfo info,
 Variant platformData)

onLaunchFailed

public SignalConnection<AppLaunchContext.LaunchFailedCallback> onLaunchFailed(AppLaunchContext.LaunchFailedCallback handler)

The Gio.AppLaunchContext::launch-failed signal is emitted when a AppInfo launch fails. The startup notification id is provided, so that the launcher can cancel the startup notification.

Because a launch operation may involve spawning multiple instances of the target application, you should expect this signal to be emitted multiple times, one for each spawned instance.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• AppLaunchContext.LaunchFailedCallback.run(java.lang.String)

emitLaunchFailed

public void emitLaunchFailed(String startupNotifyId)

Emits the "launch-failed" signal. See onLaunchFailed(org.gnome.gio.AppLaunchContext.LaunchFailedCallback).

onLaunchStarted

public SignalConnection<AppLaunchContext.LaunchStartedCallback> onLaunchStarted(AppLaunchContext.LaunchStartedCallback handler)

The Gio.AppLaunchContext::launch-started signal is emitted when a AppInfo is about to be launched. If non-null the platformData is an GVariant dictionary mapping strings to variants (ie a{sv}), which contains additional, platform-specific data about this launch. On UNIX, at least the startup-notification-id keys will be present.

The value of the startup-notification-id key (type s) is a startup notification ID corresponding to the format from the [startup-notification specification](https://specifications.freedesktop.org/startup-notification-spec/startup-notification-0.1.txt). It allows tracking the progress of the launchee through startup.

It is guaranteed that this signal is followed by either a Gio.AppLaunchContext::launched or Gio.AppLaunchContext::launch-failed signal.

Because a launch operation may involve spawning multiple instances of the target application, you should expect this signal to be emitted multiple times, one for each spawned instance.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• AppLaunchContext.LaunchStartedCallback.run(org.gnome.gio.AppInfo, org.gnome.glib.Variant)

emitLaunchStarted

public void emitLaunchStarted(AppInfo info,
 @Nullable
 @Nullable Variant platformData)

Emits the "launch-started" signal. See onLaunchStarted(org.gnome.gio.AppLaunchContext.LaunchStartedCallback).

onLaunched

public SignalConnection<AppLaunchContext.LaunchedCallback> onLaunched(AppLaunchContext.LaunchedCallback handler)

The Gio.AppLaunchContext::launched signal is emitted when a AppInfo is successfully launched.

Because a launch operation may involve spawning multiple instances of the target application, you should expect this signal to be emitted multiple times, one time for each spawned instance.

The platformData is an GVariant dictionary mapping strings to variants (ie a{sv}), which contains additional, platform-specific data about this launch. On UNIX, at least the pid and startup-notification-id keys will be present.

Since 2.72 the pid may be 0 if the process id wasn’t known (for example if the process was launched via D-Bus). The pid may not be set at all in subsequent releases.

On Windows, pid is guaranteed to be valid only for the duration of the Gio.AppLaunchContext::launched signal emission; after the signal is emitted, GLib will call GLib.spawnClosePid(org.gnome.glib.Pid). If you need to keep the GLib.Pid after the signal has been emitted, then you can duplicate pid using DuplicateHandle().

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• AppLaunchContext.LaunchedCallback.run(org.gnome.gio.AppInfo, org.gnome.glib.Variant)

emitLaunched

public void emitLaunched(AppInfo info,
 Variant platformData)

Emits the "launched" signal. See onLaunched(org.gnome.gio.AppLaunchContext.LaunchedCallback).

builder

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

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