wibox.container.margin: Update the property documentation.
This commit is contained in:
parent
268c66584e
commit
534c2324ae
|
@ -74,7 +74,7 @@ end
|
||||||
--- The widget to be wrapped the the margins.
|
--- The widget to be wrapped the the margins.
|
||||||
--
|
--
|
||||||
-- @property widget
|
-- @property widget
|
||||||
-- @tparam widget widget The widget
|
-- @tparam[opt=nil] widget|nil widget
|
||||||
-- @interface container
|
-- @interface container
|
||||||
|
|
||||||
margin.set_widget = base.set_widget_common
|
margin.set_widget = base.set_widget_common
|
||||||
|
@ -94,8 +94,15 @@ end
|
||||||
--- Set all the margins to val.
|
--- Set all the margins to val.
|
||||||
--
|
--
|
||||||
-- @property margins
|
-- @property margins
|
||||||
-- @tparam number|table margins The margin value. It can be a number or a table with
|
-- @tparam[opt=0] number|table margins
|
||||||
-- the *left*/*right*/*top*/*bottom* keys.
|
-- @tparam[opt=0] number margins.left
|
||||||
|
-- @tparam[opt=0] number margins.right
|
||||||
|
-- @tparam[opt=0] number margins.top
|
||||||
|
-- @tparam[opt=0] number margins.bottom
|
||||||
|
-- @propertytype number A single value for all margins.
|
||||||
|
-- @propertytype table A different value for each side.
|
||||||
|
-- @propertyunit pixel
|
||||||
|
-- @negativeallowed false
|
||||||
-- @propemits false false
|
-- @propemits false false
|
||||||
|
|
||||||
function margin:set_margins(val)
|
function margin:set_margins(val)
|
||||||
|
@ -126,7 +133,8 @@ end
|
||||||
--- Set the margins color to create a border.
|
--- Set the margins color to create a border.
|
||||||
--
|
--
|
||||||
-- @property color
|
-- @property color
|
||||||
-- @tparam gears.color color A color used to fill the margin.
|
-- @tparam[opt=nil] color|nil color A color used to fill the margin.
|
||||||
|
-- @propertytype nil Transparent margins.
|
||||||
-- @propemits true false
|
-- @propemits true false
|
||||||
|
|
||||||
function margin:set_color(color)
|
function margin:set_color(color)
|
||||||
|
@ -142,7 +150,7 @@ end
|
||||||
--- Draw the margin even if the content size is 0x0.
|
--- Draw the margin even if the content size is 0x0.
|
||||||
--
|
--
|
||||||
-- @property draw_empty
|
-- @property draw_empty
|
||||||
-- @tparam[opt=true] boolean draw_empty Draw nothing is content is 0x0 or draw
|
-- @tparam[opt=true] boolean draw_empty Draw nothing is content is `0x0` or draw
|
||||||
-- the margin anyway.
|
-- the margin anyway.
|
||||||
-- @propemits true false
|
-- @propemits true false
|
||||||
|
|
||||||
|
@ -156,7 +164,8 @@ function margin:get_draw_empty()
|
||||||
return self._private.draw_empty
|
return self._private.draw_empty
|
||||||
end
|
end
|
||||||
|
|
||||||
--- Reset this layout. The widget will be unreferenced, the margins set to 0
|
--- Reset this layout.
|
||||||
|
-- The widget will be unreferenced, the margins set to 0
|
||||||
-- and the color erased
|
-- and the color erased
|
||||||
-- @method reset
|
-- @method reset
|
||||||
-- @noreturn
|
-- @noreturn
|
||||||
|
@ -170,25 +179,33 @@ end
|
||||||
--- Set the left margin that this layout adds to its widget.
|
--- Set the left margin that this layout adds to its widget.
|
||||||
--
|
--
|
||||||
-- @property left
|
-- @property left
|
||||||
-- @tparam number left The new margin to use.
|
-- @tparam[opt=0] number left
|
||||||
|
-- @negativeallowed false
|
||||||
|
-- @propertyunit pixel
|
||||||
-- @propemits true false
|
-- @propemits true false
|
||||||
|
|
||||||
--- Set the right margin that this layout adds to its widget.
|
--- Set the right margin that this layout adds to its widget.
|
||||||
--
|
--
|
||||||
-- @property right
|
-- @property right
|
||||||
-- @tparam number right The new margin to use.
|
-- @tparam[opt=0] number right
|
||||||
|
-- @negativeallowed false
|
||||||
|
-- @propertyunit pixel
|
||||||
-- @propemits true false
|
-- @propemits true false
|
||||||
|
|
||||||
--- Set the top margin that this layout adds to its widget.
|
--- Set the top margin that this layout adds to its widget.
|
||||||
--
|
--
|
||||||
-- @property top
|
-- @property top
|
||||||
-- @tparam number top The new margin to use.
|
-- @tparam[opt=0] number top
|
||||||
|
-- @negativeallowed false
|
||||||
|
-- @propertyunit pixel
|
||||||
-- @propemits true false
|
-- @propemits true false
|
||||||
|
|
||||||
--- Set the bottom margin that this layout adds to its widget.
|
--- Set the bottom margin that this layout adds to its widget.
|
||||||
--
|
--
|
||||||
-- @property bottom
|
-- @property bottom
|
||||||
-- @tparam number bottom The new margin to use.
|
-- @tparam[opt=0] number bottom
|
||||||
|
-- @negativeallowed false
|
||||||
|
-- @propertyunit pixel
|
||||||
-- @propemits true false
|
-- @propemits true false
|
||||||
|
|
||||||
-- Create setters for each direction
|
-- Create setters for each direction
|
||||||
|
|
Loading…
Reference in New Issue