object: Add a dynamic property example

This commit is contained in:
Emmanuel Lepage Vallee 2016-05-17 01:17:22 -04:00
parent f810d78e7b
commit d6a7b6c645
2 changed files with 56 additions and 0 deletions

View file

@ -169,6 +169,7 @@ end
-- Note that `args.enable_auto_signals` is only supported when
-- `args.enable_properties` is true.
--
--@DOC_text_gears_object_properties_EXAMPLE@
-- @tparam[opt={}] table args The arguments
-- @tparam[opt=false] boolean args.enable_properties Automatically call getters and setters
-- @tparam[opt=false] boolean args.enable_auto_signals Generate "property::xxxx" signals

View file

@ -0,0 +1,55 @@
local gears = require("gears") --DOC_HIDE
-- Create a class for this object. It will be used as a backup source for
-- methods and acessors. It is also possible to set them diretly on the
-- object.
local class = {}
function class:get_foo()
print("In get foo", self._foo or "bar")
return self._foo or "bar"
end
function class:set_foo(value)
print("In set foo", value)
-- In case it is necessary to bypass the object property system, use
-- `rawset`
rawset(self, "_foo", value)
-- When using custom accessors, the signals need to be handled manually
self:emit_signal("property::foo", value)
end
function class:method(a, b, c)
print("In a mathod", a, b, c)
end
local o = gears.object {
class = class,
enable_properties = true,
enable_auto_signals = true,
}
o:add_signal "property::foo"
print(o.foo)
o.foo = 42
print(o.foo)
o:method(1, 2, 3)
-- Random properties can also be added, the signal will be emited automatically.
o:add_signal "property::something"
o:connect_signal("property::something", function(obj, value)
print("In the connection handler!", obj, value)
end)
print(o.something)
o.something = "a cow"
print(o.something)