wibox: Import drawin documentation
This improve consistency.
This commit is contained in:
parent
6b6cbf4a1f
commit
1a114e4e57
|
@ -31,6 +31,189 @@ function wibox:set_widget(widget)
|
|||
self._drawable:set_widget(widget)
|
||||
end
|
||||
|
||||
-- Import some drawin documentation
|
||||
|
||||
--- Border width.
|
||||
--
|
||||
-- **Signal:**
|
||||
--
|
||||
-- * *property::border_width*
|
||||
--
|
||||
-- @property border_width
|
||||
-- @param integer
|
||||
|
||||
--- 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
|
||||
--
|
||||
-- **Signal:**
|
||||
--
|
||||
-- * *property::border_color*
|
||||
--
|
||||
-- @property border_color
|
||||
-- @param string
|
||||
|
||||
--- On top of other windows.
|
||||
--
|
||||
-- **Signal:**
|
||||
--
|
||||
-- * *property::ontop*
|
||||
--
|
||||
-- @property ontop
|
||||
-- @param boolean
|
||||
|
||||
--- The mouse cursor.
|
||||
--
|
||||
-- **Signal:**
|
||||
--
|
||||
-- * *property::cursor*
|
||||
--
|
||||
-- @property cursor
|
||||
-- @param string
|
||||
-- @see mouse
|
||||
|
||||
--- Visibility.
|
||||
--
|
||||
-- **Signal:**
|
||||
--
|
||||
-- * *property::visible*
|
||||
--
|
||||
-- @property visible
|
||||
-- @param boolean
|
||||
|
||||
--- The opacity of the wibox, between 0 and 1.
|
||||
--
|
||||
-- **Signal:**
|
||||
--
|
||||
-- * *property::opacity*
|
||||
--
|
||||
-- @property opacity
|
||||
-- @tparam number opacity (between 0 and 1)
|
||||
|
||||
--- The window type (desktop, normal, dock, ...).
|
||||
--
|
||||
-- **Signal:**
|
||||
--
|
||||
-- * *property::type*
|
||||
--
|
||||
-- @property type
|
||||
-- @param string
|
||||
-- @see client.type
|
||||
|
||||
--- The x coordinates.
|
||||
--
|
||||
-- **Signal:**
|
||||
--
|
||||
-- * *property::x*
|
||||
--
|
||||
-- @property x
|
||||
-- @param integer
|
||||
|
||||
--- The y coordinates.
|
||||
--
|
||||
-- **Signal:**
|
||||
--
|
||||
-- * *property::y*
|
||||
--
|
||||
-- @property y
|
||||
-- @param integer
|
||||
|
||||
--- The width of the wibox.
|
||||
--
|
||||
-- **Signal:**
|
||||
--
|
||||
-- * *property::width*
|
||||
--
|
||||
-- @property width
|
||||
-- @param width
|
||||
|
||||
--- The height of the wibox.
|
||||
--
|
||||
-- **Signal:**
|
||||
--
|
||||
-- * *property::height*
|
||||
--
|
||||
-- @property height
|
||||
-- @param height
|
||||
|
||||
--- The wibox's `drawable`.
|
||||
--
|
||||
-- **Signal:**
|
||||
--
|
||||
-- * *property::drawable*
|
||||
--
|
||||
-- @property drawable
|
||||
-- @tparam drawable drawable
|
||||
|
||||
--- The X window id.
|
||||
--
|
||||
-- **Signal:**
|
||||
--
|
||||
-- * *property::window*
|
||||
--
|
||||
-- @property window
|
||||
-- @param string
|
||||
-- @see client.window
|
||||
|
||||
--- The wibox's bounding shape as a (native) cairo surface.
|
||||
--
|
||||
-- **Signal:**
|
||||
--
|
||||
-- * *property::shape_bounding*
|
||||
--
|
||||
-- @property shape_bounding
|
||||
-- @param surface._native
|
||||
|
||||
--- The wibox's clip shape as a (native) cairo surface.
|
||||
--
|
||||
-- **Signal:**
|
||||
--
|
||||
-- * *property::shape_clip*
|
||||
--
|
||||
-- @property shape_clip
|
||||
-- @param surface._native
|
||||
|
||||
--- Get or set mouse buttons bindings to a wibox.
|
||||
--
|
||||
-- @param buttons_table A table of buttons objects, or nothing.
|
||||
-- @function wibox.buttons
|
||||
|
||||
--- Get or set wibox geometry. That's the same as accessing or setting the x,
|
||||
-- y, width or height properties of a wibox.
|
||||
--
|
||||
-- @param A table with coordinates to modify.
|
||||
-- @return A table with wibox coordinates and geometry.
|
||||
-- @function wibox.geometry
|
||||
|
||||
--- Get or set wibox struts.
|
||||
--
|
||||
-- @param strut A table with new strut, or nothing
|
||||
-- @return The wibox strut in a table.
|
||||
-- @function wibox.struts
|
||||
-- @see client.struts
|
||||
|
||||
--- The default background color.
|
||||
-- @beautiful beautiful.bg_normal
|
||||
-- @see set_bg
|
||||
|
||||
--- The default foreground (text) color.
|
||||
-- @beautiful beautiful.fg_normal
|
||||
-- @see set_fg
|
||||
|
||||
--- 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
|
||||
|
@ -161,13 +344,6 @@ end
|
|||
-- @param wibox
|
||||
-- @function draw
|
||||
|
||||
--- Widget box object.
|
||||
-- Every wibox "inherits" from a drawin and you can use all of drawin's
|
||||
-- functions directly on this as well. When creating a wibox, you can specify a
|
||||
-- "fg" and a "bg" color as keys in the table that is passed to the constructor.
|
||||
-- All other arguments will be passed to drawin's constructor.
|
||||
-- @table drawin
|
||||
|
||||
function wibox.mt:__call(...)
|
||||
return new(...)
|
||||
end
|
||||
|
|
Loading…
Reference in New Issue