Erweitern der IDE mit der Tools-API

Aus RAD Studio
Wechseln zu: Navigation, Suche

Nach oben zu Komponentenentwicklung - Index


Sie können die RAD Studio-IDE mit der Tools-API um eigene Menübefehle, Schaltflächen in der Symbolleiste, dynamische Experten zur Formularerstellung usw. erweitern.

Die Tools-API umfasst mehr als 100 Interfaces (abstrakte Klassen) zur Steuerung der IDE. Sie erhalten damit u. a. Zugriff auf folgende Elemente der IDE: Hauptmenü, Symbolleisten, zentrale Aktions- und Bilderliste, interne Puffer des Quelltext-Editors, Tastaturmakros und -bindungen, Formulare und deren Komponenten im Formular-Editor, Debugger und den darin aktiven Prozess, Programmierhilfe, Meldungsansicht, To-Do-Liste.

So erweitern Sie mit der Tools-API die IDE um neue Funktionen:

  1. Erstellen Sie ein Package, und konfigurieren Sie es zur Erweiterung der IDE. Sie können auch ein vorhandenes Package verwenden.
  2. Implementieren Sie die Logik Ihrer IDE-Erweiterung.
  3. Installieren Sie Ihre Erweiterung in der IDE.

Erstellen oder Erweitern eines Package zum Erweitern der IDE

Um die IDE mit der Tools-API zu erweitern, müssen Sie zuerst ein Package so erstellen oder erweitern, dass es die Tools-API verwenden kann.

Wenn Ihr Package fertig ist, können Sie Ihren Code mit einem Datenmodul implementieren. Fügen Sie Ihrem Package ein Datenmodul hinzu, ändern Sie dessen Framework-Verbindung in VCL, und definieren Sie anhand der Ereignisse OnCreate und OnDestroy den Code zum Erstellen Ihrer IDE-Erweiterung.

Alternativ können Sie Ihre Erweiterung auch in einer Unit Ihres Package oder in der Hauptquellcodedatei Ihres Package definieren.

Implementieren der Logik Ihrer IDE-Erweiterung

Der Code in Ihrem Package kann Dienste aus der Tools-API verwenden. Bei jedem Dienst handelt es sich um ein Interface, das eine Anzahl verwandter Funktionen umfasst. Die verschiedenen Dienste stellen den Zugriff auf den Quelltext-Editor, den Formular-Designer, den Debugger usw. bereit.

Außerdem können Sie mit speziellen Interfaces bestimmte Funktionen, wie Experten, Notifier, Creators, Module, Editoren und mehr, implementieren.

Alle Interfaces der Tools-API sind in den Units deklariert, die sich im Verzeichnis C:\Program Files (x86)\Embarcadero\Studio\21.0\source\ToolsAPI befinden. Sie können den Inhalt dieser Units durchsehen, um neue Möglichkeiten zum Erweitern der IDE zu erkunden. Die Dokumentation der Befehlsreferenz enthält im Allgemeinen keine Referenzdokumentation der Tools-API. Es gibt aber eine Referenzdokumentation für die Unit PlatformAPI der Tools-API.

Unterschiede zwischen nativen und Interfaces der Open Tools API

Interfaces können in zwei grundlegende Kategorien unterteilt werden. Diese unterscheiden sich durch das Präfix des Typnamens:

  • Die NTA (Native Tools API) erlaubt den direkten Zugriff auf eigentliche IDE-Objekte, wie z. B. dem Objekt TMainMenu der IDE. Zur Benutzung dieser Interfaces muss der Experte RAD Studio-Packages verwenden. Er ist somit an eine bestimmte IDE-Version gebunden. Sie erstellen den Experten entweder als Entwurfszeit-Package oder als DLL, die Laufzeit-Packages verwendet.
  • Die OTA (Open Tools API) benötigt keine Packages; der Zugriff auf die IDE erfolgt ausschließlich über Interfaces. Theoretisch können Sie einen Experten in jeder Sprache erstellen, die COM-Interfaces unterstützt, solange Sie auch mit den Aufrufkonventionen von Delphi sowie den Delphi-Typen, wie AnsiString, arbeiten können. OTA-Interfaces können nicht auf sämtliche IDE-Funktionen zugreifen; die gesamte Funktionalität der Tools-API wird jedoch abgedeckt. Verwendet Ihr Experte ausschließlich OTA-Interfaces, können Sie eine DLL schreiben, die von der IDE-Version unabhängig ist.

Einzuhaltende Konventionen beim Erweitern der IDE

Die Tools-API bietet Ihnen die Flexibilität, die IDE auf verschiedene Arten zu erweitern. Stellen Sie beim Erweitern der IDE sicher, dass sich Ihre Erweiterungen reibungslos in die IDE integrieren lassen und dass sie nicht mit den Kernfunktionen der IDE in Konflikt stehen.

Hier sind einige Konventionen, die Sie beim Erweitern der IDE beachten sollten:

  • Wenn Sie Menüeinträge bereitstellen, die externe Tools öffnen, fügen Sie diese in das Menü Tools ein.
  • Wenn Sie Menüeinträge bereitstellen, die Hilferessourcen öffnen:
    • Wenn Sie einen einzelnen Menüeintrag bereitstellen, fügen Sie einen Menüeintrag mit dem Namen Ihres Produkts in Hilfe > Hilfe von Drittherstellern ein.
    • Wenn Sie mehrere Hilfe-Menüeinträge bereitstellen (z. B. einen Eintrag für Offline-Hilfe und einen Eintrag für Online-Hilfe), fügen Sie einen Menüeintrag mit dem Namen Ihres Produkt in Hilfe > Hilfe von Drittherstellern ein, und fügen Sie dann Ihre Hilfe-Menüeinträge als diesem Menüeintrag untergeordnete Elemente hinzu.
Siehe:

IDE-Erweiterungen müssen große Speicheradressen unterstützen

Die IDE kann umfangreiche Adressen verarbeiten (EN). Dies ermöglicht der IDE, bis zu 4 GiB Arbeitsspeicher zu verwenden. Aus diesem Grund müssen IDE-Erweiterungen auch große Speicheradressen behandeln können.

Die meisten IDE-Erweiterungen sollten große Speicheradressen unterstützen. Die folgende Liste enthält einige Tipps zum Erkennen von Problemen in Ihren IDE-Erweiterungen:

Installieren Ihres Erweiterungs-Package in der IDE

Wenn Ihr Package fertig ist, müssen Sie es compilieren und in die IDE laden.

Themen

Siehe auch

Abgerufen von „http://docwiki.embarcadero.com/RADStudio/Sydney/d/index.php?title=Erweitern_der_IDE_mit_der_Tools-API&oldid=187105“