Pular para conteúdo

Biblioteca GUI

Biblioteca GUI

A biblioteca gui provê funções relacionadas às interfaces Lua Form.

Todas as funções estão contidas na table/variável "GUI" da unidade "gui.lua".

 

Exemplo de uso:

-- Primeiro, é necessário usar a unidade "gui.lua" require("gui.lua");    -- Agora é possível acessar as funções da biblioteca GUI.FUNCAO_DA_BIBLIOTECA(Parametro1, Parametro2, ...);

 

 

Funções da biblioteca gui

 

function GUI.findControlByName(controlName, referenceControl)

 

Procura outro controle através do nome passado pelo parâmetro “controlName” em toda a hierarquia de controles onde "referenceControl" está.

 

Parâmetros:

  •  
  • controlName - uma cadeia de caracteres contendo o nome do controle que deseja procurar.
  • referenceControl - um controle para servir de referência durante a busca. O controle será procurado em toda a hierarquia de controles de "referenceControl", isto é, primeiro nos controles que estão dentro dele e depois nos controles pais de "referenceControl".

    

Retorno: 

  •  
  • o controle, se encontrado
  • nil caso não encontre.

 

 

function GUI.newActivityIndicator()

 

Cria e retorna um novo objeto activityIndicator

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto activityIndicator

 

function GUI.newButton()

 

Cria e retorna um novo objeto button.

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto button.

 

 

 

function GUI.newCheckBox()

 

Cria e retorna um novo objeto checkbox.

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto checkbox.

 

 

function GUI.newComboBox()

 

Cria e retorna um novo objeto comboBox

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto comboBox

 

function GUI.newColorComboBox()

 

Cria e retorna um novo objeto colorComboBox

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto colorComboBox

 

 

function GUI.newDataLink()

 

Cria e retorna um novo objeto dataLink

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto dataLink

 

 

function GUI.newDataScopeBox()

 

Cria e retorna um novo objeto dataScopeBox

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto dataScopeBox

 

 

function GUI.newEdit()

 

Cria e retorna um novo objeto edit

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto edit

 

 

function GUI.newFlowLayout()

 

Cria e retorna um novo objeto flowLayout.

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto flowLayout.

 

 

function GUI.newFlowLineBreak()

 

Cria e retorna um novo objeto flowLineBreak.

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto flowLineBreak.

 

 

function GUI.newFlowPart()

 

Cria e retorna um novo objeto flowPart.

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto flowPart.

 

 

function GUI.newForm([formName])

 

Cria e retorna um novo objeto form.

 

Parâmetros:

  •  
  • (OPCIONAL) formName - Se informado, contém uma cadeia de caracteres identificando o "name" de um dos Lua Forms do plug-in, fazendo com que a função busque em todos os arquivos ".lfm" a tag form ou tag popupForm que possuir o atributo name igual a este valor.

    

Retorno: 

  •  
  • Se "formName" não for informado: Retorna um novo objeto form que não possui nenhum outro componente/tag dentro dele.
  • Se "formName" for informado:
    • Se a busca encontrar o LuaForm, retorna um objeto form representando a nova instância do Lua Form.
    • Se a busca não encontrar o LuaForm, retorna nil.

 

 

 

function GUI.newHorzLine()

 

Cria e retorna um novo objeto horzLine

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto horzLine

 

 

 

function GUI.newImage()

 

Cria e retorna um novo objeto image

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto image.

 

 

function GUI.newImageCheckBox()

 

Cria e retorna um novo objeto imageCheckbox.

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto imageCheckbox.

 

 

function GUI.newLabel()

 

Cria e retorna um novo objeto label.

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto label.

 

 

function GUI.newLayout()

 

Cria e retorna um novo objeto layout.

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto layout.

 

 

function GUI.newPath()

 

Cria e retorna um novo objeto path

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto path

 

 

function GUI.newPopup()

 

Cria e retorna um novo objeto popup

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto popup

 

 

 

function GUI.newPopupForm([popupFormName])

 

Cria e retorna um novo objeto popupForm.

 

Parâmetros:

  •  
  • (OPCIONAL) popupFormName - Se informado, contém uma cadeia de caracteres identificando o "name" de um dos Lua Forms do plug-in, fazendo com que a função busque em todos os arquivos ".lfm" a tag popupForm que possuir o atributo name igual a este valor.

    

