[gtk+] Window: Clarify resize() doc about titlebar widget



commit 339d355ddad30552baae6ea12c5e08115e9cb2b9
Author: Daniel Boles <dboles src gnome org>
Date:   Fri Jan 12 21:22:11 2018 +0000

    Window: Clarify resize() doc about titlebar widget
    
    Clarify the reference to HeaderBar, as it applies to any custom title
    widget; HeaderBar is only the most common one used. Also, fix a typo.

 gtk/gtkwindow.c |   11 ++++++-----
 1 files changed, 6 insertions(+), 5 deletions(-)
---
diff --git a/gtk/gtkwindow.c b/gtk/gtkwindow.c
index 99d5891..1f41e00 100644
--- a/gtk/gtkwindow.c
+++ b/gtk/gtkwindow.c
@@ -5359,16 +5359,17 @@ gtk_window_get_default_size (GtkWindow *window,
  * When using client side decorations, GTK+ will do its best to adjust
  * the given size so that the resulting window size matches the
  * requested size without the title bar, borders and shadows added for
- * the client side decorations, but there is no garantee that the
+ * the client side decorations, but there is no guarantee that the
  * result will be totally accurate because these widgets added for
  * client side decorations depend on the theme and may not be realized
  * or visible at the time gtk_window_resize() is issued.
  *
- * Typically, gtk_window_resize() will compensate for the GtkHeaderBar
- * height only if it's known at the time the resulting GtkWindow
- * configuration is issued.
+ * If the GtkWindow has a titlebar widget (see gtk_window_set_titlebar()), then
+ * typically, gtk_window_resize() will compensate for the height of the titlebar
+ * widget only if the height is known when the resulting GtkWindow configuration
+ * is issued.
  * For example, if new widgets are added after the GtkWindow configuration
- * and cause the GtkHeaderBar to grow in height, this will result in a
+ * and cause the titlebar widget to grow in height, this will result in a
  * window content smaller that specified by gtk_window_resize() and not
  * a larger window.
  *


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]