codeeditor — u_pbt_codeeditor #

← Riferimento dei componenti · Sommario della guida

Editor di codice con evidenziazione della sintassi: dieci linguaggi, numeri di riga, compressione delle regioni, ricerca e sostituzione, indicatori di diagnosi nel margine e rilascio di file.

▶ Vederlo dal vivo — Applicazione dimostrativa, riquadro Code editor: l'anteprima, il codice che lo produce e questa pagina, affiancati.

In breve #

Avvio rapido #

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

// Local variables
string ls_sql

// Rileggere cio che l'utente ha realmente digitato
ls_sql = uo_editor.of_get_text()

is_text restituisce la stessa cosa: la digitazione dell'utente vi arriva non appena l'immissione si posa (event ue_changed).

Linguaggi riconosciuti #

is_syntax accetta una di queste costanti, oppure SYNTAX_NONE (stringa vuota) per testo semplice senza evidenziazione.

I linguaggi di una stessa famiglia condividono l'evidenziazione (SYNTAX_JAVA colora come SYNTAX_C, SYNTAX_XML come SYNTAX_HTML): la costante scelta documenta la Sua intenzione, il risultato sullo schermo è lo stesso. Il valore non distingue tra maiuscole e minuscole e un nome sconosciuto ricade sul testo semplice, senza errore.

Proprietà #

Contenuto e linguaggio #

Visualizzazione #

Navigazione e interazioni #

Metodi #

Event #

Tastiera #

La colonna riportata da ue_caret_changed e il_caret_column è la posizione del carattere nella sua riga: una tabulazione conta per uno, qualunque sia la sua larghezza sullo schermo.

Esempi #

Un editor di query SQL #

// Sospendere il disegno durante l'impostazione
uo_query.of_set_redraw(/*on*/ false)

// Colorazione SQL, poi la query da mostrare
uo_query.is_syntax = uo_query.SYNTAX_SQL
uo_query.is_text   = "-- Migliori clienti per fatturato incassato~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"

// Un solo ridisegno, tutto in una volta
uo_query.of_set_redraw(/*on*/ true)

// event clicked di cb_execute
string ls_sql

// Eseguire la query cosi come digitata
ls_sql = uo_query.of_get_text()     // la digitazione reale dell'utente
of_execute(ls_sql)

Un visualizzatore in sola lettura #

Ideale per presentare codice generato, un registro o un estratto che l'utente deve leggere senza modificarlo.

// Colorazione PowerScript
uo_preview.is_syntax = uo_preview.SYNTAX_POWERSCRIPT

// Un visualizzatore in sola lettura: niente cursore, niente margine, niente evidenziazione
uo_preview.ib_readonly     = true      // sola consultazione, nessun cursore di immissione
uo_preview.ib_line_numbers = false     // nasconde il margine dei numeri
uo_preview.ib_current_line = false     // nessuna evidenziazione della riga corrente
uo_preview.ib_wrap         = true      // manda a capo invece di scorrere
uo_preview.ii_tab_size     = 2         // tabulazioni visualizzate su 2 colonne

// Il codice da mostrare
uo_preview.is_text = of_generate_code()

Seguire la posizione del cursore in una barra di stato #

// Segnalare ogni spostamento del cursore (ue_caret_changed)
uo_editor.ib_track_caret = true       // adesione esplicita : altrimenti nessun evento

// event ue_caret_changed di uo_editor : (long al_line, long al_col)
uo_status.of_panel(/*key*/ "pos").is_text = "Riga " + String(al_line) + ", col. " + String(al_col)

Senza ib_track_caret, il cursore non riporta nulla: questo trigger ha una frequenza elevata e rimane disattivato finché non lo richiede.

Cercare e andare a una riga #

// Apre la barra di ricerca ed evidenzia tutte le occorrenze
uo_editor.of_find(/*text*/ "ll_total")

// event ue_find_result di uo_editor : (long al_count, long al_index)
if al_count = 0 then
    uo_status.of_panel(/*key*/ "main").is_text = "Nessuna occorrenza"
