summaryrefslogtreecommitdiff
path: root/gio/src/applicationcommandline.hg
diff options
context:
space:
mode:
authorJosé Alburquerque <jaalburqu@svn.gnome.org>2012-02-20 14:10:15 -0500
committerJosé Alburquerque <jaalburqu@svn.gnome.org>2012-02-20 14:10:15 -0500
commitdcb9aaf817387feda52f5cad54cf20b40017f6a0 (patch)
tree3255e6e84c0be04786bf8c9bff1e3986929eb3ac /gio/src/applicationcommandline.hg
parent109101611a989a32d0ddc769dbfe799f08d0696c (diff)
downloadglibmm-dcb9aaf817387feda52f5cad54cf20b40017f6a0.tar.gz
giomm: Add the RemoteActionGroup interface.
* gio/src/remoteactiongroup.{ccg,hg}: * gio/src/filelist.am: Add the sources, wrapping the methods and virtual functions, and include them in the list of files to be built. * gio/src/gio_vfuncs.defs: Add the GRemoteActionGroup virtual functions. * gio/src/applicationcommandline.hg: Add the class documentation block.
Diffstat (limited to 'gio/src/applicationcommandline.hg')
-rw-r--r--gio/src/applicationcommandline.hg28
1 files changed, 28 insertions, 0 deletions
diff --git a/gio/src/applicationcommandline.hg b/gio/src/applicationcommandline.hg
index 58d11397..023d27d2 100644
--- a/gio/src/applicationcommandline.hg
+++ b/gio/src/applicationcommandline.hg
@@ -24,6 +24,34 @@ _PINCLUDE(glibmm/private/object_p.h)
namespace Gio
{
+/** ApplicationCommandLine - A command-line invocation of an application.
+ * ApplicationCommandLine represents a command-line invocation of an
+ * application. It is created by Application and emitted in the "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 local (ie:
+ * the current process is running in direct response to the invocation) or
+ * remote (ie: some other process forwarded the commandline to this process).
+ *
+ * The ApplicationCommandLine object can provide the argc and argv parameters
+ * for use with the Glib::OptionContext command-line parsing API, with the
+ * get_arguments() method.
+ *
+ * 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 of this object (ie: the
+ * process exits when the last reference is dropped).
+ *
+ * The main use for ApplicationCommandline (and the "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.
+ * @newin{2,32}
+ */
class ApplicationCommandLine : public Glib::Object
{
_CLASS_GOBJECT(ApplicationCommandLine, GApplicationCommandLine, G_APPLICATION_COMMAND_LINE, Glib::Object, GObject)