From 6224fc6751fef1bfd84beee8afd37812b465d5aa Mon Sep 17 00:00:00 2001 From: Uli Schlachter Date: Sat, 1 Oct 2016 16:08:01 +0200 Subject: [PATCH] Improve docs for widget::layout_changed and redraw_needed The docs for widget::redraw_needed was previously just plain wrong! Signed-off-by: Uli Schlachter --- docs/common/widget.ldoc | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/common/widget.ldoc b/docs/common/widget.ldoc index ec215f5b9..c96e4fe38 100644 --- a/docs/common/widget.ldoc +++ b/docs/common/widget.ldoc @@ -48,16 +48,18 @@ -- @function emit_signal_recursive --- When the layout (size) change. --- This signal is emited when the previous results of `:layout()` and `:fit()` --- are no longer valid. +-- This signal is emitted when the previous results of `:layout()` and `:fit()` +-- are no longer valid. Unless this signal is emitted, `:layout()` and `:fit()` +-- must return the same result when called with the same arguments. -- @signal widget::layout_changed -- @see widget::redraw_needed --- When the widget content changed. --- Unless this signal is emitted, `:layout()` and `:fit()` must return the same --- result when called with the same arguments. In case this isn't the case, --- use `widget::layout_changed`. +-- This signal is emitted when the content of the widget changes. The widget will +-- be redrawn, it is not re-layouted. Put differently, it is assumed that +-- `:layout()` and `:fit()` would still return the same results as before. -- @signal widget::redraw_needed +-- @see widget::layout_changed --- When a mouse button is pressed over the widget. -- The position of the mouse press relative to the widget while geometry