Add inheritance tags to `docs/common/widget.ldoc`.
This commit is contained in:
parent
550e346d7b
commit
589908adef
|
@ -7,10 +7,12 @@
|
||||||
-- @return The parent layout
|
-- @return The parent layout
|
||||||
-- @return The path between self and widget
|
-- @return The path between self and widget
|
||||||
-- @method index
|
-- @method index
|
||||||
|
-- @baseclass wibox.widget
|
||||||
|
|
||||||
--- Get or set the children elements.
|
--- Get or set the children elements.
|
||||||
-- @property children
|
-- @property children
|
||||||
-- @tparam table children The children.
|
-- @tparam table children The children.
|
||||||
|
-- @baseclass wibox.widget
|
||||||
|
|
||||||
--- Get all direct and indirect children widgets.
|
--- Get all direct and indirect children widgets.
|
||||||
-- This will scan all containers recursively to find widgets
|
-- This will scan all containers recursively to find widgets
|
||||||
|
@ -18,27 +20,33 @@
|
||||||
-- children, contain (directly or indirectly) itself.
|
-- children, contain (directly or indirectly) itself.
|
||||||
-- @property all_children
|
-- @property all_children
|
||||||
-- @tparam table children The children.
|
-- @tparam table children The children.
|
||||||
|
-- @baseclass wibox.widget
|
||||||
|
|
||||||
--- Set a declarative widget hierarchy description.
|
--- Set a declarative widget hierarchy description.
|
||||||
-- See [The declarative layout system](../documentation/03-declarative-layout.md.html)
|
-- See [The declarative layout system](../documentation/03-declarative-layout.md.html)
|
||||||
-- @param args An array containing the widgets disposition
|
-- @param args An array containing the widgets disposition
|
||||||
-- @method setup
|
-- @method setup
|
||||||
|
-- @baseclass wibox.widget
|
||||||
|
|
||||||
--- Force a widget height.
|
--- Force a widget height.
|
||||||
-- @property forced_height
|
-- @property forced_height
|
||||||
-- @tparam number|nil height The height (`nil` for automatic)
|
-- @tparam number|nil height The height (`nil` for automatic)
|
||||||
|
-- @baseclass wibox.widget
|
||||||
|
|
||||||
--- Force a widget width.
|
--- Force a widget width.
|
||||||
-- @property forced_width
|
-- @property forced_width
|
||||||
-- @tparam number|nil width The width (`nil` for automatic)
|
-- @tparam number|nil width The width (`nil` for automatic)
|
||||||
|
-- @baseclass wibox.widget
|
||||||
|
|
||||||
--- The widget opacity (transparency).
|
--- The widget opacity (transparency).
|
||||||
-- @property opacity
|
-- @property opacity
|
||||||
-- @tparam[opt=1] number opacity The opacity (between 0 and 1)
|
-- @tparam[opt=1] number opacity The opacity (between 0 and 1)
|
||||||
|
-- @baseclass wibox.widget
|
||||||
|
|
||||||
--- The widget visibility.
|
--- The widget visibility.
|
||||||
-- @property visible
|
-- @property visible
|
||||||
-- @param boolean
|
-- @param boolean
|
||||||
|
-- @baseclass wibox.widget
|
||||||
|
|
||||||
--- The widget buttons.
|
--- The widget buttons.
|
||||||
--
|
--
|
||||||
|
@ -47,10 +55,12 @@
|
||||||
-- @property buttons
|
-- @property buttons
|
||||||
-- @param table
|
-- @param table
|
||||||
-- @see awful.button
|
-- @see awful.button
|
||||||
|
-- @baseclass wibox.widget
|
||||||
|
|
||||||
--- Add a new `awful.button` to this widget.
|
--- Add a new `awful.button` to this widget.
|
||||||
-- @tparam awful.button button The button to add.
|
-- @tparam awful.button button The button to add.
|
||||||
-- @function add_button
|
-- @function add_button
|
||||||
|
-- @baseclass wibox.widget
|
||||||
|
|
||||||
--- Emit a signal and ensure all parent widgets in the hierarchies also
|
--- Emit a signal and ensure all parent widgets in the hierarchies also
|
||||||
-- forward the signal. This is useful to track signals when there is a dynamic
|
-- forward the signal. This is useful to track signals when there is a dynamic
|
||||||
|
@ -58,6 +68,7 @@
|
||||||
-- @tparam string signal_name
|
-- @tparam string signal_name
|
||||||
-- @param ... Other arguments
|
-- @param ... Other arguments
|
||||||
-- @method emit_signal_recursive
|
-- @method emit_signal_recursive
|
||||||
|
-- @baseclass wibox.widget
|
||||||
|
|
||||||
--- When the layout (size) change.
|
--- When the layout (size) change.
|
||||||
-- This signal is emitted when the previous results of `:layout()` and `:fit()`
|
-- This signal is emitted when the previous results of `:layout()` and `:fit()`
|
||||||
|
@ -65,6 +76,7 @@
|
||||||
-- must return the same result when called with the same arguments.
|
-- 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
|
||||||
|
-- @baseclass wibox.widget
|
||||||
|
|
||||||
--- When the widget content changed.
|
--- When the widget content changed.
|
||||||
-- This signal is emitted when the content of the widget changes. The widget will
|
-- This signal is emitted when the content of the widget changes. The widget will
|
||||||
|
@ -72,6 +84,7 @@
|
||||||
-- `:layout()` and `:fit()` would still return the same results as before.
|
-- `:layout()` and `:fit()` would still return the same results as before.
|
||||||
-- @signal widget::redraw_needed
|
-- @signal widget::redraw_needed
|
||||||
-- @see widget::layout_changed
|
-- @see widget::layout_changed
|
||||||
|
-- @baseclass wibox.widget
|
||||||
|
|
||||||
--- When a mouse button is pressed over the widget.
|
--- When a mouse button is pressed over the widget.
|
||||||
-- @signal button::press
|
-- @signal button::press
|
||||||
|
@ -101,6 +114,7 @@
|
||||||
-- @tparam number find_widgets_result.widget_height The exact height of the widget
|
-- @tparam number find_widgets_result.widget_height The exact height of the widget
|
||||||
-- in its local coordinate system.
|
-- in its local coordinate system.
|
||||||
-- @see mouse
|
-- @see mouse
|
||||||
|
-- @baseclass wibox.widget
|
||||||
|
|
||||||
--- When a mouse button is released over the widget.
|
--- When a mouse button is released over the widget.
|
||||||
-- @signal button::release
|
-- @signal button::release
|
||||||
|
@ -130,6 +144,7 @@
|
||||||
-- @tparam number find_widgets_result.widget_height The exact height of the widget
|
-- @tparam number find_widgets_result.widget_height The exact height of the widget
|
||||||
-- in its local coordinate system.
|
-- in its local coordinate system.
|
||||||
-- @see mouse
|
-- @see mouse
|
||||||
|
-- @baseclass wibox.widget
|
||||||
|
|
||||||
--- When the mouse enter a widget.
|
--- When the mouse enter a widget.
|
||||||
-- @signal mouse::enter
|
-- @signal mouse::enter
|
||||||
|
@ -153,6 +168,7 @@
|
||||||
-- @tparam number find_widgets_result.widget_height The exact height of the widget
|
-- @tparam number find_widgets_result.widget_height The exact height of the widget
|
||||||
-- in its local coordinate system.
|
-- in its local coordinate system.
|
||||||
-- @see mouse
|
-- @see mouse
|
||||||
|
-- @baseclass wibox.widget
|
||||||
|
|
||||||
--- When the mouse leave a widget.
|
--- When the mouse leave a widget.
|
||||||
-- @signal mouse::leave
|
-- @signal mouse::leave
|
||||||
|
@ -176,3 +192,4 @@
|
||||||
-- @tparam number find_widgets_result.widget_height The exact height of the widget
|
-- @tparam number find_widgets_result.widget_height The exact height of the widget
|
||||||
-- in its local coordinate system.
|
-- in its local coordinate system.
|
||||||
-- @see mouse
|
-- @see mouse
|
||||||
|
-- @baseclass wibox.widget
|
||||||
|
|
Loading…
Reference in New Issue