codeeditor — u_pbt_codeeditor #

← Komponentenreferenz · Inhalt des Handbuchs

Code-Editor mit Syntaxhervorhebung: zehn Sprachen, Zeilennummern, Falten von Regionen, integrierte Suche und Ablegen von Dateien.

▶ Live ansehen — Demoanwendung, Kachel Code editor: die Vorschau, der zugehörige Code und diese Seite, nebeneinander.

Auf einen Blick #

Schnellstart #

// open-Event des Fensters
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'"

// Zuruecklesen, was der Benutzer tatsaechlich eingegeben hat
string ls_sql

ls_sql = uo_editeur.of_get_text()

is_text liefert dasselbe: Die Eingabe des Benutzers landet dort, sobald sie sich gesetzt hat (Event ue_changed).

Unterstützte Sprachen #

is_syntax akzeptiert eine dieser Konstanten oder SYNTAX_NONE (leere Zeichenkette) für reinen Text ohne Hervorhebung.

Sprachen derselben Familie teilen sich die Hervorhebung (SYNTAX_JAVA färbt wie SYNTAX_C, SYNTAX_XML wie SYNTAX_HTML): Die Konstante, die Sie wählen, dokumentiert Ihre Absicht, das Ergebnis auf dem Bildschirm ist dasselbe. Der Wert unterscheidet nicht zwischen Groß- und Kleinschreibung, und ein unbekannter Name fällt ohne Fehler auf reinen Text zurück.

Eigenschaften #

Inhalt und Sprache #

Anzeige #

Navigation und Interaktionen #

Methoden #

Events #

Beispiele #

Ein Editor für SQL-Abfragen #

uo_requete.of_set_redraw(false)

uo_requete.is_syntax = uo_requete.SYNTAX_SQL
uo_requete.is_text   = "-- Beste Kunden nach vereinnahmtem Umsatz~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)

// clicked-Event von cb_executer
string ls_sql

ls_sql = uo_requete.of_get_text()     // die tatsaechliche Eingabe des Benutzers
of_executer(ls_sql)

Ein schreibgeschützter Betrachter #

Ideal, um generierten Code, ein Protokoll oder einen Auszug zu zeigen, den der Benutzer lesen, aber nicht ändern soll.

uo_apercu.is_syntax = uo_apercu.SYNTAX_POWERSCRIPT

uo_apercu.ib_readonly     = true      // nur lesen, keine Einfuegemarke
uo_apercu.ib_line_numbers = false     // blendet die Nummernleiste aus
uo_apercu.ib_current_line = false     // keine Hervorhebung der aktuellen Zeile
uo_apercu.ib_wrap         = true      // bricht um, statt zu scrollen
uo_apercu.ii_tab_size     = 2         // Tabulatoren ueber 2 Spalten dargestellt

uo_apercu.is_text = of_generer_code()

Die Position der Einfügemarke in einer Statusleiste verfolgen #

uo_editeur.ib_track_caret = true       // ausdrueckliches Opt-in : sonst gar kein Event

// ue_caret_changed-Event von uo_editeur : (long al_line, long al_col)
uo_statut.of_item("pos").is_text = "Zeile " + String(al_line) + ", Sp. " + String(al_col)

Ohne ib_track_caret meldet die Einfügemarke nichts: Dieser Auslöser feuert sehr häufig und bleibt abgeschaltet, solange Sie ihn nicht anfordern.

Suchen und zu einer Zeile springen #

// Oeffnet die Suchleiste und hebt alle Vorkommen hervor
uo_editeur.of_find(/*text*/ "ll_total")

// ue_find_result-Event von uo_editeur : (long al_count, long al_index)
if al_count = 0 then
    uo_statut.of_item("main").is_text = "Kein Treffer"
else
    uo_statut.of_item("main").is_text = String(al_index) + " / " + String(al_count)
end if

// Direkt zu der Zeile springen, die ein Compiler bemaengelt hat
uo_editeur.ii_doc_line = ll_ligne_erreur     // scrollt zur Zeile und waehlt sie aus

Eine aus dem Explorer abgelegte Datei öffnen #

uo_editeur.ib_allow_drop = true

// ue_drop_files-Event von uo_editeur : (string as_files[])
string ls_contenu, ls_ligne
integer li_fichier

// as_files[1] traegt den VOLLSTAENDIGEN Pfad der ersten abgelegten Datei
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

Auf Änderungen reagieren #

// ue_changed-Event von uo_editeur : (string as_text)
ib_modifie = true
uo_statut.of_item("main").is_text = String(Len(as_text)) + " Zeichen"

Das Event wird erst ausgelöst, wenn die Eingabe zur Ruhe gekommen ist: Fortlaufendes Tippen erzeugt nicht ein Event pro Tastendruck.

Best Practices #

• Setzen Sie is_syntax immer vor is_text: Der Code ist schon beim ersten Zeichnen eingefärbt, ohne sichtbares Nachfärben.
• Für eine reine Anzeige ergibt die Kombination ib_readonly + ib_line_numbers = false + ib_wrap einen schlichten Betrachter, der nicht mehr wie ein Editor aussieht.
• Um eine Eingabe abzuholen, lesen Sie is_text (oder of_get_text()), sobald die Eingabe sich gesetzt hat, oder nehmen Sie den Parameter as_text von ue_changed.
• ib_folding lohnt sich nur bei langen, strukturierten Dateien; lassen Sie es bei kurzen Auszügen ausgeschaltet.
• Klammern Sie das Laden einer großen Datei mit of_set_redraw(false) / of_set_redraw(true) ein.
• Rufen Sie of_reset() auf, bevor Sie ein Dokument anderer Art laden: Sonst bleiben die vorherige Sprache, die Tabulatorbreite oder der Schreibschutzmodus bestehen.

← Komponentenreferenz · Inhalt des Handbuchs