Создание надстроек для офисного пакета «МойОфис». Часть 3. Автозаполнение для API и знакомимся с контролами

ZeroBrane Studio, а следовательно и LuaRT, предлагает много  интересных «фишек» для программирования. Часть из них есть и «из коробки», а часть можно догрузить из набора дополнений к самой программы ZeroBrane Studio (они опять же, почти все без проблем становятся и в LuaRT). В частности, поддерживает довольно обширный набор различных фреймворков, в которых активно используется или которые сами построены на Lua (LÖVE, Corona, Moai, Gideros, Marmalade Quick, Cocos2d-x,  и ряд других). В основном это касается отладки и такой интересной возможности, как «интерпретация на лету», но так же можно добавить и функционал по автодополнению кода при его написании, в соответствии с используемым фреймворком.  Включается такого рода либо загрузкой уже готового бесплатного расширения, либо самостоятельно - путём создания собственного файла описания требуемого API. Итак, приступим!

на самом деле можно внести ещё много дополнительных пунктов в настройки (расписанных в документации), чтобы конфигурация IDE была более адекватной для работы с API «под себя», но это сильно отклонит от текущих задачи, поэтому как-нибудь в другой раз. Хотя эта тема и весьма интересная.

Forms = {
    type = "class",
    description = "Класс описания параметров пользовательского интерфейса из 'Мой офис'",
    childs = {
      Size = { 
        type = "value",
        description = "Используется для указания величин ширины и высоты виджета.",
        childs={
            width={
              type = "value",
              description = "Ширина виджета",
            },
            height={
              type = "value",
              description = "Высота виджета",
              },
          },
      },
      ItemID = { 
        type = "value" ,
        description = "Идентификатор элемента виджета.",
      },
      ListItem = { 
        type = "value",
        description = "Элемент списка виджетов.",
        childs={            
            text={
              type = "value",
              valuetype = "string",
              description = "Наименование элемента.",
            },
            id={
              type = "value",
              description = "Идентификатор элемента.",
            },
            checkState={
              type = "value",
              description = "Содержит состояние флажка элемента виджета.",                    
            },
        },        
      },
      Color = { 
        type = "value",
        description = "Предназначена для настройки цвета отображения элементов виджетов.",
        childs={            
            red={
              type = "value",
              valuetype = "string",
              description = "Значение для установки интенсивности красного цвета.",
            },
            green={
              type = "value",
              description = "Значение для установки интенсивности зеленого цвета.",
            },
            blue={
              type = "value",
              description = "Значение для установки интенсивности синего цвета.",                    
            },
        },        
      },
      DialogButton = { 
        type = "value",
        description = "Константы диалоговых кнопок виджетов.",
        childs={            
            DialogButton_OK={
              type = "value",
              valuetype = "string",
              description = "Имя диалоговой кнопки, используемых при подтверждении.",
            },
            DialogButton_Done={
              type = "value",
              valuetype = "string",
              description = "Имя диалоговой кнопки, используемых при подтверждении.",
            },
            DialogButton_Yes={
              type = "value",
              valuetype = "string",
              description = "Имя диалоговой кнопки, используемых при подтверждении.",
            },
            DialogButton_Retry={
              type = "value",
              valuetype = "string",
              description = "Имя диалоговой кнопки, используемых при подтверждении.",
            },
            DialogButton_Ignore={
              type = "value",
              description = "Имя диалоговой кнопки, используемых при отмене.",
            },
            DialogButton_Cancel={
              type = "value",
              description = "Имя диалоговой кнопки, используемых при отмене.",
            },
            DialogButton_No={
              type = "value",
              description = "Имя диалоговой кнопки, используемых при отмене.",
            },
            DialogButton_Close={
              type = "value",
              description = "Имя диалоговой кнопки, используемых при отмене.",
            },
        },        
      },
      DialogButtonRole = { 
        type = "value",
        description = "Содержит константы ролей диалоговых кнопок виджетов.",
        childs={            
            DialogButtonRole_Accept={
              type = "value",
              valuetype = "string",
              description = "Подтверждение при нажатии на кнопку в диалоговом окне, например, кнопка OK."
            },
            DialogButtonRole_Reject={
              type = "value",
              description = "Отмена при нажатии на кнопку в диалоговом окне, например, кнопка Cancel.",
            },            
        },        
      },
      CheckState_Checked={
        type = "value",
        description = "Флажок элемента установлен.",              
      },
      CheckState_Unchecked={
        type = "value",
        description = "Флажок элемента установлен.",              
      },              
      DialogCode_Accepted={
        type = "value",
        description = "Пользователь нажал кнопку 'ОК'",              
      },
      DialogCode_Rejected={
        type = "value",
        description = "Пользователь нажал кнопку 'Отмена'",              
      },      
      Alignment_TopLeft={
        type = "value",
        description = "Выравнивание по верхнему левому углу",              
      },
      Alignment_TopCenter={
        type = "value",
        description = "ВВыравнивание сверху по центру",              
      },
      Alignment_TopRight={
        type = "value",
        description = "Выравнивание по верхнему правому углу",              
      },
      Alignment_MiddleLeft={
        type = "value",
        description = "Выравнивание по левой средней части",              
      },
      Alignment_MiddleCenter={
        type = "value",
        description = "Выравнивание по центру средней части",              
      },
      Alignment_MiddleRight={
        type = "value",
        description = "Выравнивание по правой средней части",              
      },
      Alignment_BottomLeft={
        type = "value",
        description = "Выравнивание по нижнему левому углу",              
      },
      Alignment_BottomCenter={
        type = "value",
        description = "Выравнивание снизу по центру",              
      },
      Alignment_BottomRight={
        type = "value",
        description = "Выравнивание по нижнему правому углу",              
      },        
      ConstListItems = { 
        type = "value",
        description = "Используется для доступа в режиме только для чтения к элементам виджетов",
      },      
      addItem = {
        type = "function",
        description = [[Добавляет элемент списка с заданным названием, идентификатором и состоянием в
конец списка.]],
        args = "(text : string[, id : Forms.ItemID, checkState : Forms.Check_State])",   
        returns = "()", 
      },
      getCount = {
        type = "function",
        args = "()",
        description = "Возвращает количество элементов таблицы.",
        valuetype = "integer",                
      },
      getItem = {
        type = "function",
        description = "Возвращает элемент списка по индексу.",
        args = "(index: integer)",
        valuetype = "Forms.ListIem",                
      },
    },
  }

