Correct name of functions in taglist (#2783)
This commit is contained in:
parent
099f17ca8c
commit
900cca54a4
|
@ -425,7 +425,7 @@ end
|
|||
-- update. See `awful.widget.common`.
|
||||
-- @tparam[opt] widget args.layout Optional layout widget for tag widgets. Default
|
||||
-- is wibox.layout.fixed.horizontal().
|
||||
-- @tparam[opt=awful.taglist.source.for_screen] function args.source The
|
||||
-- @tparam[opt=awful.widget.taglist.source.for_screen] function args.source The
|
||||
-- function used to generate the list of tag.
|
||||
-- @tparam[opt] table args.widget_template A custom widget to be used for each tag
|
||||
-- @tparam[opt={}] table args.style The style overrides default theme.
|
||||
|
@ -462,7 +462,7 @@ end
|
|||
-- @param style **DEPRECATED** use args.style
|
||||
-- @param update_function **DEPRECATED** use args.update_function
|
||||
-- @param base_widget **DEPRECATED** use args.base_widget
|
||||
-- @function awful.taglist
|
||||
-- @function awful.widget.taglist
|
||||
function taglist.new(args, filter, buttons, style, update_function, base_widget)
|
||||
|
||||
local screen = nil
|
||||
|
@ -566,7 +566,7 @@ end
|
|||
--- Filtering function to include all nonempty tags on the screen.
|
||||
-- @param t The tag.
|
||||
-- @return true if t is not empty, else false
|
||||
-- @filterfunction awful.taglist.filter.noempty
|
||||
-- @filterfunction awful.widget.taglist.filter.noempty
|
||||
function taglist.filter.noempty(t)
|
||||
return #t:clients() > 0 or t.selected
|
||||
end
|
||||
|
@ -574,14 +574,14 @@ end
|
|||
--- Filtering function to include selected tags on the screen.
|
||||
-- @param t The tag.
|
||||
-- @return true if t is not empty, else false
|
||||
-- @filterfunction awful.taglist.filter.selected
|
||||
-- @filterfunction awful.widget.taglist.filter.selected
|
||||
function taglist.filter.selected(t)
|
||||
return t.selected
|
||||
end
|
||||
|
||||
--- Filtering function to include all tags on the screen.
|
||||
-- @return true
|
||||
-- @filterfunction awful.taglist.filter.all
|
||||
-- @filterfunction awful.widget.taglist.filter.all
|
||||
function taglist.filter.all()
|
||||
return true
|
||||
end
|
||||
|
@ -590,7 +590,7 @@ end
|
|||
--
|
||||
-- This is the default source.
|
||||
--
|
||||
-- @sourcefunction awful.taglist.source.for_screen
|
||||
-- @sourcefunction awful.widget.taglist.source.for_screen
|
||||
-- @see screen
|
||||
function taglist.source.for_screen(s)
|
||||
return s.tags
|
||||
|
|
Loading…
Reference in New Issue