Extension de l'EDI par l'utilisation de l'API Tools

De RAD Studio
Aller à : navigation, rechercher

Remonter à Guide du concepteur de composants - Index


Vous pouvez étendre et personnaliser l'EDI de RAD Studio avec vos propres éléments de menu, boutons de barres d'outils, experts de création de fiches dynamiques, et de nombreux autres éléments en utilisant l'API Tools.

L'API Tools est un ensemble d'une centaine d'interfaces qui interagissent et contrôlent l'EDI, y compris le menu principal, les barres d'outils, les listes principales d'actions et d'images, les tampons internes de l'éditeur de code source, les liaisons et les macros clavier, les fiches et leurs composants dans le Concepteur de fiches, le débogueur et le processus en cours de débogage, l'achèvement de code, la vue des messages et la liste de tâches.

Pour étendre l'EDI avec de nouvelles fonctionnalités à l'aide de l'API Tools :

  1. Créez un package et configurez-le pour étendre l'EDI. Vous pouvez également utiliser un package existant.
  2. Implémentez la logique de votre extension d'EDI.
  3. Installez votre extension sur l'EDI.

Création ou extension d'un package en vue d'étendre l'EDI

Pour étendre l'EDI à l'aide de l'API Tools, vous devez d'abord créer ou étendre un package pour qu'il puisse utiliser l'API Tools.

Lorsque vous disposez d'un package, vous pouvez implémenter votre code en utilisant un module de données. Ajoutez un module de données à votre package, modifiez son affinité de framework pour la VCL, puis utilisez ses événements OnCreate et OnDestroy pour définir le code qui crée et détruit votre extension de l'EDI.

Vous pouvez également définir votre extension dans une unité de votre package ou dans le fichier de code source principal de votre package.

Implémentation de la logique de votre extension de l'EDI

Le code de votre package peut utiliser les services fournis par l'API Tools. Chaque service est une interface qui présente un ensemble de fonctions associées. Les divers services donnent accès à l'éditeur de code, au Concepteur de fiches, au débogueur, etc.

En outre, vous pouvez utiliser des interfaces spéciales pour implémenter certaines fonctionnalités, telles que les experts, notificateurs, créateurs, modules, éditeurs et autres.

Toutes les interfaces de l'API Tools sont déclarées dans les unités qui sont disponibles dans C:\Program Files (x86)\Embarcadero\Studio\18.0\source\ToolsAPI. Vous pouvez contrôler le contenu de ces unités pour découvrir de nouvelles façons d'étendre l'EDI. La documentation de référence de la bibliothèque ne fournit généralement pas de documentation de référence de l'API Tools. Cependant, il existe une documentation de référence pour l'unité PlatformAPI de l'API Tools.

Différences entre les interfaces native et ouverte de l'API Tools

Les interfaces appartiennent à deux catégories de base : Vous pouvez les distinguer par le préfixe utilisé dans le nom de type :

  • L'architecture NTA (Native Tools API, API outils natifs) procure un accès direct à des objets réels de l'EDI, par exemple l'objet TMainMenu de l'EDI. Lorsqu'il a recours à ces interfaces, l'expert doit utiliser les packages de RAD Studio, cela signifie également que l'expert est lié à une version spécifique de l'EDI. L'expert peut se trouver dans un package de conception ou dans une DLL utilisant des packages d'exécution.
  • L'architecture OTA (Open Tools API) ne nécessite pas de packages et accède à l'EDI uniquement via des interfaces. En théorie, vous pouvez concevoir un expert dans tout langage prenant en charge les interfaces de style COM, dans la mesure où vous pouvez aussi utiliser les conventions d'appel de Delphi et les types Delphi comme AnsiString. Les interfaces OTA ne procurent pas un accès complet à l'EDI, mais presque toutes les fonctionnalités de l'API Tools sont accessibles via des interfaces OTA. Si un expert n'utilise que des interfaces OTA, il est possible d'écrire une DLL qui ne dépend pas d'une version spécifique de l'EDI.

Conventions à suivre lors de l'extension de l'EDI

L'API Tools vous permet d'étendre l'EDI de nombreuses façons. Lorsque vous étendez l'EDI, assurez-vous que vos extensions s'intègrent parfaitement dans l'EDI et n'empiètent pas sur ses fonctionnalités principales.

Voici quelques conventions que vous devez suivre lorsque vous étendez l'EDI :

  • Si vous fournissez des éléments de menu pour ouvrir des outils externes, ajoutez-les au menu Outils.
  • Si vous fournissez des éléments de menu pour ouvrir des ressources d'aide :
    • Si vous fournissez une seule entrée de menu Aide, placez-la dans Help > Third-Party Help qui affiche le nom de votre produit.
    • Si vous fournissez plusieurs éléments du menu Aide (par exemple, une entrée pour l'aide hors ligne et une entrée pour l'aide en ligne), placez une entrée de menu dans Help > Third-Party Help qui affiche le nom de votre produit, puis incluez vos éléments de menu Aide en tant qu'éléments enfant de menu de cette entrée de menu Aide.
Voir :

Les extensions de l'EDI doivent prendre en charge les grandes adresses mémoire

L'EDI est orienté grandes adresses (EN), ce qui lui permet d'utiliser jusqu'à 4 Go de mémoire. Pour cette raison, les extensions de l'EDI doivent également être en mesure de gérer les grandes adresses mémoire.

La plupart des extensions de l'EDI doivent prendre en charge les grandes adresses mémoire. La liste suivante contient des conseils de détection de problèmes dans votre extension d'EDI :

Installation de votre package d'extension dans l'EDI

Pour utiliser votre package une fois qu'il est prêt, vous devez le compiler et le charger dans l'EDI.

Rubriques

Voir aussi