Merge branch 'wip/dboles/overlay-docs-3' into 'gtk-3-24'

Overlay: small improvements to documentation

See merge request GNOME/gtk!932
This commit is contained in:
Matthias Clasen 2019-06-21 00:45:12 +00:00
commit 7b42bade95
2 changed files with 13 additions and 11 deletions

View File

@ -534,13 +534,13 @@ gtk_overlay_remove (GtkContainer *container,
* gtk_overlay_reorder_overlay:
* @overlay: a #GtkOverlay
* @child: the overlaid #GtkWidget to move
* @position: the new index for @child in the list of overlay children
* @index_: the new index for @child in the list of overlay children
* of @overlay, starting from 0. If negative, indicates the end of
* the list
*
* Moves @child to a new @index in the list of @overlay children.
* The list contains overlays in the order that these were
* added to @overlay.
* added to @overlay by default. See also #GtkOverlay:index.
*
* A widgets index in the @overlay children list determines which order
* the children are drawn if they overlap. The first child is drawn at
@ -551,7 +551,7 @@ gtk_overlay_remove (GtkContainer *container,
void
gtk_overlay_reorder_overlay (GtkOverlay *overlay,
GtkWidget *child,
gint position)
int index_)
{
GtkOverlayPrivate *priv;
GSList *old_link;
@ -580,15 +580,15 @@ gtk_overlay_reorder_overlay (GtkOverlay *overlay,
g_return_if_fail (old_link != NULL);
if (position < 0)
if (index_ < 0)
{
new_link = NULL;
index = g_slist_length (priv->children) - 1;
}
else
{
new_link = g_slist_nth (priv->children, position);
index = MIN (position, g_slist_length (priv->children) - 1);
new_link = g_slist_nth (priv->children, index_);
index = MIN (index_, g_slist_length (priv->children) - 1);
}
if (index == old_index)
@ -774,7 +774,8 @@ gtk_overlay_class_init (GtkOverlayClass *klass)
/**
* GtkOverlay:pass-through:
*
* Pass through input, does not affect main child.
* Whether to pass input through the overlay child to the main child.
* (Of course, this has no effect when set on the main child itself.)
*
* Since: 3.18
*/
@ -786,7 +787,8 @@ gtk_overlay_class_init (GtkOverlayClass *klass)
/**
* GtkOverlay:index:
*
* The index of the overlay in the parent, -1 for the main child.
* The index of the overlay child in the parent (or -1 for the main child).
* See gtk_overlay_reorder_overlay().
*
* Since: 3.18
*/

View File

@ -86,7 +86,7 @@ void gtk_overlay_add_overlay (GtkOverlay *overlay,
GDK_AVAILABLE_IN_3_18
void gtk_overlay_reorder_overlay (GtkOverlay *overlay,
GtkWidget *child,
gint position);
int index_);
GDK_AVAILABLE_IN_3_18
gboolean gtk_overlay_get_overlay_pass_through (GtkOverlay *overlay,
GtkWidget *widget);