Aire-One
/
awesome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

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 <psychon@znc.in>
This commit is contained in:
Uli Schlachter 2016-10-01 16:08:01 +02:00
parent 332681aaad
commit 6224fc6751
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/common/widget.ldoc
View File

@ -48,16 +48,18 @@
-- @function emit_signal_recursive -- @function emit_signal_recursive
--- When the layout (size) change. --- When the layout (size) change.
-- This signal is emited when the previous results of `:layout()` and `:fit()` -- This signal is emitted when the previous results of `:layout()` and `:fit()`
-- are no longer valid. -- 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 -- @signal widget::layout_changed
-- @see widget::redraw_needed -- @see widget::redraw_needed
--- When the widget content changed. --- When the widget content changed.
-- Unless this signal is emitted, `:layout()` and `:fit()` must return the same -- This signal is emitted when the content of the widget changes. The widget will
-- result when called with the same arguments. In case this isn't the case, -- be redrawn, it is not re-layouted. Put differently, it is assumed that
-- use `widget::layout_changed`. -- `:layout()` and `:fit()` would still return the same results as before.
-- @signal widget::redraw_needed -- @signal widget::redraw_needed
-- @see widget::layout_changed
--- When a mouse button is pressed over the widget. --- When a mouse button is pressed over the widget.
-- The position of the mouse press relative to the widget while geometry -- The position of the mouse press relative to the widget while geometry