Aire-One
/
awesome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

stack: Enable the property system 

And add the missing documentation
This commit is contained in:
Emmanuel Lepage Vallee 2016-05-26 19:41:58 -04:00
parent 23729b6296
commit f9ff2f4909
1 changed files with 23 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
lib/wibox/layout/stack.lua
View File

@ -53,17 +53,16 @@ local stack = {mt={}}
-- @class function -- @class function
--- Add spacing between each layout widgets --- Add spacing between each layout widgets
-- @param spacing Spacing between widgets. -- @property spacing
-- @name set_spacing -- @tparam number spacing Spacing between widgets.
-- @class function
function stack:layout(_, width, height) function stack:layout(_, width, height)
local result = {} local result = {}
local spacing = self._spacing local spacing = self._private.spacing
for _, v in pairs(self.widgets) do for _, v in pairs(self._private.widgets) do
table.insert(result, base.place_widget_at(v, spacing, spacing, width - 2*spacing, height - 2*spacing)) table.insert(result, base.place_widget_at(v, spacing, spacing, width - 2*spacing, height - 2*spacing))
if self._top_only then break end if self._private.top_only then break end
end end
return result return result
@ -71,9 +70,9 @@ end
function stack:fit(context, orig_width, orig_height) function stack:fit(context, orig_width, orig_height)
local max_w, max_h = 0,0 local max_w, max_h = 0,0
local spacing = self._spacing local spacing = self._private.spacing
for _, v in pairs(self.widgets) do for _, v in pairs(self._private.widgets) do
local w, h = base.fit_widget(self, context, v, orig_width, orig_height) local w, h = base.fit_widget(self, context, v, orig_width, orig_height)
max_w, max_h = math.max(max_w, w+2*spacing), math.max(max_h, h+2*spacing) max_w, max_h = math.max(max_w, w+2*spacing), math.max(max_h, h+2*spacing)
end end
@ -81,26 +80,25 @@ function stack:fit(context, orig_width, orig_height)
return math.min(max_w, orig_width), math.min(max_h, orig_height) return math.min(max_w, orig_width), math.min(max_h, orig_height)
end end
--- Get if only the first stack widget is drawn --- If only the first stack widget is drawn
-- @return If the only the first stack widget is drawn -- @property top_only
function stack:get_display_top_only()
return self._top_only function stack:get_top_only()
return self._private.top_only
end end
--- Only draw the first widget of the stack, ignore others function stack:set_top_only(top_only)
-- @tparam boolean top_only Only draw the top stack widget self._private.top_only = top_only
function stack:set_display_top_only(top_only)
self._top_only = top_only
end end
--- Raise a widget at `index` to the top of the stack --- Raise a widget at `index` to the top of the stack
-- @tparam number index the widget index to raise -- @tparam number index the widget index to raise
function stack:raise(index) function stack:raise(index)
if (not index) or self.widgets[index] then return end if (not index) or self._private.widgets[index] then return end
local w = self.widgets[index] local w = self._private.widgets[index]
table.remove(self.widgets, index) table.remove(self._private.widgets, index)
table.insert(self.widgets, w) table.insert(self._private.widgets, w)
self:emit_signal("widget::layout_changed") self:emit_signal("widget::layout_changed")
end end
@ -131,7 +129,7 @@ end
local function new(...) local function new(...)
local ret = fixed.horizontal(...) local ret = fixed.horizontal(...)
util.table.crush(ret, stack) util.table.crush(ret, stack, true)
return ret return ret
end end
@ -140,5 +138,9 @@ function stack.mt:__call(_, ...)
return new(...) return new(...)
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(stack, stack.mt) return setmetatable(stack, stack.mt)
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80 -- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80