Разработка слушателя событий LibreOffice для Lazarus

Delphi , Технологии , OLE Automation MSOffice

В этой статье мы рассмотрим, как создать слушателя событий для LibreOffice в Lazarus, используя язык программирования Object Pascal. Мы обсудим основные проблемы, с которыми сталкиваются разработчики при попытке портировать Delphi-приложения, которые автоматизируют LibreOffice и слушают события, такие как сохранение и закрытие документов. Мы также предоставим решение и альтернативные подходы для решения этой проблемы.

Введение

LibreOffice предоставляет API для автоматизации и взаимодействия с документами. В Delphi это можно сделать с помощью COM-объектов и слушателей событий. Однако, когда мы пытаемся портировать это приложение в Lazarus, мы сталкиваемся с рядом проблем, связанных с отсутствием некоторых интерфейсов и классов, таких как IConnectionPointContainer и TConnectionPoints.

Проблема

В Delphi для создания слушателя событий LibreOffice используется класс TAutoObject, который реализует интерфейс IConnectionPointContainer. В Lazarus, однако, таких реализаций нет, и это приводит к тому, что слушатель событий не работает должным образом. Даже если приложение компилируется без ошибок, события не срабатывают.

Решение

Для решения этой проблемы можно использовать следующие шаги:

1. Использование XDocumentEventListener
   Вместо устаревшего интерфейса XEventListener, который был использован в старых версиях Delphi, следует использовать новый интерфейс XDocumentEventListener. Этот интерфейс позволяет получать уведомления о событиях, связанных с документами, такими как изменения, закрытие и сохранение.

2. Использование XDocumentEventBroadcaster
   Интерфейс XDocumentEventBroadcaster позволяет добавлять и удалять слушателей событий для документов. Он также позволяет уведомлять слушателей о событиях, происходящих с документом.

3. Использование TAutoObject с исправлением
   В Lazarus можно создать собственный класс TAutoObjectBugFixed, который возвращает правильный тип информации (DispTypeInfo) в методе GetTypeInfo. Это исправление позволяет правильно зарегистрировать слушателя событий и устраняет проблему, связанную с отсутствием реализации IConnectionPointContainer.

Пример кода

Вот пример кода на Object Pascal, который демонстрирует, как создать слушателя событий для LibreOffice в Lazarus:

unit LibreOfficeEventListener;

{$mode objfpc}{$H+}

interface

uses
  Classes, SysUtils, Variants, ComObj, Dialogs, Windows, ActiveX, ComServ, ComServNoRegisterLaz, LibreOfficeEventListener_TLB;

type
  TLibreOfficeEvents = class(TAutoObjectBugFixed, ILibreOfficeEvents)
  private
    FOnPrepareUnload: TNotifyEvent;
  public
    procedure _Set_OnPrepareUnload(const Value: TNotifyEvent); safecall;
    procedure _Invoke(const DispID: TDispID; const wFlags: Word; const vargs: OleVariant; out result: OleVariant); safecall;
    procedure OnPrepareUnload(Sender: TObject); safecall;
  end;

implementation

procedure TLibreOfficeEvents._Set_OnPrepareUnload(const Value: TNotifyEvent);
begin
  FOnPrepareUnload := Value;
end;

procedure TLibreOfficeEvents._Invoke(const DispID: TDispID; const wFlags: Word; const vargs: OleVariant; out result: OleVariant);
begin
  if DispID = DISPID_XEVENTLISTENER_ADDEVENTLISTENER then
    OnPrepareUnload(nil);
end;

procedure TLibreOfficeEvents.OnPrepareUnload(Sender: TObject);
begin
  if Assigned(FOnPrepareUnload) then
    FOnPrepareUnload(Sender);
end;

function TAutoObjectBugFixed.GetTypeInfo(Index, LocaleID: longint; out TypeInfo): HResult; stdcall;
begin
  if Index <> 0 then
    Result := DISP_E_BADINDEX
  else
  begin
    ITypeInfo(TypeInfo) := TAutoObjectFactory(Factory).DispTypeInfo; // bug fix for FPC 3.2.2, was returning ClassInfo
    Result := S_OK;
  end;
end;

end.

Пример использования

Вот пример использования слушателя событий в главном модуле приложения:

uses
  Forms, Dialogs, ComObj, Variants, LibreOfficeEventListener;

var
  libreMgr, libreDsk, libreDoc: OleVariant;
  libreEvents: ILibreOfficeEvents;

begin
  try
    libreMgr := CreateOleObject('com.sun.star.ServiceManager');
    libreDsk := libreMgr.createInstance('com.sun.star.frame.Desktop');
    libreDoc := libreDsk.loadComponentFromFile('path_to_your_file.csv');
    libreEvents := TLibreOfficeEvents.Create;
    libreEvents.OnPrepareUnload := OnDocumentUnload;
    libreDoc.addEventListener(libreEvents);
  except
    on E: Exception do
      ShowMessage('Error: ' + E.Message);
  end;
end;

procedure TForm1.OnDocumentUnload(Sender: TObject);
begin
  ShowMessage('Document has been unloaded');
end;

Альтернативное решение

Если вы столкнулись с проблемами, связанными с использованием TAutoObjectBugFixed, можно рассмотреть альтернативный подход, использующий нативные функции LibreOffice API. Вместо использования COM-объектов, можно использовать нативные функции LibreOffice, которые позволяют взаимодействовать с документами напрямую. Это может быть полезно, если вы хотите избежать проблем, связанных с отсутствием реализации некоторых интерфейсов в Lazarus.

Заключение

Создание слушателя событий для LibreOffice в Lazarus может быть сложной задачей, но с использованием правильных интерфейсов и классов, таких как XDocumentEventListener и XDocumentEventBroadcaster, можно успешно решить эту проблему. Мы также рассмотрели альтернативный подход, использующий нативные функции LibreOffice API, который может быть полезен в некоторых случаях.

Надеюсь, эта статья поможет вам успешно портировать ваше Delphi-приложение в Lazarus и автоматизировать LibreOffice с помощью слушателя событий.

Создано по материалам из источника по ссылке.

Контекст статьи — описание способов создания слушателя событий для LibreOffice в Lazarus с использованием Object Pascal, решение проблем с отсутствием необходимых интерфейсов и предложение альтернативных подходов для взаимодействия с LibreOffice.

Комментарии и вопросы

Получайте свежие новости и обновления по Object Pascal, Delphi и Lazarus прямо в свой смартфон. Подпишитесь на наш Telegram-канал delphi_kansoftware и будьте в курсе последних тенденций в разработке под Linux, Windows, Android и iOS

:: Главная :: OLE Automation MSOffice ::