docs » HCalendar

A horizonal calendar inset into the desktop

Download: https://github.com/Hammerspoon/Spoons/raw/master/Spoons/HCalendar.spoon.zip

API Overview

Variables - Configurable values

showProgress

Methods - API calls which can only be made on an object returned by a constructor

createCanvas
init
start
stop

API Documentation

Variables

showProgress

Signature	`HCalendar.showProgress (Boolean)`
Type	Variable
Description	Control whether or not progress through the month is shown.
Source	Source/HCalendar.spoon/init.lua line 21

Methods

createCanvas

Signature	`HCalendar:createCanvas()`
Type	Method
Description	Create the calendar canvas
Parameters	None
Returns
Source	Source/HCalendar.spoon/init.lua line 91

init

Signature	`HCalendar:init()`
Type	Method
Description	Initializes the spoon
Parameters	None
Returns
Source	Source/HCalendar.spoon/init.lua line 219

start

Signature	`HCalendar:start()`
Type	Method
Description	Start HCalendar timer and show the canvas
Parameters	None
Returns
Source	Source/HCalendar.spoon/init.lua line 236

stop

Signature	`HCalendar:stop()`
Type	Method
Description	Stop HCalendar timer and hide the canvas
Parameters	None
Returns
Source	Source/HCalendar.spoon/init.lua line 256