Frm={}

--Контрол надписи

Frm.labelCntl=ui:Label{
  Text="Label",
  Color=Forms.Color(255,0,0), --установить красный цвет
  Size=Forms.Size(200,30), -- установить размер (для позиционирования на форме)
  Alignment=Forms.Alignment_MiddleCenter, --настройка положения надписи по отношению к границам контрола
}

--Контрол ввоода текста
Frm.textBoxCntrl = ui:TextBox{
  Text="TextBox",
  Size=Forms.Size(200,30),  
}


Frm.btnCntrl = ui:Button{
  Title="Button", 
  Size=Forms.Size(100,20),
}

--Перечисления необходимое для заполнения обычного и выпадающего списка
Frm.itemsFruit = ui:ListItems {
{ text = "Арбуз",
	id = 0,
	checkState = Forms.CheckState_Unchecked
},
{ text = "Груша",
	id = 1,
	checkState = Forms.CheckState_Unchecked
},
{ text = "Слива",
	id = 2,
	checkState = Forms.CheckState_Unchecked
	}
}

--Контрол выпадающего списка
Frm.fruitsComboCntl = ui:ComboBox {
	Name = "ComboFruits",
	Items = Frm.itemsFruit, --используемое перечисление контролов
  Size=Forms.Size(200,50),
	OnCurrentItemChanged = function(id) -- обработка события выбора конкретной позиции
		msg = "Выбран элемент " .. id
		EditorAPI.messageBox(msg)
	end
}

--Контрол списка
Frm.fruitsListCntl=ui:ListBox{
  Name = "ListBox",
	Items = Frm.itemsFruit,
  Size=Forms.Size(200,100),
	OnCurrentItemChanged = function(id)
		msg = "Выбран элемент " .. id
		EditorAPI.messageBox(msg)
	end
}


--Контрол флажка
Frm.cbPrintBothSidesCntl = ui:CheckBox {  
  Title = "Печать на обеих сторонах листа"  
}

--Контрол радиокнопки 1
Frm.printFromPrintDialogRadioButton = ui:RadioButton {
  Title = "Использовать окно Печати" 
}

--Контрол радиокнопки 2
Frm.printFromPrintDocumentRadioButton = ui:RadioButton {
  Title = "Использовать окно Документа"  
}

--Контрол группировки радиокнопок 1 и 2 
Frm.groupBoxCntl= ui:GroupBox {
  ui:Column {
    Frm.printFromPrintDialogRadioButton,
    Frm.printFromPrintDocumentRadioButton
  }
}

--Специальный объект для кнопок внизу формы используемых обычно для принятия или отклонения результатов работы
Frm.dialogButtons = ui:DialogButtons{}
Frm.dialogButtons:addButton("OK", Forms.DialogButtonRole_Accept)
Frm.dialogButtons:addButton("Cancel", Forms.DialogButtonRole_Reject)

--Непосредственно сама форма
Frm.dlgBegin = ui:Dialog {
	Title = "Демонстрация контролов",
	Size = Forms.Size(600,300),
	Buttons = Frm.dialogButtons, --Кнопки Ок и Cancel внизу формы
	--описываем "геометрию" расположения контролов на форме "сверху-вниз" и "слева-направо"
  ui:Column {		--зададим всё в одну колонну 	
    ui:Row {  --первая"строка"    
      ui:Row {Frm.labelCntl},
      ui:Spacer{}, --разедлитель, чтобы контролы не "слипались краями"
      ui:Row {Frm.textBoxCntrl},
      ui:Spacer{},
    },    
    ui:Row {--вторая "строка"
      ui:Spacer{},
      ui:Column{Frm.fruitsComboCntl},      
      ui:Column{Frm.fruitsListCntl},
      ui:Spacer{},
    }, 
    --остальные контролы расположены по-строчно
    ui:Row {Frm.groupBoxCntl},
    ui:Row {Frm.cbPrintBothSidesCntl},
    ui:Row {Frm.btnCntrl},            
  },
}

--Обработчик нажатия на кнопки (добавленные как Frm.Buttons), обычно завершающие работу формы
Frm.dlgBegin:setOnDone(function(ret)
	if ret == 1  then		
		-- Ok pressed
	else
		-- Cancel pressed
	end
end
)

return Frm