awesome/docs/common/wibox.ldoc

--- Border width.
--
-- @baseclass wibox
-- @property border_width
-- @tparam[opt=0] integer border_width
-- @propertyunit pixel
-- @negativeallowed false
-- @propemits false false

--- Border color.
--
-- Please note that this property only support string based 24 bit or 32 bit
-- colors:
--
--    Red Blue
--     _|  _|
--    #FF00FF
--       T‾
--     Green
--
--
--    Red Blue
--     _|  _|
--    #FF00FF00
--       T‾  ‾T
--    Green   Alpha
--
-- @baseclass wibox
-- @property border_color
-- @tparam[opt=beautiful.fg_normal] string border_color
-- @propemits false false

--- On top of other windows.
--
-- @baseclass wibox
-- @property ontop
-- @tparam[opt=false] boolean ontop
-- @propemits false false

--- The mouse cursor.
--
-- @baseclass wibox
-- @property cursor
-- @tparam[opt=nil] string|nil cursor
-- @propertytype nil Do not change the mouse cursor.
-- @see mouse
-- @propemits false false

--- Visibility.
--
-- @baseclass wibox
-- @property visible
-- @tparam[opt=false] boolean visible
-- @propemits false false

--- The opacity of the wibox, between 0 and 1.
--
-- @baseclass wibox
-- @property opacity
-- @tparam[opt=true] number opacity
-- @rangestart 0.0
-- @rangestop 1.0
-- @propemits false false

--- The window type (desktop, normal, dock, ...).
--
-- @baseclass wibox
-- @property type
-- @tparam[opt=""] string type
-- @see client.type
-- @propemits false false

--- The x coordinates.
--
-- @baseclass wibox
-- @property x
-- @tparam[opt=0] integer x
-- @propertyunit pixel
-- @negativeallowed true
-- @propemits false false

--- The y coordinates.
--
-- @baseclass wibox
-- @property y
-- @tparam[opt=0] integer y
-- @propertyunit pixel
-- @negativeallowed true
-- @propemits false false

--- The width of the wibox.
--
-- @baseclass wibox
-- @property width
-- @tparam[opt=1] integer width
-- @propertyunit pixel
-- @rangestart 1
-- @negativeallowed false
-- @propemits false false

--- The height of the wibox.
--
-- @baseclass wibox
-- @property height
-- @tparam[opt=1] integer height
-- @propertyunit pixel
-- @rangestart 1
-- @negativeallowed false
-- @propemits false false

--- The wibox screen.
--
-- @baseclass wibox
-- @property screen
-- @tparam screen screen
-- @propertydefault The screen which contains `0x0`.
-- @propemits true false

--  The wibox's `drawable`.
--
-- @baseclass wibox
-- @property drawable
-- @tparam drawable drawable
-- @propemits false false

--- The widget that the `wibox` displays.
-- @baseclass wibox
-- @property widget
-- @tparam[opt=nil] widget|nil widget
-- @propemits true false

--- The X window id.
--
-- @baseclass wibox
-- @property window
-- @tparam string window
-- @propertydefault Autogenerated.
-- @see client.window
-- @propemits false false

--- The wibox's bounding shape as a (native) cairo surface.
--
-- If you want to set a shape, let say some rounded corners, use
-- the `shape` property rather than this. If you want something
-- very complex, for example, holes, then use this.
--
-- @baseclass wibox
-- @property shape_bounding
-- @tparam surface._native shape_bounding
-- @propertydefault Fill all pixels.
-- @propemits false false
-- @see shape

--- The wibox's clip shape as a (native) cairo surface.
--
-- The clip shape is the shape of the window *content* rather
-- than the outer window shape.
--
-- @baseclass wibox
-- @property shape_clip
-- @tparam surface._native shape_clip
-- @propertydefault Fill all pixels.
-- @propemits false false
-- @see shape

