使用ToolsAPI

时间:2016-12-08 04:07:16

标签: delphi toolsapi

我希望找到我需要使用哪些服务/接口将项目添加到Delphi IDE中源文件的右键菜单中。

例如,如果我右键单击某个单元的选项卡,它会有“关闭页面”,“关闭所有其他页面”,“属性”等项目。我想在可能的情况下向该菜单添加自定义项目

我查看了ToolsAPI单元,但我不知道从哪里开始。我假设有一个界面,我可以用来枚举项目和添加项目,但我不知道从哪里开始寻找。

如果那是不可能的,我会选择代码编辑器的上下文菜单。

也许这里有一些在线样本,但我仍然没有找到它。

任何帮助表示感谢。

1 个答案:

答案 0 :(得分:4)

雷米·莱博(Remy Lebeau)指出了你正确的方向与他的联系 GExperts指南。

如果你以前没有做过这种事情,它仍然可以 开始编写自己的IDE加载项是一种性能,所以 我在下面列出了如何将项添加到代码编辑器的最小示例 弹出菜单。

显然,你要做的是创建一个新包,在下面添加单元, 然后在IDE中安装该程序包。在单元中调用Register 在编辑器弹出菜单中安装新项目是必要的。

确保在安装软件包时代码编辑器已打开。该 原因是,正如您将看到的,代码会检查是否存在活动编辑器 当时。我已经离开了如何确保弹出项目即使在那里也被添加 当时没有活动的代码编辑器。提示:如果您查看ToolsAPI.Pas单元中的哪一个 你正在使用的Delphi版本,你会发现它包括各种通知器, 并且您可以使用其中至少一个的通知来推迟检查是否存在 是一个活跃的编辑,直到有人可能。

顺便说一句,代码将菜单项添加到上下文菜单中,该菜单项弹出编辑器窗口本身而不是活动选项卡。 IDE加载项的部分乐趣是尝试查看是否可以获得您想要的内容的乐趣。我自己没有尝试过,但我怀疑将菜单项添加到其中一个编辑器选项卡的上下文菜单中会很困难 - 因为Delphi IDE是一个Delphi应用程序,正如您可以从下面的代码中看到的那样,你可以使用FindComponent(或只是遍历一个Components集合)来找到你想要的东西。但是,如果可以的话,最好通过ToolsAPI接口定位。请参阅下面的更新

interface

uses
  Classes, Windows, Menus, Dialogs, ToolsAPI;

type

   TIDEMenuItem = class(TNotifierObject, IOTAWizard, IOTAMenuWizard)
     function GetName: string;
     function GetIDString: string;
     function GetMenuText: string;
     function GetState: TWizardState;
     procedure Execute;
   end;

   TIDEMenuHandler = class(TObject)
     procedure HandleClick(Sender: TObject);
   end;

procedure Register;

implementation

var
  MenuItem: TMenuItem;
  IDEMenuHandler: TIDEMenuHandler;
  EditorPopUpMenu : TPopUpMenu;

procedure TIDEMenuItem.Execute;
begin
  ShowMessage('Execute');
end;

function TIDEMenuItem.GetIDString: string;
begin
  Result := 'IDEMenuItemID';
end;

function TIDEMenuItem.GetMenuText: string;
begin
  Result := 'IDEMenuItemText';
end;

function TIDEMenuItem.GetName: string;
begin
  Result := 'IDEMenuItemName';
end;

function TIDEMenuItem.GetState: TWizardState;
begin
  Result := [wsEnabled];
end;

procedure TIDEMenuHandler.HandleClick(Sender: TObject);
begin
  ShowMessage(TIDEMenuItem(Sender).GetName + ' Clicked');
end;

procedure AddIDEMenu;
var
  NTAServices: INTAServices40;
  EditorServices: IOTAEditorServices;
  EditView: IOTAEditView;
begin
  NTAServices := BorlandIDEServices as INTAServices40;

  EditorServices := BorlandIDEServices as IOTAEditorServices;
  EditView := EditorServices.TopView;

  if Assigned(EditView) then begin
    EditorPopUpMenu := TPopUpMenu(EditView.GetEditWindow.Form.FindComponent('EditorLocalMenu'));
    Assert(EditorPopUpMenu <>Nil);

    IDEMenuHandler := TIDEMenuHandler.Create;
    MenuItem := TMenuItem.Create(Nil);
    MenuItem.Caption := 'Added IDE editor menu item';
    MenuItem.OnClick := IDEMenuHandler.HandleClick;
    EditorPopUpMenu.Items.Add(MenuItem)
  end
  else
    ShowMessage('Code editor not active');
end;

procedure RemoveIDEMenu;
begin
  if MenuItem <> Nil then begin
    EditorPopUpMenu.Items.Remove(MenuItem);
    FreeAndNil(MenuItem);
    IDEMenuHandler.Free;
  end;
end;

procedure Register;
begin
  RegisterPackageWizard(TIDEMenuItem.Create);
  AddIDEMenu;
end;

initialization

finalization
  RemoveIDEMenu;
end.

更新:以下代码查找编辑器窗口的TabControl,并将菜单项添加到其上下文菜单中。但是,请注意,它不会考虑打开第二个编辑器窗口。

procedure AddIDEMenu;
var
  NTAServices: INTAServices40;
  EditorServices: IOTAEditorServices;
  EditView: IOTAEditView;
  TabControl : TTabControl;

  function FindTabControl(AComponent : TComponent) : TTabControl;
  var
    i : Integer;
  begin
    Result := Nil;
    if CompareText(AComponent.ClassName, 'TXTabControl') = 0 then begin
      Result := TTabControl(AComponent);
      exit;
    end
    else begin
      for i := 0 to AComponent.ComponentCount - 1 do begin
        if CompareText(AComponent.Components[i].ClassName, 'TXTabControl') = 0 then begin
          Result := TTabControl(AComponent.Components[i]);
          exit;
        end
        else begin
          Result := FindTabControl(AComponent.Components[i]);
          if Result <> Nil then
            exit;
        end;              
      end;
    end;
  end;

begin
  NTAServices := BorlandIDEServices as INTAServices40;

  EditorServices := BorlandIDEServices as IOTAEditorServices;
  EditView := EditorServices.TopView;

  if Assigned(EditView) then begin
    TabControl := FindTabControl(EditView.GetEditWindow.Form);
    Assert(TabControl <> Nil, 'TabControl not found');
    EditorPopUpMenu := TabControl.PopupMenu;
    Assert(EditorPopUpMenu <> Nil, 'PopUP menu not found');
    //EditorPopUpMenu := TPopUpMenu(EditView.GetEditWindow.Form.FindComponent('EditorLocalMenu'));
    Assert(EditorPopUpMenu <>Nil);

    IDEMenuHandler := TIDEMenuHandler.Create;
    MenuItem := TMenuItem.Create(Nil);
    MenuItem.Caption := 'Added IDE editor menu item';
    MenuItem.OnClick := IDEMenuHandler.HandleClick;
    EditorPopUpMenu.Items.Add(MenuItem)
  end
  else
    ShowMessage('No editor active');
end;