docs » Cherry

Cherry tomato (a tiny Pomodoro) -- a Pomodoro Timer for the menubar

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

Signature Cherry:bindHotkeys(mapping)

Type Method

Description

Signature	`Cherry:bindHotkeys(mapping)`
Type	Method
Description	Binds hotkeys for Cherry Parameters: mapping - A table containing hotkey details for the following items: start - start the pomodoro timer (Default: cmd-ctrl-alt-C)

Binds hotkeys for Cherry

Parameters:

mapping - A table containing hotkey details for the following items:
- start - start the pomodoro timer (Default: cmd-ctrl-alt-C)

Signature Cherry:popup()

Type Method

Description

Signature	`Cherry:popup()`
Type	Method
Description	Popup an alert or notification when time is up. Parameters: None Returns: None

Popup an alert or notification when time is up.

Parameters:

Returns:

Signature Cherry:start()

Type Method

Description

Signature	`Cherry:start()`
Type	Method
Description	Starts the timer and displays the countdown in a menubar item Parameters: resume - boolean when true resumes countdown at current value of self.timeLeft Returns: None

Starts the timer and displays the countdown in a menubar item

Parameters:

Returns: