docs: Document the GtkApplication::quit signal behavior

And add Since: annotations to the GtkApplication signals.
This commit is contained in:
Emmanuele Bassi 2010-06-26 16:01:15 +01:00
parent 424842e3a9
commit 15646b6e74

View File

@ -346,8 +346,9 @@ static gchar *default_title;
*
* Adds a window to the #GtkApplication.
*
* If the user closes all of the windows added to @app, the default
* behaviour is to call gtk_application_quit().
* If all the windows managed by #GtkApplication are closed, the
* #GtkApplication will call gtk_application_quit(), and quit
* the application.
*
* If your application uses only a single toplevel window, you can
* use gtk_application_get_window(). If you are using a sub-class
@ -626,8 +627,9 @@ gtk_application_class_init (GtkApplicationClass *klass)
* example, when a file browser launches your program to open a
* file. The raw operating system arguments are passed in the
* variant @arguments.
*
* Since: 3.0
*/
gtk_application_signals[ACTIVATED] =
g_signal_new (g_intern_static_string ("activated"),
G_OBJECT_CLASS_TYPE (klass),
@ -647,10 +649,30 @@ gtk_application_class_init (GtkApplicationClass *klass)
* turn trigger this signal.
*
* The default handler for this signal exits the mainloop of the
* application.
* application. It is possible to override the default handler
* by simply returning %TRUE from a callback, e.g.:
*
* |[
* static gboolean
* my_application_quit (GtkApplication *application)
* {
* /* if some_condition is TRUE, do not quit */
* if (some_condition)
* return TRUE;
*
* /* this will cause the application to quit *
* return FALSE;
* }
*
* g_signal_connect (application, "quit",
* G_CALLBACK (my_application_quit),
* NULL);
* ]|
*
* Returns: %TRUE if the signal has been handled, %FALSE to continue
* signal emission
*
* Since: 3.0
*/
gtk_application_signals[QUIT] =
g_signal_new (g_intern_static_string ("quit"),
@ -674,6 +696,8 @@ gtk_application_class_init (GtkApplicationClass *klass)
* turn trigger this signal.
*
* The signal is never emitted for disabled actions.
*
* Since: 3.0
*/
gtk_application_signals[ACTION] =
g_signal_new (g_intern_static_string ("action"),