codeeditor — u_pbt_codeeditor #

← Referência dos componentes · Índice do guia

Editor de código com realce de sintaxe: dez linguagens, números de linha, dobragem de regiões, pesquisa integrada e largada de ficheiros.

▶ Ver ao vivo — Aplicação de demonstração, mosaico Code editor: a pré-visualização, o código que o produz e esta página, lado a lado.

Em resumo #

Início rápido #

// event open da window
uo_editeur.is_syntax = uo_editeur.SYNTAX_SQL
uo_editeur.is_text   = "SELECT c.name, SUM(o.amount) AS total~r~n" &
                       + "FROM customer c~r~n" &
                       + "WHERE o.status = 'paid'"

// Reler o que o utilizador introduziu realmente
string ls_sql

ls_sql = uo_editeur.of_get_text()

is_text devolve o mesmo: aquilo que o utilizador escreve chega lá assim que a escrita assenta (event ue_changed).

Linguagens reconhecidas #

is_syntax aceita uma destas constantes, ou SYNTAX_NONE (cadeia vazia) para texto simples sem realce.

As linguagens de uma mesma família partilham o realce (SYNTAX_JAVA colore como SYNTAX_C, SYNTAX_XML como SYNTAX_HTML): a constante escolhida documenta a intenção do programador, mas o resultado no ecrã é o mesmo. O valor não distingue maiúsculas de minúsculas e um nome desconhecido recai no texto simples, sem erro.

Propriedades #

Conteúdo e linguagem #

Apresentação #

Navegação e interações #

Métodos #

Eventos #

Exemplos #

Um editor de consultas SQL #

uo_requete.of_set_redraw(false)

uo_requete.is_syntax = uo_requete.SYNTAX_SQL
uo_requete.is_text   = "-- Melhores clientes por volume de negocios recebido~r~n" &
                       + "SELECT c.name, SUM(o.amount) AS total~r~n" &
                       + "FROM customer c~r~n" &
                       + "  INNER JOIN orders o ON o.cust_id = c.id~r~n" &
                       + "WHERE o.status = 'paid'~r~n" &
                       + "GROUP BY c.name~r~n" &
                       + "ORDER BY total DESC"

uo_requete.of_set_redraw(true)

// event clicked de cb_executer
string ls_sql

ls_sql = uo_requete.of_get_text()     // o que o utilizador introduziu realmente
of_executer(ls_sql)

Um visualizador só de leitura #

Ideal para apresentar código gerado, um registo ou um excerto que o utilizador deve ler sem o modificar.

uo_apercu.is_syntax = uo_apercu.SYNTAX_POWERSCRIPT

uo_apercu.ib_readonly     = true      // apenas consulta, sem cursor de escrita
uo_apercu.ib_line_numbers = false     // oculta a calha de numeros
uo_apercu.ib_current_line = false     // sem realce da linha atual
uo_apercu.ib_wrap         = true      // muda de linha em vez de deslocar
uo_apercu.ii_tab_size     = 2         // tabulacoes apresentadas em 2 colunas

uo_apercu.is_text = of_generer_code()

Acompanhar a posição do cursor numa barra de estado #

uo_editeur.ib_track_caret = true       // subscricao explicita: caso contrario nenhum evento

// event ue_caret_changed de uo_editeur : (long al_line, long al_col)
uo_statut.of_item("pos").is_text = "Linha " + String(al_line) + ", col. " + String(al_col)

Sem ib_track_caret, o cursor não comunica nada: este acionador é de frequência elevada e permanece desligado enquanto não for pedido.

Pesquisar e ir para uma linha #

// Abre a barra de pesquisa e realca todas as ocorrencias
uo_editeur.of_find(/*texto*/ "ll_total")

// event ue_find_result de uo_editeur : (long al_count, long al_index)
if al_count = 0 then
    uo_statut.of_item("main").is_text = "Nenhuma ocorrência"
else
    uo_statut.of_item("main").is_text = String(al_index) + " / " + String(al_count)
end if

// Ir diretamente para a linha assinalada por um compilador
uo_editeur.ii_doc_line = ll_ligne_erreur     // desloca e seleciona a linha

Abrir um ficheiro largado a partir do Explorador #

uo_editeur.ib_allow_drop = true

// event ue_drop_files de uo_editeur : (string as_files[])
string ls_contenu, ls_ligne
integer li_fichier

// as_files[1] transporta o caminho COMPLETO do primeiro ficheiro largado
li_fichier = FileOpen(as_files[1], StreamMode!, Read!)
if li_fichier > 0 then
    FileReadEx(li_fichier, ls_contenu)
    FileClose(li_fichier)

    uo_editeur.is_syntax = of_langage_selon_extension(as_files[1])
    uo_editeur.is_text   = ls_contenu
end if

Reagir às modificações #

// event ue_changed de uo_editeur : (string as_text)
ib_modifie = true
uo_statut.of_item("main").is_text = String(Len(as_text)) + " caracteres"

O evento só é despoletado depois de a escrita estabilizar: uma introdução contínua não gera um evento por cada tecla.

Boas práticas #

• Definir sempre is_syntax antes de is_text: o código é realçado logo na primeira apresentação, sem que se veja um novo realce.
• Para uma apresentação em modo de consulta, a combinação ib_readonly + ib_line_numbers = false + ib_wrap produz um visualizador sóbrio, que deixa de parecer um editor.
• Para recuperar o que foi introduzido, ler is_text (ou of_get_text()) assim que a escrita assentar, ou usar o parâmetro as_text de ue_changed.
• ib_folding só tem interesse em ficheiros longos e estruturados; deve manter-se desligado para excertos curtos.
• O carregamento de um ficheiro grande deve ser enquadrado por of_set_redraw(false) / of_set_redraw(true).
• Chamar of_reset() antes de carregar um documento de outra natureza: caso contrário, a linguagem, o tamanho de tabulação ou o modo só de leitura anteriores mantêm-se em vigor.

← Referência dos componentes · Índice do guia