codeeditor — u_pbt_codeeditor #

← Référence des composants · Sommaire du guide

Éditeur de code à coloration syntaxique : dix langages, numéros de ligne, repli de régions, recherche intégrée et dépôt de fichiers.

▶ Le voir en vrai — Application de démonstration, tuile Code editor : l'aperçu, le code qui le produit et cette page, côte à côte.

En bref #

Démarrage rapide #

// event open de la fenetre
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'"

// Relire ce que l'utilisateur a reellement saisi
string ls_sql

ls_sql = uo_editeur.of_get_text()

is_text donne la même chose : la frappe de l'utilisateur y est reportée dès que la saisie se pose (event ue_changed).

Langages reconnus #

is_syntax accepte l'une de ces constantes, ou SYNTAX_NONE (chaîne vide) pour du texte brut sans coloration.

Les langages d'une même famille partagent la coloration (SYNTAX_JAVA colore comme SYNTAX_C, SYNTAX_XML comme SYNTAX_HTML) : la constante que vous choisissez documente votre intention, le résultat à l'écran est le même. La valeur est insensible à la casse et un nom inconnu revient au texte brut, sans erreur.

Propriétés #

Contenu et langage #

Affichage #

Navigation et interactions #

Méthodes #

Événements #

Exemples #

Un éditeur de requête SQL #

uo_requete.of_set_redraw(false)

uo_requete.is_syntax = uo_requete.SYNTAX_SQL
uo_requete.is_text   = "-- Meilleurs clients par chiffre d'affaires encaisse~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()     // la saisie reelle de l'utilisateur
of_executer(ls_sql)

Une visionneuse en lecture seule #

Idéale pour présenter du code généré, un journal ou un extrait que l'utilisateur doit lire sans le modifier.

uo_apercu.is_syntax = uo_apercu.SYNTAX_POWERSCRIPT

uo_apercu.ib_readonly     = true      // consultation seule, pas de curseur de saisie
uo_apercu.ib_line_numbers = false     // masque la gouttiere de numeros
uo_apercu.ib_current_line = false     // pas de surlignage de la ligne courante
uo_apercu.ib_wrap         = true      // renvoie a la ligne plutot que defiler
uo_apercu.ii_tab_size     = 2         // tabulations affichees sur 2 colonnes

uo_apercu.is_text = of_generer_code()

Suivre la position du curseur dans une barre d'état #

uo_editeur.ib_track_caret = true       // abonnement explicite : sinon aucun evenement

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

Sans ib_track_caret, le curseur ne remonte rien : ce déclencheur est de fréquence élevée et reste coupé tant que vous ne le demandez pas.

Rechercher et aller à une ligne #

// Ouvre la barre de recherche et met en evidence toutes les occurrences
uo_editeur.of_find(/*texte*/ "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 = "Aucune occurrence"
else
    uo_statut.of_item("main").is_text = String(al_index) + " / " + String(al_count)
end if

// Aller directement a la ligne fautive d'un compilateur
uo_editeur.ii_doc_line = ll_ligne_erreur     // defile et selectionne la ligne

Ouvrir un fichier déposé depuis l'Explorateur #

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] porte le chemin COMPLET du premier fichier depose
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

Réagir aux modifications #

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

L'événement n'est levé qu'une fois la frappe stabilisée : une saisie continue ne génère pas un événement par touche.

Bonnes pratiques #

• Posez toujours is_syntax avant is_text : le code est coloré dès le premier affichage, sans recoloration visible.
• Pour un affichage en consultation, la combinaison ib_readonly + ib_line_numbers = false + ib_wrap donne une visionneuse sobre qui ne ressemble plus à un éditeur.
• Pour récupérer une saisie, lisez is_text (ou of_get_text()) une fois la frappe posée, ou prenez le paramètre as_text de ue_changed.
• ib_folding n'a d'intérêt que sur des fichiers longs et structurés ; laissez-le coupé pour de courts extraits.
• Encadrez le chargement d'un gros fichier par of_set_redraw(false) / of_set_redraw(true).
• Appelez of_reset() avant de charger un document d'une autre nature : sans cela, le langage, la taille de tabulation ou le mode lecture seule précédents restent en place.

← Référence des composants · Sommaire du guide