docs » PopupTranslateSelection

Show a popup window with the translation of the currently selected (or other) text

Supported language codes are listed at https://cloud.google.com/translate/docs/languages

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

API Overview

Variables - Configurable values

logger
popup_close_on_escape
popup_size
popup_style

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

bindHotkeys
translatePopup
translateSelectionPopup

API Documentation

Variables

logger

Signature	`PopupTranslateSelection.logger`
Type	Variable
Description	Logger object used within the Spoon. Can be accessed to set the default log level for the messages coming from the Spoon.
Source	Source/PopupTranslateSelection.spoon/init.lua line 36

popup_close_on_escape

Signature	`PopupTranslateSelection.popup_close_on_escape`
Type	Variable
Description	If true, pressing ESC on the popup window will close it. Defaults to `true`
Source	Source/PopupTranslateSelection.spoon/init.lua line 31

popup_size

Signature	`PopupTranslateSelection.popup_size`
Type	Variable
Description	`hs.geometry` object representing the size to use for the translation popup window. Defaults to `hs.geometry.size(770, 610)`.
Source	Source/PopupTranslateSelection.spoon/init.lua line 21

popup_style

Signature	`PopupTranslateSelection.popup_style`
Type	Variable
Description	Value representing the window style to be used for the translation popup window. This value needs to be a valid argument to `hs.webview.setStyle()` (i.e. a combination of values from `hs.webview.windowMasks`. Default value: `hs.webview.windowMasks.utility\|hs.webview.windowMasks.HUD\|hs.webview.windowMasks.titled\|hs.webview.windowMasks.closable`
Source	Source/PopupTranslateSelection.spoon/init.lua line 26

Methods

bindHotkeys

Signature	`PopupTranslateSelection:bindHotkeys(mapping)`
Type	Method
Description	Binds hotkeys for PopupTranslateSelection
Parameters	mapping - A table containing hotkey modifier/key details for the following items: `translate` - translate the selected text without specifying source/destination languages (source defaults to auto-detect, destination defaults to your last choice or to English) `translate_to_<lang>` - translate the selected text to the given destination language. Source language will be auto-detected. `translate_from_<lang>` - translate the selected text from the given destination language. Destination language will default to your last choice, or to English. `translate_<from>_<to>` - translate the selected text between the given languages.
Returns
Examples
Source	Source/PopupTranslateSelection.spoon/init.lua line 112

translatePopup

Signature	`PopupTranslateSelection:translatePopup(text, to, from)`
Type	Method
Description	Display a translation popup with the translation of the given text between the specified languages
Parameters	text - string containing the text to translate to - two-letter code for destination language. If `nil`, Google Translate will use your most recent selection, or default to English from - two-letter code for source language. If `nil`, Google Translate will try to auto-detect it
Returns	The PopupTranslateSelection object
Source	Source/PopupTranslateSelection.spoon/init.lua line 46

translateSelectionPopup

Signature	`PopupTranslateSelection:translateSelectionPopup(to, from)`
Type	Method
Description	Get the current selected text in the frontmost window and display a translation popup with the translation between the specified languages
Parameters	to - two-letter code for destination language. If `nil`, Google Translate will use your most recent selection, or default to English from - two-letter code for source language. If `nil`, Google Translate will try to auto-detect it
Returns	The PopupTranslateSelection object
Source	Source/PopupTranslateSelection.spoon/init.lua line 97