awesome/docs/common/fixed.ldoc

48 lines
1.9 KiB
Plaintext
Raw Normal View History

2016-08-08 08:39:43 +02:00
--- Set a widget at a specific index, replace the current one.
-- **Signal:** widget::replaced The argument is the new widget and the old one
-- and the index.
-- @tparam number index A widget or a widget index
-- @param widget2 The widget to take the place of the first one
-- @treturn boolean If the operation is successful
-- @name set
-- @class function
2016-08-08 08:39:43 +02:00
--- Replace the first instance of `widget` in the layout with `widget2`.
-- **Signal:** widget::replaced The argument is the new widget and the old one
-- and the index.
-- @param widget The widget to replace
-- @param widget2 The widget to replace `widget` with
-- @tparam[opt=false] boolean recursive Dig in all compatible layouts to find the widget.
-- @treturn boolean If the operation is successful
-- @name replace_widget
-- @class function
2016-08-08 08:39:43 +02:00
--- Swap 2 widgets in a layout.
-- **Signal:** widget::swapped The arguments are both widgets and both (new) indexes.
-- @tparam number index1 The first widget index
-- @tparam number index2 The second widget index
-- @treturn boolean If the operation is successful
-- @name swap
-- @class function
2016-08-08 08:39:43 +02:00
--- Swap 2 widgets in a layout.
-- If widget1 is present multiple time, only the first instance is swapped
2016-08-08 08:39:43 +02:00
-- **Signal:** widget::swapped The arguments are both widgets and both (new) indexes.
-- if the layouts not the same, then only `widget::replaced` will be emitted.
-- @param widget1 The first widget
-- @param widget2 The second widget
-- @tparam[opt=false] boolean recursive Dig in all compatible layouts to find the widget.
-- @treturn boolean If the operation is successful
-- @name swap_widgets
-- @class function
--- Get all direct children of this layout.
-- @param layout The layout you are modifying.
-- @property children
--- Reset a ratio layout. This removes all widgets from the layout.
2016-08-08 08:39:43 +02:00
-- **Signal:** widget::reset
-- @param layout The layout you are modifying.
-- @name reset
-- @class function