nativedialog: Add more docs
authorMatthias Clasen <mclasen@redhat.com>
Mon, 1 Feb 2021 01:22:59 +0000 (20:22 -0500)
committerMatthias Clasen <mclasen@redhat.com>
Mon, 1 Feb 2021 01:25:44 +0000 (20:25 -0500)
Emphasize that native dialogs aren't widgets, and are not
kept alive by GTK.

gtk/gtkfilechoosernative.c
gtk/gtknativedialog.c

index 597deb5256194cc0e2964a03f8cb87400ae149e7..067d2b19f644cabb08105964a890fc9a5f998d8b 100644 (file)
  * Showing, hiding and running the dialog is handled by the #GtkNativeDialog
  * functions.
  *
+ * Note that unlike #GtkFileChooserDialog, #GtkFileChooserNative objects are
+ * not toplevel widgets, and GTK does not keep them alive. It is your
+ * responsibility to keep a reference until you are done with the
+ * object.
+
  * ## Typical usage ## {#gtkfilechoosernative-typical-usage}
  *
  * In the simplest of cases, you can the following code to use
index 4b28a4204109f2e752c62eef48ab34654f667b70..73ad13ea3a67f2f4d4a1fc7bac05dc139762e9d9 100644 (file)
  * various common properties on the dialog, as well as show and hide
  * it and get a #GtkNativeDialog::response signal when the user finished
  * with the dialog.
+ *
+ * Note that unlike #GtkDialog, #GtkNativeDialog objects are not
+ * toplevel widgets, and GTK does not keep them alive. It is your
+ * responsibility to keep a reference until you are done with the
+ * object.
  */
 
 typedef struct _GtkNativeDialogPrivate GtkNativeDialogPrivate;