Class wibox.container.rotate

A container rotating the conained widget by 90 degrees.

Info:

  • Copyright: 2010 Uli Schlachter
  • Author: Uli Schlachter

Functions

rotate:get_children () Get the number of children element
rotate:set_children (children) Replace the layout children This layout only accept one children, all others will be ignored
rotate:reset () Reset this layout.
rotate:get_direction () Get the direction of this rotating layout
wibox.container.rotate ([widget[, dir]]) Returns a new rotate container.

Object properties

wibox.container.rotate.widget The widget to be rotated.
wibox.container.rotate.direction The direction of this rotating container.


Functions

rotate:get_children ()
Get the number of children element

Returns:

    table The children
rotate:set_children (children)
Replace the layout children This layout only accept one children, all others will be ignored
  • children table A table composed of valid widgets
rotate:reset ()
Reset this layout. The widget will be removed and the rotation reset.
rotate:get_direction ()
Get the direction of this rotating layout
wibox.container.rotate ([widget[, dir]])
Returns a new rotate container. A rotate container rotates a given widget. Use :set_widget() to set the widget and :set_direction() for the direction. The default direction is "north" which doesn't change anything.
  • widget The widget to display.
  • dir The direction to rotate to.

Returns:

    table A new rotate container.

Object properties

wibox.container.rotate.widget
The widget to be rotated.

Type:

wibox.container.rotate.direction
The direction of this rotating container. Valid values are:

* *north* * *east* * *south* * *north*

Type:

Usage:

    local normal = create_arrow('Normal')
    local north  = wibox.container {
        create_arrow('North'),
        direction = 'north',
        widget    = wibox.container.rotate
    }
    local south  = wibox.container {
        create_arrow('South'),
        direction = 'south',
        widget    = wibox.container.rotate
    }
    local east  = wibox.container {
        create_arrow('East'),
        direction = 'east',
        widget    = wibox.container.rotate
    }
    local west  = wibox.container {
        create_arrow('West'),
        direction = 'west',
        widget    = wibox.container.rotate
    }
generated by LDoc 1.4.2