[gtk+] Some documentation updates
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+] Some documentation updates
- Date: Mon, 30 Oct 2017 23:31:16 +0000 (UTC)
commit a1a5f556cbd94dc7126e3a348d028a0a9f5baf01
Author: Matthias Clasen <mclasen redhat com>
Date: Mon Oct 30 18:58:05 2017 -0400
Some documentation updates
Document gtk_settings_get_for_display instead of for_screen.
docs/reference/gtk/gtk4-sections.txt | 1 +
gtk/gtksettings.c | 22 ++++++++++++++++------
2 files changed, 17 insertions(+), 6 deletions(-)
---
diff --git a/docs/reference/gtk/gtk4-sections.txt b/docs/reference/gtk/gtk4-sections.txt
index 5768d2c..0159e8e 100644
--- a/docs/reference/gtk/gtk4-sections.txt
+++ b/docs/reference/gtk/gtk4-sections.txt
@@ -2642,6 +2642,7 @@ GtkSettings
GtkSettingsValue
gtk_settings_get_default
gtk_settings_get_for_screen
+gtk_settings_get_for_display
gtk_rc_property_parse_color
gtk_rc_property_parse_enum
gtk_rc_property_parse_flags
diff --git a/gtk/gtksettings.c b/gtk/gtksettings.c
index 94c4c83..0426ab4 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)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]