Документация для модуля $Interface

JsMB-Module-$Interface.md

$Interface : object

Модуль для работы с интерфейсом Поддерживает только JsMB-Interpreter и NW.JS

Kind: global namespace
Author: PROPHESOR

Внимание! Если вы используете стандартную реализацию - префикс JsMB. писать не обязательно.

• $Interface : object
  • .menuAdd(name, title, onClick, [type], [fortype]) ⇒ this
  • .menuShow(name, x, y) ⇒ this
  • .menuAddSeparator(name) ⇒ this
  • .menuBarAdd(name, title, subMenu) ⇒ this
  • .menuBarShow(name) ⇒ this
  • .getClipboard([type]) ⇒ string
  • .setClipboard(value, [type]) ⇒ this
  • .clearClipboard() ⇒ this
  • .menuTrayAdd([name], title, icon, menu) ⇒ this
  • .fullScreen(mode) ⇒ this

JsMB.menuAdd(name, title, onClick, [type], [fortype]) ⇒ this

Добавить пункт в контекстное меню

Kind: static method of $Interface

Param	Type	Description
name	string	ID название меню
title	string	Текст пункта меню
onClick	function	Функция выполнится при нажатии на пункт меню
[type]	string	Тип меню (subMenu, checkbox, separator)
[fortype]	string	Родительское меню для subMenu

JsMB.menuShow(name, x, y) ⇒ this

Отобразить контекстное меню

Kind: static method of $Interface

Param	Type	Description
name	string	ID название меню
x	number	XY координата
y	number	XY координата

JsMB.menuAddSeparator(name) ⇒ this

Добавляет разделитель в меню

Kind: static method of $Interface

Param	Type	Description
name	string	ID название меню

JsMB.menuBarAdd(name, title, subMenu) ⇒ this

Добавляет меню в меню-бар

Kind: static method of $Interface

Param	Type	Description
name	string	ID название меню-бара
title	string	Заголовок меню
subMenu	string	ID название меню

JsMB.menuBarShow(name) ⇒ this

Отобразить меню-бар на экране

Kind: static method of $Interface

Param	Type	Description
name	string	ID название меню-бара

JsMB.getClipboard([type]) ⇒ string

Получить данные из буфера обмена

Kind: static method of $Interface

Param	Type	Default	Description
[type]	string	"'text'"	Тип получаемых данных

JsMB.setClipboard(value, [type]) ⇒ this

Поместить данные в буфер обмена

Kind: static method of $Interface

Param	Type	Default	Description
value	string		Данные для помещения
[type]	string	"'text'"	Тип данных

JsMB.clearClipboard() ⇒ this

Очищает буфер обмена

Kind: static method of $Interface

JsMB.menuTrayAdd([name], title, icon, menu) ⇒ this

Добавить пункт в трэй

Kind: static method of $Interface

Param	Type	Description
[name]	string	ID название трэя
title	string	Текст при удерживании мыши
icon	string	Иконка
menu	string	ID название открывающегося меню

JsMB.fullScreen(mode) ⇒ this

Переключить полноэкранный режим

Kind: static method of $Interface

Param	Type	Description
mode	bool	true - включить, false - отключить