--- The wibox's input shape as a (native) cairo surface.
--
-- The input shape allows to disable clicks and mouse events
-- on part of the window. This is how `input_passthrough` is
-- implemented.
--
-- @baseclass wibox
-- @property shape_input
-- @tparam surface._native shape_input
-- @propertydefault Fill all pixels.
-- @propemits false false
-- @see input_passthrough

--- The wibar's shape.
--
-- @baseclass wibox
-- @property shape
-- @tparam[opt=gears.shape.rectangle] shape shape
-- @propemits true false
-- @see gears.shape

--- Forward the inputs to the client below the wibox.
--
-- This replace the `shape_input` mask with an empty area. All mouse and
-- keyboard events are sent to the object (such as a client) positioned below
-- this wibox. When used alongside compositing, it allows, for example, to have
-- a subtle transparent wibox on top a fullscreen client to display important
-- data such as a low battery warning.
--
-- @baseclass wibox
-- @property input_passthrough
-- @tparam[opt=false] boolean input_passthrough
-- @see shape_input
-- @propemits true false

--- Get or set mouse buttons bindings to a wibox.
--
-- @baseclass wibox
-- @property buttons
-- @tparam[opt={}] table buttons A table of buttons objects, or nothing.
-- @tablerowtype A list of `awful.button`s.
-- @propemits false false

--- Get or set wibox geometry. That's the same as accessing or setting the x,
-- y, width or height properties of a wibox.
--
-- @baseclass wibox
-- @tparam[opt=nil] table|nil geo A table with coordinates to modify. If
--  nothing is specified, it only returns the current geometry.
-- @treturn table A table with wibox coordinates and geometry.
-- @method geometry
-- @emits property::geometry When the geometry change.
-- @emitstparam property::geometry table geo The geometry table.

--- Get or set wibox struts.
--
-- Struts are the area which should be reserved on each side of
-- the screen for this wibox. This is used to make bars and
-- docked displays. Note that `awful.wibar` implements all the
-- required boilerplate code to make bar. Only use this if you
-- want special type of bars (like bars not fully attached to
-- the side of the screen).
--
-- @baseclass wibox
-- @return The wibox strut in a table.
-- @method struts
-- @tparam table struts A table with new strut, or nothing.
-- @see client.struts
-- @emits property::struts

--- Set a declarative widget hierarchy description.
-- See [The declarative layout system](../documentation/03-declarative-layout.md.html)
-- @param args An array containing the widgets disposition
-- @baseclass wibox
-- @method setup
-- @noreturn

--- The background of the wibox.
--
-- The background color can be transparent. If there is a
-- compositing manager such as compton, then it will be
-- real transparency and may include blur (provided by the
-- compositor). When there is no compositor, it will take
-- a picture of the wallpaper and blend it.
--
-- @baseclass wibox
-- @property bg
-- @tparam[opt=beautiful.bg_normal] color bg The background to use. This
--  must either be a cairo pattern object, nil or a string that gears.color() understands.
-- @see gears.color
-- @propemits true false
-- @usebeautiful beautiful.bg_normal The default (fallback) bg color.

--- The background image of the drawable.
--
-- If `image` is a function, it will be called with `(context, cr, width, height)`
-- as arguments. Any other arguments passed to this method will be appended.
--
-- @baseclass wibox
-- @property bgimage
-- @tparam[opt=nil] image|nil bgimage
-- @see gears.surface
-- @propemits true false

--- The foreground (text) of the wibox.
--
-- @baseclass wibox
-- @property fg
-- @tparam[opt=beautiful.fg_normal] color fg
-- @see gears.color
-- @propemits true false
-- @usebeautiful beautiful.fg_normal The default (fallback) fg color.

--- Find a widget by a point.
-- The wibox must have drawn itself at least once for this to work.
-- @tparam number x X coordinate of the point
-- @tparam number y Y coordinate of the point
-- @treturn table A sorted table of widgets positions. The first element is the biggest
-- container while the last is the topmost widget. The table contains *x*, *y*,
-- *width*, *height* and *widget*.
-- @baseclass wibox
-- @method find_widgets