LSF LocoBrowserAction — различия между версиями

(Новая страница: «{| class="wikitable" style="float:right; margin-left: 10px;" |- | Библиотека || Locomotive Script Framework |- | Имя класса || LSF_LocoBrow…»)
 
 
Строка 14: Строка 14:
  
 
Класс не предусматривает создание потомков.   
 
Класс не предусматривает создание потомков.   
 +
 +
== Прототип ==
 +
<pre class="gscode" style="background-color:#fafafa;border: 1px dashed #a6a6a6;padding:5px;font-family:monospace;">
 +
final class LSF_LocoBrowserAction
 +
{
 +
 
 +
  public final string getName(void);
 +
 +
  public final string getCommand(void);
 +
 +
  public final string getTooltip(void);
 +
 +
  public final string getColour(void);
 +
 
 +
  public final bool getEnabledState(void);
 +
 +
  public final bool getVisibleState(void);
 +
 +
  public final bool isInitialized(void);
 +
 +
  public final void setEnabledState(bool enabled);
 +
 +
  public final void setVisibleState(bool visible);
 +
 +
  public final void setColour(string colour);
 +
 +
  public final LSF_LocoBrowserAction Init(string name, string command, string tooltip, string colour, bool enabled, bool visible);
 +
 +
  public final LSF_LocoBrowserAction Init(string name, string command, string tooltip, string colour, bool enabled);
 +
 
 +
  public final LSF_LocoBrowserAction Init(string name, string command, string tooltip, string colour);
 +
 +
  public final LSF_LocoBrowserAction Init(string name, string command, string tooltip);
 +
 +
  public final LSF_LocoBrowserAction Init(string name, string command, string tooltip, bool enabled, bool visible);
 +
 +
  public final LSF_LocoBrowserAction Init(string name, string command, string tooltip, bool enabled);
 +
 +
};
 +
</pre>
  
 
== Интерфейс ==
 
== Интерфейс ==

Текущая версия на 14:47, 6 марта 2018

Библиотека Locomotive Script Framework
Имя класса LSF_LocoBrowserAction
Файл скрипта lsf_locobrowserinterface.gs
Тип Класс-описание
Базовые классы -- --

LSF_LocoBrowserAction - Класс описывающий интерактивное действие для универсального браузера. Входит в состав Locomotive Script Framework.

Класс не предусматривает создание потомков.

Прототип

final class LSF_LocoBrowserAction
{
  
  public final string getName(void);

  public final string getCommand(void);

  public final string getTooltip(void);

  public final string getColour(void);
  
  public final bool getEnabledState(void);

  public final bool getVisibleState(void);

  public final bool isInitialized(void);

  public final void setEnabledState(bool enabled);

  public final void setVisibleState(bool visible);

  public final void setColour(string colour);

  public final LSF_LocoBrowserAction Init(string name, string command, string tooltip, string colour, bool enabled, bool visible);

  public final LSF_LocoBrowserAction Init(string name, string command, string tooltip, string colour, bool enabled);
  
  public final LSF_LocoBrowserAction Init(string name, string command, string tooltip, string colour);

  public final LSF_LocoBrowserAction Init(string name, string command, string tooltip);

  public final LSF_LocoBrowserAction Init(string name, string command, string tooltip, bool enabled, bool visible);

  public final LSF_LocoBrowserAction Init(string name, string command, string tooltip, bool enabled);

};

Интерфейс

getName

Извлечение имени действия

public final string getName(void)
Возвращает: Строку, которая является именем действия.
Примечание: Выводиться в браузере

getCommand

Извлечение наименования команды

public final string getCommand(void)
Возвращает: Строку, представляющая собой команду
Примечание: Передаётся в сообщении браузера при активации команды

getTooltip

Извлечение подсказки

public final string getTooltip(void)
Возвращает: Строку, которая выводиться в качестве подсказки при наведении мыши на действие в браузере

getColour

Извлечение цвета отображения действия

public final string getColour(void)
Возвращает: Строку в формате html (RRGGBB) которая описывает цвет действия в браузере
Примечание: Только для активного действия.

getEnabledState

Указатель, что действие активно

public final bool getEnabledState(void)
Возвращает: true - действие активно и с ним можно взаимодействовать; false - действие не активно

getVisibleState

Указатель, что действие отображается в браузере

public final bool getVisibleState(void)
Возвращает: true - действие отображается в браузере; false - действие скрыто

isInitialized

Указатель, что действие инициализировано

public final bool isInitialized(void)
Возвращает: true - действие инициализировано; false - действие не инициализированно
Примечание: Для инициализации должна быть вызвана одна из функций Init()

setEnabledState

Устанавливает состояние активности действия

public final void setEnabledState(bool enable)
Аргументы:
  • enable - true - действие активно; false - действие неактивно

setVisibleState

Устанавливает состояние видимости действия

public final void setVisibleState(bool visible)
Аргументы:
  • visible - true - действие отображается; false - действие скрыто

setColour

Устанавливает состояние видимости действия

public final void setColour(string colour)
Аргументы:
  • colour - строка в формате html (RRGGBB) описывающая цвет отображения активного действия в браузере.
Примечание: Для цвета по умолчанию нужно передать пустую строку

Init

Выполняет инициализацию класса описания действия

public final LSF_LocoBrowserAction Init(string name, string command, string tooltip, string colour, bool enable, bool visible)
Аргументы:
  • name - Наименование действия отображаемое в браузере
  • command - Уникальная строка для комманды. Будет передана в сообщении браузера при активации пользователем
  • tooltip - Строка подсказка отображаемая при наведении мыши на действие
  • colour - Цвет в формате html (RRGGBB) которым будет отображаться активное действие в браузере
  • enable - Указатель, что действие активно: true - активно; false - не активно
  • visible - Указатель, что действие отображается: true - отображается; false - скрыто
Примечание: Эта функция обязательно должна быть вызвана 1 раз перед использованием экземпляра класса

Init

Выполняет инициализацию класса описания действия

public final LSF_LocoBrowserAction Init(string name, string command, string tooltip, string colour, bool enable)
Аргументы:
  • name - Наименование действия отображаемое в браузере
  • command - Уникальная строка для комманды. Будет передана в сообщении браузера при активации пользователем
  • tooltip - Строка подсказка отображаемая при наведении мыши на действие
  • colour - Цвет в формате html (RRGGBB) которым будет отображаться активное действие в браузере
  • enable - Указатель, что действие активно: true - активно; false - не активно
Примечание: Эта функция обязательно должна быть вызвана 1 раз перед использованием экземпляра класса

Init

Выполняет инициализацию класса описания действия

public final LSF_LocoBrowserAction Init(string name, string command, string tooltip, string colour)
Аргументы:
  • name - Наименование действия отображаемое в браузере
  • command - Уникальная строка для комманды. Будет передана в сообщении браузера при активации пользователем
  • tooltip - Строка подсказка отображаемая при наведении мыши на действие
  • colour - Цвет в формате html (RRGGBB) которым будет отображаться активное действие в браузере
Примечание: Эта функция обязательно должна быть вызвана 1 раз перед использованием экземпляра класса

Init

Выполняет инициализацию класса описания действия

public final LSF_LocoBrowserAction Init(string name, string command, string tooltip)
Аргументы:
  • name - Наименование действия отображаемое в браузере
  • command - Уникальная строка для комманды. Будет передана в сообщении браузера при активации пользователем
  • tooltip - Строка подсказка отображаемая при наведении мыши на действие
Примечание: Эта функция обязательно должна быть вызвана 1 раз перед использованием экземпляра класса

Init

Выполняет инициализацию класса описания действия

public final LSF_LocoBrowserAction Init(string name, string command, string tooltip, bool enable, bool visible)
Аргументы:
  • name - Наименование действия отображаемое в браузере
  • command - Уникальная строка для комманды. Будет передана в сообщении браузера при активации пользователем
  • tooltip - Строка подсказка отображаемая при наведении мыши на действие
  • enable - Указатель, что действие активно: true - активно; false - не активно
  • visible - Указатель, что действие отображается: true - отображается; false - скрыто
Примечание: Эта функция обязательно должна быть вызвана 1 раз перед использованием экземпляра класса

Init

Выполняет инициализацию класса описания действия

public final LSF_LocoBrowserAction Init(string name, string command, string tooltip, bool enable)
Аргументы:
  • name - Наименование действия отображаемое в браузере
  • command - Уникальная строка для комманды. Будет передана в сообщении браузера при активации пользователем
  • tooltip - Строка подсказка отображаемая при наведении мыши на действие
  • enable - Указатель, что действие активно: true - активно; false - не активно
Примечание: Эта функция обязательно должна быть вызвана 1 раз перед использованием экземпляра класса