2
0
mirror of https://github.com/koreader/koreader synced 2024-11-04 12:00:25 +00:00
koreader/frontend/ui/widget/container/underlinecontainer.lua
Frans de Jonge a2dcfe9aec
[doc] Tag @todo, @fixme and @warning (#5244)
This commit standardizes the various todos around the code a bit in a manner recognized by LDoc.

Besides drawing more attention by being displayed in the developer docs, they're also extractable with LDoc on the command line:

```sh
ldoc --tags todo,fixme *.lua
```

However, whether that particular usage offers any advantage over other search tools is questionable at best.

* and some random beautification
2019-08-23 19:53:53 +02:00

48 lines
1.4 KiB
Lua

--[[--
An UnderlineContainer is a WidgetContainer that is able to paint
a line under its child node.
--]]
local Blitbuffer = require("ffi/blitbuffer")
local Geom = require("ui/geometry")
local Size = require("ui/size")
local WidgetContainer = require("ui/widget/container/widgetcontainer")
local UnderlineContainer = WidgetContainer:new{
linesize = Size.line.thick,
padding = Size.padding.tiny,
--- @todo shouldn't this default to black instead?
color = Blitbuffer.COLOR_WHITE,
vertical_align = "top",
}
function UnderlineContainer:getSize()
local contentSize = self[1]:getSize()
return Geom:new{
w = contentSize.w,
h = contentSize.h + self.linesize + 2*self.padding
}
end
function UnderlineContainer:paintTo(bb, x, y)
local container_size = self:getSize()
self.dimen = Geom:new{
x = x, y = y,
w = container_size.w,
h = container_size.h
}
local content_size = self[1]:getSize()
local p_y = y
if self.vertical_align == "center" then
p_y = math.floor((container_size.h - content_size.h) / 2) + y
elseif self.vertical_align == "bottom" then
p_y = (container_size.h - content_size.h) + y
end
self[1]:paintTo(bb, x, p_y)
bb:paintRect(x, y + container_size.h - self.linesize,
container_size.w, self.linesize, self.color)
end
return UnderlineContainer