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

Строка 17: Строка 17:
 
== Прототип ==
 
== Прототип ==
 
<pre class="gscode" style="background-color:#fafafa;border: 1px dashed #a6a6a6;padding:5px;font-family:monospace;">
 
<pre class="gscode" style="background-color:#fafafa;border: 1px dashed #a6a6a6;padding:5px;font-family:monospace;">
class LSF_LocoBrowserItemInfo isclass LSF_ILocoBrowserItem
+
class LSF_ILocoBrowserItem
 
{
 
{
  

Версия 14:38, 6 марта 2018

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

LSF_ILocoBrowserItem - класс-интерфейс для элемента универсального браузера LSF_LocoBrowser. Входит в состав Locomotive Script Framework

Класс имеет только прототипы функций. Реализация отсутствует. Необходим для создания собственных типов элементов браузера

Прототип

class LSF_ILocoBrowserItem
{

  public string getName(void);

  public string getValue(void);

  public string getColour(void);

  public bool getVisibleState();

};

Интерфейс

getName

Возвращает строку с именем свойства

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

getValue

Возвращает строку со значением свойства

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

getColour

Возвращает цвет значения свойства в html формате RRGGBB

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

getVisibleState

Возвращает указатель, что свойство должно отображаться в браузере

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