luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-23 22:16:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

GApplication: Beef up the local_command_line() docs

Browse Source 
This adds some details, such as the meaning of @argc, @argv and @status,
even though gtk-doc does not make it easy to document vfunc arguments.
Requested in
https://bugzilla.gnome.org/show_bug.cgi?id=643478
This commit is contained in:
Matthias Clasen 2011-03-04 00:03:13 -05:00
parent f05bce027e
commit 1a6455b785
1 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
gio/gapplication.c
View File

@ -1165,9 +1165,19 @@ g_application_open (GApplication *application,
* is intended to be returned by main().
*
* First, the local_command_line() virtual function is invoked.
* This function always runs on the local instance. If it returns
* %FALSE then the application is registered and the
* #GApplication::command-line signal is emitted in the primary
* This function always runs on the local instance. It gets passed
* pointers to @argc and @argv and is expected to remove the arguments
* that it handled from @argv (shifting up remaining arguments, and
* reducing @argc accordingly). See <xref linkend="gapplication-example-cmdline2"/> for an example. The last argument to local_command_line() is a
* pointer to the @status variable which can used to set the exit
* status that is returned from g_application_run().
*
* If local_command_line() returns %TRUE, the command line is expected
* to be completely handled, including possibly registering as the primary
* instance, calling g_application_activate() or g_application_open(), etc.
*
* If local_command_line() returns %FALSE then the application is registered
* and the #GApplication::command-line signal is emitted in the primary
* instance (which may or may not be this instance).
*
* If the application has the %G_APPLICATION_HANDLES_COMMAND_LINE
@ -1186,7 +1196,9 @@ g_application_open (GApplication *application,
*
* If you are interested in doing more complicated local handling of the
* commandline then you should implement your own #GApplication subclass
* and override local_command_line(). See
* and override local_command_line(). In this case, you most likely want
* to return %TRUE from your local_command_line() implementation to
* suppress the default handling. See
* <xref linkend="gapplication-example-cmdline2"/> for an example.
*
* If, after the above is done, the use count of the application is zero