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.
This commit is contained in:
Daniel Boles 2018-01-12 21:22:11 +00:00
parent f8d235ecc2
commit 339d355dda

View File

@ -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.
*