summaryrefslogtreecommitdiff
path: root/gtk/gtksettings.c
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2017-10-30 18:58:05 -0400
committerMatthias Clasen <mclasen@redhat.com>2017-10-30 18:59:41 -0400
commita1a5f556cbd94dc7126e3a348d028a0a9f5baf01 (patch)
treed293a73efd5c60e156308b5a30813f9a3055c73a /gtk/gtksettings.c
parent154117218caaf18cc2cd9dfd6d712dbf7bb54c02 (diff)
downloadgtk+-a1a5f556cbd94dc7126e3a348d028a0a9f5baf01.tar.gz
Some documentation updates
Document gtk_settings_get_for_display instead of for_screen.
Diffstat (limited to 'gtk/gtksettings.c')
-rw-r--r--gtk/gtksettings.c22
1 files changed, 16 insertions, 6 deletions
diff --git a/gtk/gtksettings.c b/gtk/gtksettings.c
index 94c4c83dcd..0426ab46db 100644
--- a/gtk/gtksettings.c
+++ b/gtk/gtksettings.c
@@ -100,10 +100,10 @@
* g_object_set (gtk_settings_get_default (), "gtk-enable-animations", FALSE, NULL);
* ]|
*
- * There is one GtkSettings instance per screen. It can be obtained with
- * gtk_settings_get_for_screen(), but in many cases, it is more convenient
+ * There is one GtkSettings instance per display. It can be obtained with
+ * gtk_settings_get_for_display(), but in many cases, it is more convenient
* to use gtk_widget_get_settings(). gtk_settings_get_default() returns the
- * GtkSettings instance for the default screen.
+ * GtkSettings instance for the default display.
*/
@@ -1247,6 +1247,16 @@ gtk_settings_create_for_display (GdkDisplay *display)
return settings;
}
+/**
+ * gtk_settings_get_for_display:
+ * @screen: a #GdkDisplay
+ *
+ * Gets the #GtkSettings object for @display, creating it if necessary.
+ *
+ * Returns: (transfer none): a #GtkSettings object.
+ *
+ * Since: 3.94
+ */
GtkSettings *
gtk_settings_get_for_display (GdkDisplay *display)
{
@@ -1288,11 +1298,11 @@ gtk_settings_get_for_screen (GdkScreen *screen)
/**
* gtk_settings_get_default:
*
- * Gets the #GtkSettings object for the default GDK screen, creating
- * it if necessary. See gtk_settings_get_for_screen().
+ * Gets the #GtkSettings object for the default display, creating
+ * it if necessary. See gtk_settings_get_for_display().
*
* Returns: (nullable) (transfer none): a #GtkSettings object. If there is
- * no default screen, then returns %NULL.
+ * no default display, then returns %NULL.
**/
GtkSettings*
gtk_settings_get_default (void)