Class wibox.layout.fixed

Usage:

    wibox.widget {
        generic_widget( 'first'  ),
        generic_widget( 'second' ),
        generic_widget( 'third'  ),
        layout  = wibox.layout.fixed.horizontal
    }

Info:

  • Copyright: 2010 Uli Schlachter
  • Author: Uli Schlachter

Functions

fixed:add (...) Add some widgets to the given fixed layout
fixed:remove (index) Remove a widget from the layout
fixed:remove_widgets (widget) Remove one or more widgets from the layout The last parameter can be a boolean, forcing a recursive seach of the widget(s) to remove.
fixed:replace_widget (widget, widget2[, recursive=false]) Replace the first instance of widget in the layout with widget2
fixed:insert (index, widget) Insert a new widget in the layout at position index **Signal:** widget::inserted The arguments are the widget and the index

Object properties

wibox.layout.fixed.fill_space Set the layout's fill_space property.
wibox.layout.fixed.spacing Add spacing between each layout widgets

Methods

wibox.layout.fixed:horizontal (...) Returns a new horizontal fixed layout.
wibox.layout.fixed:vertical (...) Returns a new vertical fixed layout.


Functions

fixed:add (...)
Add some widgets to the given fixed layout
  • ... Widgets that should be added (must at least be one)
fixed:remove (index)
Remove a widget from the layout
  • index number The widget index to remove

Returns:

    boolean index If the operation is successful
fixed:remove_widgets (widget)
Remove one or more widgets from the layout The last parameter can be a boolean, forcing a recursive seach of the widget(s) to remove.
  • widget ... Widgets that should be removed (must at least be one)

Returns:

    boolean If the operation is successful
fixed:replace_widget (widget, widget2[, recursive=false])
Replace the first instance of widget in the layout with widget2
  • widget The widget to replace
  • widget2 The widget to replace widget with
  • recursive boolean Digg in all compatible layouts to find the widget. (default false)

Returns:

    boolean If the operation is successful
fixed:insert (index, widget)
Insert a new widget in the layout at position index **Signal:** widget::inserted The arguments are the widget and the index
  • index number The position
  • widget The widget

Returns:

    boolean If the operation is successful

Object properties

wibox.layout.fixed.fill_space
Set the layout's fill_space property. If this property is true, the last widget will get all the space that is left. If this is false, the last widget won't be handled specially and there can be space left unused.
wibox.layout.fixed.spacing
Add spacing between each layout widgets

Type:

  • spacing number Spacing between widgets.

Methods

wibox.layout.fixed:horizontal (...)
Returns a new horizontal fixed layout. Each widget will get as much space as it asks for and each widget will be drawn next to its neighboring widget. Widgets can be added via :add() or as arguments to this function.
  • ... widget Widgets that should be added to the layout.
wibox.layout.fixed:vertical (...)
Returns a new vertical fixed layout. Each widget will get as much space as it asks for and each widget will be drawn next to its neighboring widget. Widgets can be added via :add() or as arguments to this function.
  • ... widget Widgets that should be added to the layout.
generated by LDoc 1.4.2