Retorno: 

  •  
  • Se "popupFormName" não for informado: Retorna um novo objeto popupForm que não possui nenhum outro componente/tag dentro dele.
  • Se "popupFormName" for informado:
    • Se a busca encontrar o LuaForm e se for do tipo popupForm, retorna um objeto popupForm representando a nova instância do Lua Form.
    • Se a busca não encontrar o LuaForm ou se encontrar mas tipo diferente de popupForm, retorna nil.

 

 

function GUI.newRadioButton()

 

Cria e retorna um novo objeto radioButton

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto radioButton

 

 

function GUI.newRecordList()

 

Cria e retorna um novo objeto recordList

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto recordList

 

 

function GUI.newRectangle()

 

Cria e retorna um novo objeto rectangle

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto rectangle

 

 

 

function GUI.newScrollBox()

 

Cria e retorna um novo objeto scrollBox

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto scrollBox

 

function GUI.newTab()

 

Cria e retorna um novo objeto tab

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto tab

 

 

function GUI.newTabControl()

 

Cria e retorna um novo objeto tabControl

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto tabControl

 

 

function GUI.newTextEditor()

 

Cria e retorna um novo objeto textEditor

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto textEditor

 

 

function GUI.newTimer()

 

Cria e retorna um novo objeto timer

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto timer

 

 

 

function GUI.newProgressBar()

 

Cria e retorna um novo objeto progressBar

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto progressBar

 

 

function GUI.newInertialMovement()

 

Cria e retorna um novo objeto InertialMovement

 

Parâmetros:

    Não há parâmetros

    

Retorno: \     Retorna um objeto InertialMovement

 

 

function GUI.showPopup(form [, options])

 

Exibe uma janela na interface do usuário na forma de um Popup

 

Parâmetros:

  •  
  • form - O formulário a ser exibido na interface. Pode ser um objeto Lua Form já instanciado ou um string contendo o nome do form a ser exibido.
    • Caso seja passado o nome do formulário em uma cadeia de caracteres, a função percorre todos os "lfm" do plug-in à procura da tag form que possuir name igual ao informado. Se encontrado, uma nova instância é criada para a exibição.
  • (OPCIONAL) options - Uma tabela/objeto LUA contendo as opções da exibição do popup. As opções são:
    • onClose - [function, padrão = nil] - Uma função lua que será invocada quando o popup for fechado.
    • placement - [string enumerado] - Onde o popup será exibido.. Os possíveis valores são:
  •  
  •  
    •  
    • "center" - no centro da tela
    • "bottom" - na parte de baixo da tela
    • "top" - na parte de cima da tela
    • "left" - à esquerda na tela
    • "right" - à direita na tela
    • "topLeft" -  no canto superior esquerdo da tela
    • "topRight - no canto superior direito da tela
    • "bottomLeft" - no canto inferior esquerdo da tela
    • "bottomRight" - no canto inferior direito da tela
    • "mouse" - onde o mouse está atualmente
    • "mouseCenter" - centralizado onde o mouse está atualmente.

    

Retorno: \     Se conseguir exibir o form como um popup na interface, retorna true; Senão retorna false.

 

Observações:

  •  
  • A função não espera o popup fechar para retornar. Após esta chamada, o código LUA continuará sua execução normal enquanto o form é mostrado.
  • Se o parâmetro form for uma tag popupForm, os seguintes parâmetros em options são ignorados (e são usados os atributos correspondentes da tag no lugar):
    • options.placement

 

 

function GUI.closePopup(form)

 

Fecha uma janela popup que foi previamente aberta pela da função gui.showPopup.

 

Parâmetros:

  •  
  • form - O formulário a ser fechado/tirado da interface. Pode ser um objeto Lua Form já instanciado ou um string contendo o nome do form que foi exibido.
    • Caso seja passado o nome do formulário em uma cadeia de caracteres, a função percorre todos os popups abertos e fecha àqueles que possuírem o nome informado.

    

Retorno: \     Se conseguir fechar o form, retorna true; Senão retorna false.

 

 

 

function GUI.openInBrowser(url)

 

Abre um determinado URL/página web no browser do usuário.

 

Parâmetros:

  •  
  • url - cadeia de caracteres contendo a URL/caminho da página web que deve ser aberta. Exemplo "http://www.rrpg.com.br".

 

Observações:

  •  
  • Se o parâmetro "url" não começar com "http://" e nem com "https://", automaticamente "http://" será adicionado no inicio da URL antes da abertura da página.

 

 

 

function GUI.toast(message)

 

Show a quick informative message to the user that does not require user interaction and hides automatically after a short time

 

Parameters

  •  
  • message - The message string to be shown

Created with the Personal Edition of HelpNDoc: Effortlessly Create Professional Documentation with HelpNDoc's Clean UI