Back to Seed Clases

Gio

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gio.ApplicationCommandLine

Class Gio.ApplicationCommandLine

Import line:	Gio = imports.gi.Gio;
GIR File:	Gio-2.0.gir
C documentation:	GApplicationCommandLine
Class :	ApplicationCommandLine
Extends:	GObject.Object

GApplicationCommandLine represents a command-line invocation of
an application. It is created by GApplication and emitted
in the GApplication::command-line signal and virtual function.
The class contains the list of arguments that the program was invoked
with. It is also possible to query if the commandline invocation was
commandline to this process).
The GApplicationCommandLine object can provide the argc and argv
parameters for use with the GOptionContext command-line parsing API,
with the g_application_command_line_get_arguments() function. See
for an example.
The exit status of the originally-invoked process may be set and
messages can be printed to stdout or stderr of that process. The
lifecycle of the originally-invoked process is tied to the lifecycle
dropped).
The main use for GApplicationCommandline (and the
GApplication::command-line signal) is 'Emacs server' like use cases:
You can set the EDITOR environment variable to have
e.g. git use your favourite editor to edit commit messages, and if you
already have an instance of the editor running, the editing will happen
in the running instance, instead of opening a new one. An important
aspect of this use case is that the process that gets started by git
does not return until the editing is done.
Handling commandline arguments with GApplication

A simple example where the commandline is completely handled
in the GApplication::command-line handler. The launching instance exits
once the signal handler in the primary instance has returned, and the
return value of the signal handler becomes the exit status of the launching
instance.

FIXME: MISSING XINCLUDE CONTENT

Split commandline handling

An example of split commandline handling. Options that start with
--local- are handled locally, all other options are
passed to the GApplication::command-line handler which runs in the primary
instance.

FIXME: MISSING XINCLUDE CONTENT

Deferred commandline handling

An example of deferred commandline handling. Here, the commandline is
not completely handled before the GApplication::command-line handler
returns. Instead, we keep a reference to the GApplicationCommandline
object and handle it later(in this example, in an idle). Note that it
is necessary to hold the application until you are done with the
commandline.

This example also shows how to use GOptionContext for parsing the
commandline arguments.

FIXME: MISSING XINCLUDE CONTENT

Properties
Properties		Defined By
	arguments : GLib.Variant	Gio.ApplicationCommandLine
	is_remote : gboolean read only	Gio.ApplicationCommandLine
	parent_instance : GObject.Object read only	Gio.ApplicationCommandLine
	platform_data : GLib.Variant	Gio.ApplicationCommandLine
	priv : Gio.ApplicationCommandLinePrivate read only	Gio.ApplicationCommandLine

Methods / Constructors
Method / Constructor		Defined By
	new Gio.ApplicationCommandLine (Object *properties) Create a new Gio.ApplicationCommandLine Create a new Gio.ApplicationCommandLine Parameters: Object properties*
	get_arguments (Object *out_values) : Array Gets the list of arguments that was passed on the command line. Gets the list of arguments that was passed on the command line. The strings in the array may contain non-utf8 data. The return value is NULL-terminated and should be freed using g_strfreev(). containing the arguments (the argv) Parameters: Object out_values* gint32 argc Returns: Array the string array	Gio.ApplicationCommandLine
	get_cwd () : String Gets the working directory of the command line invocation. Gets the working directory of the command line invocation. The string may contain non-utf8 data. It is possible that the remote application did not send a working directory, so this may be NULL. The return value should not be modified or freed and is valid for as long as cmdline exists. Returns: String the current directory, or NULL	Gio.ApplicationCommandLine
	get_environ () : Array Gets the contents of the 'environ' variable of the command line invocation, as would be returned by g_get_environ(), ie as a NULL-terminated list of strings in the form 'NAME=VALUE'. Gets the contents of the 'environ' variable of the command line invocation, as would be returned by g_get_environ(), ie as a NULL-terminated list of strings in the form 'NAME=VALUE'. The strings may contain non-utf8 data. The remote application usually does not send an environment. Use G_APPLICATION_SEND_ENVIRONMENT to affect that. Even with this flag set it is possible that the environment is still not available (due to invocation messages from other applications). The return value should not be modified or freed and is valid for as long as cmdline exists. See g_application_command_line_getenv() if you are only interested in the value of a single environment variable. strings, or NULL if they were not sent Returns: Array the environment	Gio.ApplicationCommandLine
	get_exit_status () : gint32 Gets the exit status of cmdline. Gets the exit status of cmdline. See g_application_command_line_set_exit_status() for more information. Returns: gint32 the exit status	Gio.ApplicationCommandLine
	get_is_remote () : gboolean Determines if cmdline represents a remote invocation. Determines if cmdline represents a remote invocation. Returns: gboolean TRUE if the invocation was remote	Gio.ApplicationCommandLine
	get_platform_data () : GLib.Variant Gets the platform data associated with the invocation of cmdline. Gets the platform data associated with the invocation of cmdline. This is a GVariant dictionary containing information about the context in which the invocation occured. It typically contains information like the current working directory and the startup notification ID. For local invocation, it will be NULL. Returns: GLib.Variant the platform data, or NULL	Gio.ApplicationCommandLine
	getenv (String *name) : String Gets the value of a particular environment variable of the command line invocation, as would be returned by g_getenv(). Gets the value of a particular environment variable of the command line invocation, as would be returned by g_getenv(). The strings may contain non-utf8 data. The remote application usually does not send an environment. Use G_APPLICATION_SEND_ENVIRONMENT* to affect that. Even with this flag set it is possible that the environment is still not available (due to invocation messages from other applications). The return value should not be modified or freed and is valid for as long as cmdline exists. Parameters: String name Required (not null) the environment variable to get Returns: String the value of the variable, or NULL if unset or unsent	Gio.ApplicationCommandLine
	set_exit_status (gint32 *exit_status) : none Sets the exit status that will be used when the invoking process exits. Sets the exit status that will be used when the invoking process exits. The return value of the GApplication::command-line signal is passed to this function when the handler returns. This is the usual way of setting the exit status. In the event that you want the remote invocation to continue running and want to decide on the exit status in the future, you can use this call. For the case of a remote invocation, the remote process will typically exit when the last reference is dropped on cmdline. The exit status of the remote process will be equal to the last value that was set with this function. In the case that the commandline invocation is local, the situation is slightly more complicated. If the commandline invocation results increased to a non-zero value) then the application is considered to have been 'successful' in a certain sense, and the exit status is always zero. If the application use count is zero, though, the exit status of the local GApplicationCommandLine* is used. Parameters: gint32 exit_status Required (not null) the exit status Returns: none	Gio.ApplicationCommandLine

Events
None

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gio.Application Signal	command_line (Application *self, ApplicationCommandLine command_line*) : gint32 The ::command-line signal is emitted on the primary instance when a commandline is not handled locally.