Merge pull request #2153 from otommod/master

Add set/get for textclock attributes

lib/wibox/widget/textclock.lua

@@ -10,12 +10,53 @@ local setmetatable = setmetatable
 local os = os
 local textbox = require("wibox.widget.textbox")
 local timer = require("gears.timer")
+local gtable = require("gears.table")
 local glib = require("lgi").GLib
 local DateTime = glib.DateTime
 local TimeZone = glib.TimeZone
 
 local textclock = { mt = {} }
 
+--- Set the clock's format
+-- @property format
+-- @tparam string format The new time format.  This can contain pango markup
+
+function textclock:set_format(format)
+    self._private.format = format
+    self:force_update()
+end
+
+function textclock:get_format()
+    return self._private.format
+end
+
+--- Set the clock's timezone
+-- @property timezone
+-- @tparam string timezone
+
+function textclock:set_timezone(tzid)
+    self._private.tzid = tzid
+    self._private.timezone = tzid and TimeZone.new(tzid) or TimeZone.new_local()
+    self:force_update()
+end
+
+function textclock:get_timezone()
+    return self._private.tzid
+end
+
+--- Set the clock's refresh rate
+-- @property refresh
+-- @tparam number How often the clock is updated, in seconds
+
+function textclock:set_refresh(refresh)
+    self._private.refresh = refresh or self._private.refresh
+    self:force_update()
+end
+
+function textclock:get_refresh()
+    return self._private.refresh
+end
+
 --- Force a textclock to update now.
 function textclock:force_update()
     self._timer:emit_signal("timeout")
@@ -30,38 +71,41 @@ end
 --- Create a textclock widget. It draws the time it is in a textbox.
 --
 -- @tparam[opt=" %a %b %d, %H:%M "] string format The time format.
--- @tparam[opt=60] number timeout How often update the time (in seconds).
+-- @tparam[opt=60] number refresh How often to update the time (in seconds).
 -- @tparam[opt=local timezone] string timezone The timezone to use,
 --   e.g. "Z" for UTC, "±hh:mm" or "Europe/Amsterdam". See
 --   https://developer.gnome.org/glib/stable/glib-GTimeZone.html#g-time-zone-new.
 -- @treturn table A textbox widget.
 -- @function wibox.widget.textclock
-function textclock.new(format, timeout, timezone)
+local function new(format, refresh, tzid)
-    format = format or " %a %b %d, %H:%M "
-    timeout = timeout or 60
-    timezone = timezone and TimeZone.new(timezone) or TimeZone.new_local()
-
     local w = textbox()
-    w.force_update = textclock.force_update
+    gtable.crush(w, textclock, true)
+
+    w._private.format = format or " %a %b %d, %H:%M "
+    w._private.refresh = refresh or 60
+    w._private.tzid = tzid
+    w._private.timezone = tzid and TimeZone.new(tzid) or TimeZone.new_local()
+
     function w._private.textclock_update_cb()
-        local str = DateTime.new_now(timezone):format(format)
+        local str = DateTime.new_now(w._private.timezone):format(w._private.format)
         if str == nil then
             require("gears.debug").print_warning("textclock: "
                     .. "g_date_time_format() failed for format "
-                    .. "'" .. format .. "'")
+                    .. "'" .. w._private.format .. "'")
         end
         w:set_markup(str)
-        w._timer.timeout = calc_timeout(timeout)
+        w._timer.timeout = calc_timeout(w._private.refresh)
         w._timer:again()
         return true -- Continue the timer
     end
-    w._timer = timer.weak_start_new(timeout, w._private.textclock_update_cb)
+
+    w._timer = timer.weak_start_new(refresh, w._private.textclock_update_cb)
     w:force_update()
     return w
 end
 
 function textclock.mt:__call(...)
-    return textclock.new(...)
+    return new(...)
 end
 
 --@DOC_widget_COMMON@