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

 
Строка 26: Строка 26:
 
   public string getColour(void);
 
   public string getColour(void);
  
   public bool getVisibleState();
+
   public bool getVisibleState(void);
  
 
};
 
};
Строка 52: Строка 52:
 
:''Возвращает'': '''true''' - свойство отображается; '''false''' - свойство скрыто. По умолчанию: true
 
:''Возвращает'': '''true''' - свойство отображается; '''false''' - свойство скрыто. По умолчанию: true
 
:''Примечание'': Вызывается автоматически. Для реализации необходимо переопределить в производном классе
 
:''Примечание'': Вызывается автоматически. Для реализации необходимо переопределить в производном классе
 +
 +
== Пример ==
 +
<pre class="gscode" style="background-color:#fafafa;border: 1px dashed #a6a6a6;padding:5px;font-family:monospace;">
 +
class myitem isclass LSF_ILocoBrowserItem
 +
{
 +
 +
  public string getName(void){
 +
    return "Скорость:";
 +
  }
 +
 +
  public string getValue(void){
 +
    return "54 км/ч";
 +
  }
 +
 +
};
 +
</pre>

Текущая версия на 12:10, 7 марта 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(void);

};

Интерфейс

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
Примечание: Вызывается автоматически. Для реализации необходимо переопределить в производном классе

Пример

class myitem isclass LSF_ILocoBrowserItem
{

  public string getName(void){
    return "Скорость:";
  }

  public string getValue(void){
    return "54 км/ч";
  }

};