else
    uo_status.of_panel(/*key*/ "main").is_text = String(al_index) + " / " + String(al_count)
end if

// Andare alla riga segnalata da un compilatore e segnarla nel margine
uo_editor.of_add_marker(/*line*/ ll_error_line, /*kind*/ uo_editor.MARKER_ERROR, /*tooltip*/ ls_error_text)
uo_editor.il_caret_line = ll_error_line     // il cursore ci va, la riga arriva sullo schermo
uo_editor.of_focus_webview()                // l'utente corregge subito

Aprire un file rilasciato da Esplora file #

// Accept files dropped from the Explorer
uo_editor.ib_allow_drop = true

// event ue_drop_files di uo_editor : (string as_files[])
string ls_content
integer li_file

// as_files[1] porta il percorso COMPLETO del primo file rilasciato
li_file = FileOpen(as_files[1], StreamMode!, Read!)
if li_file > 0 then
    FileReadEx(li_file, ls_content)
    FileClose(li_file)

    // Colorare secondo l'estensione del file, poi mostrarne il contenuto
    uo_editor.is_syntax = of_syntax_for_extension(as_files[1])
    uo_editor.is_text   = ls_content
end if

Reagire alle modifiche #

// event ue_changed di uo_editor : ( )
cb_save.enabled = uo_editor.ib_modified     // annullare fino al testo salvato lo riporta a false

// event clicked di cb_save
if of_save_script(uo_editor.is_text) = 1 then
    uo_editor.ib_modified = false     // il testo salvato diventa il riferimento
    cb_save.enabled = false
end if

L'event viene attivato solo una volta stabilizzata la digitazione: un'immissione continua non genera un event per ogni tasto.

Rinominare una variabile in tutto lo script #

// Local variables
long ll_count

// Solo parole intere: ll_total2 e un'altra variabile
uo_editor.ib_find_whole_word = true
ll_count = uo_editor.of_replace_all(/*find*/ "ll_total", /*replace*/ "ldc_amount")   // un solo Ctrl+Z annulla tutto

Buone pratiche #

• Imposti sempre is_syntax prima di is_text: il codice è colorato fin dalla prima visualizzazione, senza ricolorazione visibile.
• Per una visualizzazione in sola consultazione, la combinazione ib_readonly + ib_line_numbers = false + ib_wrap offre un visualizzatore sobrio che non sembra più un editor.
• Per recuperare un'immissione, legga is_text (oppure of_get_text()) una volta posata la digitazione — cioè dentro il suo ue_changed, che le dice quando.
• ib_folding ha senso solo su file lunghi e strutturati; lo lasci disattivato per brevi estratti. Lo spenga prima di permettere le modifiche: uno schema ripiegato si legge, non si modifica, e of_get_text() rende sempre il sorgente intero, regioni chiuse comprese.
• Racchiuda il caricamento di un file di grandi dimensioni tra of_set_redraw(false) e of_set_redraw(true).
• Chiami of_reset() prima di caricare un documento di natura diversa: senza di esso, il linguaggio, la dimensione di tabulazione o la modalità di sola lettura precedenti restano attivi.
• Dopo un salvataggio, rimetta ib_modified a false: torna true alla prima digitazione, e false se l'utente annulla fino al testo salvato.
• Per mostrare gli errori di una compilazione, of_clear_markers() poi un of_add_marker per diagnosi, e il_caret_line sulla prima.

Ereditato dalla base comune #

Questi membri esistono su tutti i componenti visivi — non sono propri di questo. Sono descritti una sola volta, nei capitoli trasversali; questa tabella dice solo dove leggerli.

Due aiuti non sono ereditati: of_icon e of_escape_markup vivono su n_pbt_utils. Ne dichiari uno — n_pbt_utils lnv_utils, niente da creare — e li chiami su di esso.

← Riferimento dei componenti · Sommario della guida