Add documentation to showall (#612)

JuliaGraphics · Jan 16, 2022 · d377ac6 · d377ac6
1 parent cea01eb
commit d377ac6
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/base.jl b/src/base.jl
@@ -46,6 +46,14 @@ function show(w::GtkWidget)
     @sigatom ccall((:gtk_widget_show, libgtk), Nothing, (Ptr{GObject},), w)
     w
 end
+
+"""
+    showall(w::Gtk.GtkWidget)
+Recursively show a widget, and any child widgets (if the widget is a container).
+
+This function overrides the `visible` property in all widgets in the hierarchy. Widgets can be
+protected from `showall` by setting the `no_show_all` property on the object to `true`.
+"""
 function showall(w::GtkWidget)
     handle_auto_idle(w)
     @sigatom ccall((:gtk_widget_show_all, libgtk), Nothing, (Ptr{GObject},), w)