GtkFileChooserNative: documentation updated
authorTom Schoonjans <Tom.Schoonjans@diamond.ac.uk>
Sun, 9 Jul 2017 17:04:06 +0000 (18:04 +0100)
committerMatthias Clasen <mclasen@redhat.com>
Tue, 18 Jul 2017 17:48:13 +0000 (13:48 -0400)
https://bugzilla.gnome.org/show_bug.cgi?id=784723

gtk/gtkfilechoosernative.c

index 7314fd67c8f6af3e137372841efcd1d0899d2586..8476bcdc411a99caf6a88fad99138cc00bf4a64e 100644 (file)
@@ -50,8 +50,8 @@
  * #GtkFileChooserNative is an abstraction of a dialog box suitable
  * for use with “File/Open” or “File/Save as” commands. By default, this
  * just uses a #GtkFileChooserDialog to implement the actual dialog.
- * However, on certain platforms, such as Windows, the native platform
- * file chooser is uses instead. When the application is running in a
+ * However, on certain platforms, such as Windows and macOS, the native platform
+ * file chooser is used instead. When the application is running in a
  * sandboxed environment without direct filesystem access (such as Flatpak),
  * #GtkFileChooserNative may call the proper APIs (portals) to let the user
  * choose a file and make it available to the application.
  * * Use of custom previews by connecting to #GtkFileChooser::update-preview.
  *
  * * Any #GtkFileFilter added with a custom filter.
+ *
+ * ## macOS details ## {#gtkfilechooserdialognative-macos}
+ *
+ * On macOS the NSSavePanel and NSOpenPanel classes are used to provide native
+ * file chooser dialogs. Some features provided by #GtkFileChooserDialog are
+ * not supported:
+ *
+ * * Extra widgets added with gtk_file_chooser_set_extra_widget(), unless the
+ *   widget is an instance of GtkLabel, in which case the label text will be used
+ *   to set the NSSavePanel message instance property.
+ *
+ * * Use of custom previews by connecting to #GtkFileChooser::update-preview.
+ *
+ * * Any #GtkFileFilter added with a custom filter.
+ *
+ * * Shortcut folders.
  */
 
 enum {